{"items":[{"type":"link","label":"Weavr Webhook","link":"/products/webhooks/openapi","routeSlug":"/products/webhooks/openapi","content":{"contentType":"overview","meta":{"name":"Weavr Webhook"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/products/webhooks/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/products/webhooks/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://weavr.io","url":"https://weavr.io"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Weavr Webhook (v2)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"For Verification, create a base64 hash using HmacSHA256 using Published-Timestamp header as message and your API key as secret. The result should match the Signature header."}],"sectionId":"/products/webhooks/openapi"}],"sectionId":"/products/webhooks/openapi"}]}]}},{"type":"separator","label":"Webhooks","content":null},{"type":"group","label":"Corporates","link":"/products/webhooks/openapi/corporates","routeSlug":"/products/webhooks/openapi/corporates","items":[{"label":"Corporate KYB status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/corporates/corporates_kyb_watch","routeSlug":"/products/webhooks/openapi/corporates/corporates_kyb_watch","metadata":{"seo":{"title":"Corporate KYB status update","description":"Notification that the KYB status of a corporate identity has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporates_kyb_watch","name":"Corporate KYB status update","isWebhook":true,"pointer":"/paths/~1corporates~1kyb~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporate 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 corporate identity has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1corporates~1kyb~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KybEvent"}},"schemaId":"components/schemas/KybEvent","pointer":"/paths/~1corporates~1kyb~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/corporates/kyb/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/KybEvent"}},"responseCodes":["204"],"pointer":"/corporates/kyb/watch","href":"corporates/corporates_kyb_watch","openApiOperationId":"corporates_kyb_watch","summary":"Corporate KYB status update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/KybEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KybEvent"}},"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"}],"pointer":"/paths/~1corporates~1kyb~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporates_kyb_watch"}],"panels":[]}]},"httpPath":"/corporates/kyb/watch"},{"label":"Corporate beneficiary status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/corporates/corporates_kyb_beneficiaries_watch","routeSlug":"/products/webhooks/openapi/corporates/corporates_kyb_beneficiaries_watch","metadata":{"seo":{"title":"Corporate beneficiary status update","description":"Notification that the verification status of a corporate beneficiary has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporates_kyb_beneficiaries_watch","name":"Corporate beneficiary status update","isWebhook":true,"pointer":"/paths/~1corporates~1kyb~1beneficiaries~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporate 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 corporate beneficiary has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1corporates~1kyb~1beneficiaries~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficiaryVerifiedEvent"}},"schemaId":"components/schemas/BeneficiaryVerifiedEvent","pointer":"/paths/~1corporates~1kyb~1beneficiaries~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/corporates/kyb/beneficiaries/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BeneficiaryVerifiedEvent"}},"responseCodes":["204"],"pointer":"/corporates/kyb/beneficiaries/watch","href":"corporates/corporates_kyb_beneficiaries_watch","openApiOperationId":"corporates_kyb_beneficiaries_watch","summary":"Corporate beneficiary status update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BeneficiaryVerifiedEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficiaryVerifiedEvent"}},"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"}],"pointer":"/paths/~1corporates~1kyb~1beneficiaries~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporates_kyb_beneficiaries_watch"}],"panels":[]}]},"httpPath":"/corporates/kyb/beneficiaries/watch"},{"label":"Corporate activation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/corporates/corporates_corporate_activated_watch","routeSlug":"/products/webhooks/openapi/corporates/corporates_corporate_activated_watch","metadata":{"seo":{"title":"Corporate activation","description":"Notification that a corporate identity has been activated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporates_corporate_activated_watch","name":"Corporate activation","isWebhook":true,"pointer":"/paths/~1corporates~1corporate_activated~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporate activation","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a corporate identity has been activated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1corporates~1corporate_activated~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityActivatedEvent"}},"schemaId":"components/schemas/IdentityActivatedEvent","pointer":"/paths/~1corporates~1corporate_activated~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/corporates/corporate_activated/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityActivatedEvent"}},"responseCodes":["204"],"pointer":"/corporates/corporate_activated/watch","href":"corporates/corporates_corporate_activated_watch","openApiOperationId":"corporates_corporate_activated_watch","summary":"Corporate activation"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/IdentityActivatedEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityActivatedEvent"}},"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"}],"pointer":"/paths/~1corporates~1corporate_activated~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporates_corporate_activated_watch"}],"panels":[]}]},"httpPath":"/corporates/corporate_activated/watch"},{"label":"Corporate deactivation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/corporates/corporates_corporate_deactivated_watch","routeSlug":"/products/webhooks/openapi/corporates/corporates_corporate_deactivated_watch","metadata":{"seo":{"title":"Corporate deactivation","description":"Notification that a corporate identity has been deactivated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"corporates_corporate_deactivated_watch","name":"Corporate deactivation","isWebhook":true,"pointer":"/paths/~1corporates~1corporate_deactivated~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporate 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 corporate identity has been deactivated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1corporates~1corporate_deactivated~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"schemaId":"components/schemas/IdentityDeactivatedEvent","pointer":"/paths/~1corporates~1corporate_deactivated~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/corporates/corporate_deactivated/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"responseCodes":["204"],"pointer":"/corporates/corporate_deactivated/watch","href":"corporates/corporates_corporate_deactivated_watch","openApiOperationId":"corporates_corporate_deactivated_watch","summary":"Corporate deactivation"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/IdentityDeactivatedEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"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"}],"pointer":"/paths/~1corporates~1corporate_deactivated~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/corporates/corporates_corporate_deactivated_watch"}],"panels":[]}]},"httpPath":"/corporates/corporate_deactivated/watch"}],"content":{"contentType":"group","meta":{"name":"Corporates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Corporates","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/corporates/kyb/watch","summary":"Corporate KYB status update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporates_kyb_watch","deprecated":false},{"title":"/corporates/kyb/beneficiaries/watch","summary":"Corporate beneficiary status update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporates_kyb_beneficiaries_watch","deprecated":false},{"title":"/corporates/corporate_activated/watch","summary":"Corporate activation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporates_corporate_activated_watch","deprecated":false},{"title":"/corporates/corporate_deactivated/watch","summary":"Corporate deactivation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/corporates/corporates_corporate_deactivated_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Consumers","link":"/products/webhooks/openapi/consumers","routeSlug":"/products/webhooks/openapi/consumers","items":[{"label":"Consumer KYC status update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/consumers/consumers_kyc_watch","routeSlug":"/products/webhooks/openapi/consumers/consumers_kyc_watch","metadata":{"seo":{"title":"Consumer KYC status update","description":"Notification that the KYC status of a consumer identity has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumers_kyc_watch","name":"Consumer KYC status update","isWebhook":true,"pointer":"/paths/~1consumers~1kyc~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumer KYC 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 KYC status of a consumer identity has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1consumers~1kyc~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycEvent"}},"schemaId":"components/schemas/KycEvent","pointer":"/paths/~1consumers~1kyc~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/consumers/kyc/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/KycEvent"}},"responseCodes":["204"],"pointer":"/consumers/kyc/watch","href":"consumers/consumers_kyc_watch","openApiOperationId":"consumers_kyc_watch","summary":"Consumer KYC status update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/KycEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/KycEvent"}},"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"}],"pointer":"/paths/~1consumers~1kyc~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/consumers_kyc_watch"}],"panels":[]}]},"httpPath":"/consumers/kyc/watch"},{"label":"Consumer activation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/consumers/consumers_consumer_activated_watch","routeSlug":"/products/webhooks/openapi/consumers/consumers_consumer_activated_watch","metadata":{"seo":{"title":"Consumer activation","description":"Notification that a consumer identity has been activated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumers_consumer_activated_watch","name":"Consumer activation","isWebhook":true,"pointer":"/paths/~1consumers~1consumer_activated~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumer activation","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a consumer identity has been activated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1consumers~1consumer_activated~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityActivatedEvent"}},"schemaId":"components/schemas/IdentityActivatedEvent","pointer":"/paths/~1consumers~1consumer_activated~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/consumers/consumer_activated/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityActivatedEvent"}},"responseCodes":["204"],"pointer":"/consumers/consumer_activated/watch","href":"consumers/consumers_consumer_activated_watch","openApiOperationId":"consumers_consumer_activated_watch","summary":"Consumer activation"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/IdentityActivatedEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityActivatedEvent"}},"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"}],"pointer":"/paths/~1consumers~1consumer_activated~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/consumers_consumer_activated_watch"}],"panels":[]}]},"httpPath":"/consumers/consumer_activated/watch"},{"label":"Consumer deactivation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/consumers/consumers_consumer_deactivated_watch","routeSlug":"/products/webhooks/openapi/consumers/consumers_consumer_deactivated_watch","metadata":{"seo":{"title":"Consumer deactivation","description":"Notification that a consumer identity has been deactivated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumers_consumer_deactivated_watch","name":"Consumer deactivation","isWebhook":true,"pointer":"/paths/~1consumers~1consumer_deactivated~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumer 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 consumer identity has been deactivated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1consumers~1consumer_deactivated~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"schemaId":"components/schemas/IdentityDeactivatedEvent","pointer":"/paths/~1consumers~1consumer_deactivated~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/consumers/consumer_deactivated/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"responseCodes":["204"],"pointer":"/consumers/consumer_deactivated/watch","href":"consumers/consumers_consumer_deactivated_watch","openApiOperationId":"consumers_consumer_deactivated_watch","summary":"Consumer deactivation"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/IdentityDeactivatedEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"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"}],"pointer":"/paths/~1consumers~1consumer_deactivated~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/consumers/consumers_consumer_deactivated_watch"}],"panels":[]}]},"httpPath":"/consumers/consumer_deactivated/watch"}],"content":{"contentType":"group","meta":{"name":"Consumers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Consumers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/consumers/kyc/watch","summary":"Consumer KYC status update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consumers/consumers_kyc_watch","deprecated":false},{"title":"/consumers/consumer_activated/watch","summary":"Consumer activation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consumers/consumers_consumer_activated_watch","deprecated":false},{"title":"/consumers/consumer_deactivated/watch","summary":"Consumer deactivation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/consumers/consumers_consumer_deactivated_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Managed Cards","link":"/products/webhooks/openapi/managed-cards","routeSlug":"/products/webhooks/openapi/managed-cards","items":[{"label":"Card state change","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_state_change_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_state_change_watch","metadata":{"seo":{"title":"Card state change","description":"Notification that a card has changed state. The following events trigger a notification:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_state_change_watch","name":"Card state change","isWebhook":true,"pointer":"/paths/~1managed_cards~1state_change~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card state change","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification that a card has changed state. The following events trigger a notification:"},"children":[]}]}]},{"$$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":"Activate a physical card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a managed card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report a physical card as lost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report a physical card as stolen."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mark a virtual card as compromised."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Block a managed card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unblock a managed card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update card renewal type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that since a card can have multiple blocks, an unblock event (for which a notification is sent) may not always result in the card state being updated to Active."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1state_change~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsStateChangeEvent"}},"schemaId":"components/schemas/ManagedCardsStateChangeEvent","pointer":"/paths/~1managed_cards~1state_change~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/state_change/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsStateChangeEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/state_change/watch","href":"managed-cards/managed_cards_state_change_watch","openApiOperationId":"managed_cards_state_change_watch","summary":"Card state change"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsStateChangeEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsStateChangeEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1state_change~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_state_change_watch"}],"panels":[]}]},"httpPath":"/managed_cards/state_change/watch"},{"label":"Card authorisation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_authorisations_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_authorisations_watch","metadata":{"seo":{"title":"Card authorisation","description":"Notification that a card authorisation attempt has been performedon a managed card. This is sent irrespective of the authorisation outcome"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_authorisations_watch","name":"Card authorisation","isWebhook":true,"pointer":"/paths/~1managed_cards~1authorisations~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card authorisation","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification that a card authorisation attempt has been performed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on a managed card. This is sent irrespective of the authorisation outcome"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates whether the authorisation has been approved or denied."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1authorisations~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsAuthorisationEvent"}},"schemaId":"components/schemas/ManagedCardsAuthorisationEvent","pointer":"/paths/~1managed_cards~1authorisations~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/authorisations/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsAuthorisationEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/authorisations/watch","href":"managed-cards/managed_cards_authorisations_watch","openApiOperationId":"managed_cards_authorisations_watch","summary":"Card authorisation"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsAuthorisationEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsAuthorisationEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1authorisations~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_authorisations_watch"}],"panels":[]}]},"httpPath":"/managed_cards/authorisations/watch"},{"label":"Card adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_adjustments_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_adjustments_watch","metadata":{"seo":{"title":"Card adjustment","description":"Notification that a balance adjustment has been processed on a managed card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_adjustments_watch","name":"Card adjustment","isWebhook":true,"pointer":"/paths/~1managed_cards~1adjustments~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card adjustment","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a balance adjustment has been processed on a managed card."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1adjustments~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsAdjustmentEvent"}},"schemaId":"components/schemas/ManagedCardsAdjustmentEvent","pointer":"/paths/~1managed_cards~1adjustments~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/adjustments/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsAdjustmentEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/adjustments/watch","href":"managed-cards/managed_cards_adjustments_watch","openApiOperationId":"managed_cards_adjustments_watch","summary":"Card adjustment"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsAdjustmentEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsAdjustmentEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1adjustments~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_adjustments_watch"}],"panels":[]}]},"httpPath":"/managed_cards/adjustments/watch"},{"label":"Card settlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_settlements_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_settlements_watch","metadata":{"seo":{"title":"Card settlement","description":"Notification that a card settlement has been processed on a managed card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_settlements_watch","name":"Card settlement","isWebhook":true,"pointer":"/paths/~1managed_cards~1settlements~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card settlement","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a card settlement has been processed on a managed card."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1settlements~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsSettlementEvent"}},"schemaId":"components/schemas/ManagedCardsSettlementEvent","pointer":"/paths/~1managed_cards~1settlements~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/settlements/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsSettlementEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/settlements/watch","href":"managed-cards/managed_cards_settlements_watch","openApiOperationId":"managed_cards_settlements_watch","summary":"Card settlement"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsSettlementEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsSettlementEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1settlements~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_settlements_watch"}],"panels":[]}]},"httpPath":"/managed_cards/settlements/watch"},{"label":"Card expiry and renewal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_expiries_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_expiries_watch","metadata":{"seo":{"title":"Card expiry and renewal","description":"Notification that a card is about to expire, a card Expired or a Card was renewed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_expiries_watch","name":"Card expiry and renewal","isWebhook":true,"pointer":"/paths/~1managed_cards~1expiries~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card expiry and renewal","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a card is about to expire, a card Expired or a Card was renewed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1expiries~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsExpiryAndRenewalEvent"}},"schemaId":"components/schemas/ManagedCardsExpiryAndRenewalEvent","pointer":"/paths/~1managed_cards~1expiries~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/expiries/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsExpiryAndRenewalEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/expiries/watch","href":"managed-cards/managed_cards_expiries_watch","openApiOperationId":"managed_cards_expiries_watch","summary":"Card expiry and renewal"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsExpiryAndRenewalEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsExpiryAndRenewalEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1expiries~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_expiries_watch"}],"panels":[]}]},"httpPath":"/managed_cards/expiries/watch"},{"label":"Card upgrade to physical details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_physical_cards_upgrade_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_physical_cards_upgrade_watch","metadata":{"seo":{"title":"Card upgrade to physical details","description":"Notification that there has been an update in the card upgrade to physical process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_physical_cards_upgrade_watch","name":"Card upgrade to physical details","isWebhook":true,"pointer":"/paths/~1managed_cards~1physical_cards_upgrade~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card upgrade to physical details","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that there has been an update in the card upgrade to physical process"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1physical_cards_upgrade~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsUpgradeToPhysicalEvent"}},"schemaId":"components/schemas/ManagedCardsUpgradeToPhysicalEvent","pointer":"/paths/~1managed_cards~1physical_cards_upgrade~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/physical_cards_upgrade/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsUpgradeToPhysicalEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/physical_cards_upgrade/watch","href":"managed-cards/managed_cards_physical_cards_upgrade_watch","openApiOperationId":"managed_cards_physical_cards_upgrade_watch","summary":"Card upgrade to physical details"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsUpgradeToPhysicalEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsUpgradeToPhysicalEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1physical_cards_upgrade~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_physical_cards_upgrade_watch"}],"panels":[]}]},"httpPath":"/managed_cards/physical_cards_upgrade/watch"},{"label":"Card replacement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_replacement_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_replacement_watch","metadata":{"seo":{"title":"Card replacement","description":"Notification that a card replacement has been requested or processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_replacement_watch","name":"Card replacement","isWebhook":true,"pointer":"/paths/~1managed_cards~1replacement~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card replacement","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a card replacement has been requested or processed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1replacement~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsReplacementEvent"}},"schemaId":"components/schemas/ManagedCardsReplacementEvent","pointer":"/paths/~1managed_cards~1replacement~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/replacement/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsReplacementEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/replacement/watch","href":"managed-cards/managed_cards_replacement_watch","openApiOperationId":"managed_cards_replacement_watch","summary":"Card replacement"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsReplacementEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsReplacementEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1replacement~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_replacement_watch"}],"panels":[]}]},"httpPath":"/managed_cards/replacement/watch"},{"label":"Card payment update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-cards/managed_cards_payments_watch","routeSlug":"/products/webhooks/openapi/managed-cards/managed_cards_payments_watch","metadata":{"seo":{"title":"Card payment update","description":"Notification that a card payment (the aggregate of related authorisations, settlements, reversals, refunds and chargebacks) has been created or updated. The payload carries the full current state of the CardPayment, including its event history with snapshots of running totals after each event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_cards_payments_watch","name":"Card payment update","isWebhook":true,"pointer":"/paths/~1managed_cards~1payments~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Card 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 a card payment (the aggregate of related authorisations,\nsettlements, reversals, refunds and chargebacks) has been created or updated.\nThe payload carries the full current state of the CardPayment, including\nits event history with snapshots of running totals after each event.\n"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_cards~1payments~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsCardPaymentEvent"}},"schemaId":"components/schemas/ManagedCardsCardPaymentEvent","pointer":"/paths/~1managed_cards~1payments~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_cards/payments/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedCardsCardPaymentEvent"}},"responseCodes":["204"],"pointer":"/managed_cards/payments/watch","href":"managed-cards/managed_cards_payments_watch","openApiOperationId":"managed_cards_payments_watch","summary":"Card payment update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedCardsCardPaymentEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedCardsCardPaymentEvent"}},"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"}],"pointer":"/paths/~1managed_cards~1payments~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-cards/managed_cards_payments_watch"}],"panels":[]}]},"httpPath":"/managed_cards/payments/watch"}],"content":{"contentType":"group","meta":{"name":"Managed Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Managed Cards","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/managed_cards/state_change/watch","summary":"Card state change","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_state_change_watch","deprecated":false},{"title":"/managed_cards/authorisations/watch","summary":"Card authorisation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_authorisations_watch","deprecated":false},{"title":"/managed_cards/adjustments/watch","summary":"Card adjustment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_adjustments_watch","deprecated":false},{"title":"/managed_cards/settlements/watch","summary":"Card settlement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_settlements_watch","deprecated":false},{"title":"/managed_cards/expiries/watch","summary":"Card expiry and renewal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_expiries_watch","deprecated":false},{"title":"/managed_cards/physical_cards_upgrade/watch","summary":"Card upgrade to physical details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_physical_cards_upgrade_watch","deprecated":false},{"title":"/managed_cards/replacement/watch","summary":"Card replacement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_replacement_watch","deprecated":false},{"title":"/managed_cards/payments/watch","summary":"Card payment update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-cards/managed_cards_payments_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Managed Accounts","link":"/products/webhooks/openapi/managed-accounts","routeSlug":"/products/webhooks/openapi/managed-accounts","items":[{"label":"Account update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-accounts/managed_accounts_watch","routeSlug":"/products/webhooks/openapi/managed-accounts/managed_accounts_watch","metadata":{"seo":{"title":"Account update","description":"Notification that the status of a managed account has been updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_accounts_watch","name":"Account update","isWebhook":true,"pointer":"/paths/~1managed_accounts~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account 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 managed account has been updated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_accounts~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedAccountEvent"}},"schemaId":"components/schemas/ManagedAccountEvent","pointer":"/paths/~1managed_accounts~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_accounts/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedAccountEvent"}},"responseCodes":["204"],"pointer":"/managed_accounts/watch","href":"managed-accounts/managed_accounts_watch","openApiOperationId":"managed_accounts_watch","summary":"Account update"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedAccountEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedAccountEvent"}},"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"}],"pointer":"/paths/~1managed_accounts~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managed_accounts_watch"}],"panels":[]}]},"httpPath":"/managed_accounts/watch"},{"label":"Account incoming wire transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-accounts/managed_accounts_deposits_watch","routeSlug":"/products/webhooks/openapi/managed-accounts/managed_accounts_deposits_watch","metadata":{"seo":{"title":"Account incoming wire transfer","description":"Notification that an incoming wire transfer (previously called 'deposit') has been performed on a managed account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_accounts_deposits_watch","name":"Account incoming wire transfer","isWebhook":true,"pointer":"/paths/~1managed_accounts~1deposits~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account incoming wire transfer","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that an incoming wire transfer (previously called 'deposit') has been performed on a managed account."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_accounts~1deposits~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedAccountsDepositEvent"}},"schemaId":"components/schemas/ManagedAccountsDepositEvent","pointer":"/paths/~1managed_accounts~1deposits~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_accounts/deposits/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedAccountsDepositEvent"}},"responseCodes":["204"],"pointer":"/managed_accounts/deposits/watch","href":"managed-accounts/managed_accounts_deposits_watch","openApiOperationId":"managed_accounts_deposits_watch","summary":"Account incoming wire transfer"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedAccountsDepositEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedAccountsDepositEvent"}},"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"}],"pointer":"/paths/~1managed_accounts~1deposits~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managed_accounts_deposits_watch"}],"panels":[]}]},"httpPath":"/managed_accounts/deposits/watch"},{"label":"Account low balance alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/managed-accounts/managed_accounts_low_balance_watch","routeSlug":"/products/webhooks/openapi/managed-accounts/managed_accounts_low_balance_watch","metadata":{"seo":{"title":"Account low balance alert","description":"Notification that a managed account's available balance has dropped below the configured threshold."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"managed_accounts_low_balance_watch","name":"Account low balance alert","isWebhook":true,"pointer":"/paths/~1managed_accounts~1low_balance~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account low balance alert","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a managed account's available balance has dropped below the configured threshold."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1managed_accounts~1low_balance~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedAccountLowBalanceEvent"}},"schemaId":"components/schemas/ManagedAccountLowBalanceEvent","pointer":"/paths/~1managed_accounts~1low_balance~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/managed_accounts/low_balance/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManagedAccountLowBalanceEvent"}},"responseCodes":["204"],"pointer":"/managed_accounts/low_balance/watch","href":"managed-accounts/managed_accounts_low_balance_watch","openApiOperationId":"managed_accounts_low_balance_watch","summary":"Account low balance alert"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManagedAccountLowBalanceEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManagedAccountLowBalanceEvent"}},"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"}],"pointer":"/paths/~1managed_accounts~1low_balance~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/managed-accounts/managed_accounts_low_balance_watch"}],"panels":[]}]},"httpPath":"/managed_accounts/low_balance/watch"}],"content":{"contentType":"group","meta":{"name":"Managed Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Managed Accounts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/managed_accounts/watch","summary":"Account update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managed_accounts_watch","deprecated":false},{"title":"/managed_accounts/deposits/watch","summary":"Account incoming wire transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managed_accounts_deposits_watch","deprecated":false},{"title":"/managed_accounts/low_balance/watch","summary":"Account low balance alert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/managed-accounts/managed_accounts_low_balance_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Transfers","link":"/products/webhooks/openapi/transfers","routeSlug":"/products/webhooks/openapi/transfers","items":[{"label":"Transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/transfers/transfers_watch","routeSlug":"/products/webhooks/openapi/transfers/transfers_watch","metadata":{"seo":{"title":"Transfer transaction","description":"Notification that a Transfer transaction has been processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transfers_watch","name":"Transfer transaction","isWebhook":true,"pointer":"/paths/~1transfers~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer transaction","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a Transfer transaction has been processed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1transfers~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferEvent"}},"schemaId":"components/schemas/TransferEvent","pointer":"/paths/~1transfers~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/transfers/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TransferEvent"}},"responseCodes":["204"],"pointer":"/transfers/watch","href":"transfers/transfers_watch","openApiOperationId":"transfers_watch","summary":"Transfer transaction"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/TransferEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferEvent"}},"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"}],"pointer":"/paths/~1transfers~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/transfers_watch"}],"panels":[]}]},"httpPath":"/transfers/watch"}],"content":{"contentType":"group","meta":{"name":"Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/transfers/watch","summary":"Transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/transfers_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Sends","link":"/products/webhooks/openapi/sends","routeSlug":"/products/webhooks/openapi/sends","items":[{"label":"Send transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/sends/send_watch","routeSlug":"/products/webhooks/openapi/sends/send_watch","metadata":{"seo":{"title":"Send transaction","description":"Notification that a Send transaction has been processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"send_watch","name":"Send transaction","isWebhook":true,"pointer":"/paths/~1send~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send transaction","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a Send transaction has been processed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1send~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendEvent"}},"schemaId":"components/schemas/SendEvent","pointer":"/paths/~1send~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/send/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SendEvent"}},"responseCodes":["204"],"pointer":"/send/watch","href":"sends/send_watch","openApiOperationId":"send_watch","summary":"Send transaction"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/SendEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendEvent"}},"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"}],"pointer":"/paths/~1send~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sends/send_watch"}],"panels":[]}]},"httpPath":"/send/watch"}],"content":{"contentType":"group","meta":{"name":"Sends"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/send/watch","summary":"Send transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sends/send_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Outgoing Wire Transfers","link":"/products/webhooks/openapi/outgoing-wire-transfers","routeSlug":"/products/webhooks/openapi/outgoing-wire-transfers","items":[{"label":"Outgoing Wire Transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/outgoing-wire-transfers/outgoing_wire_transfers_watch","routeSlug":"/products/webhooks/openapi/outgoing-wire-transfers/outgoing_wire_transfers_watch","metadata":{"seo":{"title":"Outgoing Wire Transfer transaction","description":"Notification that a Outgoing Wire Transfer has been processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"outgoing_wire_transfers_watch","name":"Outgoing Wire Transfer transaction","isWebhook":true,"pointer":"/paths/~1outgoing_wire_transfers~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Outgoing Wire Transfer transaction","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a Outgoing Wire Transfer has been processed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1outgoing_wire_transfers~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferEvent"}},"schemaId":"components/schemas/OutgoingWireTransferEvent","pointer":"/paths/~1outgoing_wire_transfers~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/outgoing_wire_transfers/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferEvent"}},"responseCodes":["204"],"pointer":"/outgoing_wire_transfers/watch","href":"outgoing-wire-transfers/outgoing_wire_transfers_watch","openApiOperationId":"outgoing_wire_transfers_watch","summary":"Outgoing Wire Transfer transaction"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/OutgoingWireTransferEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OutgoingWireTransferEvent"}},"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"}],"pointer":"/paths/~1outgoing_wire_transfers~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/outgoing-wire-transfers/outgoing_wire_transfers_watch"}],"panels":[]}]},"httpPath":"/outgoing_wire_transfers/watch"}],"content":{"contentType":"group","meta":{"name":"Outgoing Wire Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Outgoing Wire Transfers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/outgoing_wire_transfers/watch","summary":"Outgoing Wire Transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/outgoing-wire-transfers/outgoing_wire_transfers_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Correspondent Bank Transfers","link":"/products/webhooks/openapi/correspondent-bank-transfers","routeSlug":"/products/webhooks/openapi/correspondent-bank-transfers","items":[{"label":"Correspondent Bank Transfer transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/correspondent-bank-transfers/correspondent_bank_transfers_watch","routeSlug":"/products/webhooks/openapi/correspondent-bank-transfers/correspondent_bank_transfers_watch","metadata":{"seo":{"title":"Correspondent Bank Transfer transaction","description":"Notification that a Correspondent Bank Transfer has been processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"correspondent_bank_transfers_watch","name":"Correspondent Bank Transfer transaction","isWebhook":true,"pointer":"/paths/~1correspondent_bank_transfers~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Correspondent Bank Transfer transaction","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a Correspondent Bank Transfer has been processed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1correspondent_bank_transfers~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorrespondentBankTransferEvent"}},"schemaId":"components/schemas/CorrespondentBankTransferEvent","pointer":"/paths/~1correspondent_bank_transfers~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/correspondent_bank_transfers/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CorrespondentBankTransferEvent"}},"responseCodes":["204"],"pointer":"/correspondent_bank_transfers/watch","href":"correspondent-bank-transfers/correspondent_bank_transfers_watch","openApiOperationId":"correspondent_bank_transfers_watch","summary":"Correspondent Bank Transfer transaction"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CorrespondentBankTransferEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CorrespondentBankTransferEvent"}},"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"}],"pointer":"/paths/~1correspondent_bank_transfers~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/correspondent-bank-transfers/correspondent_bank_transfers_watch"}],"panels":[]}]},"httpPath":"/correspondent_bank_transfers/watch"}],"content":{"contentType":"group","meta":{"name":"Correspondent Bank Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Correspondent Bank Transfers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/correspondent_bank_transfers/watch","summary":"Correspondent Bank Transfer transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/correspondent-bank-transfers/correspondent_bank_transfers_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Manual Transactions","link":"/products/webhooks/openapi/manual-transactions","routeSlug":"/products/webhooks/openapi/manual-transactions","items":[{"label":"Manual transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/manual-transactions/manual_transactions_watch","routeSlug":"/products/webhooks/openapi/manual-transactions/manual_transactions_watch","metadata":{"seo":{"title":"Manual transaction","description":"Notification that a manual transaction has been processed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"manual_transactions_watch","name":"Manual transaction","isWebhook":true,"pointer":"/paths/~1manual_transactions~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual transaction","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a manual transaction has been processed."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1manual_transactions~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManualTransactionEvent"}},"schemaId":"components/schemas/ManualTransactionEvent","pointer":"/paths/~1manual_transactions~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/manual_transactions/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ManualTransactionEvent"}},"responseCodes":["204"],"pointer":"/manual_transactions/watch","href":"manual-transactions/manual_transactions_watch","openApiOperationId":"manual_transactions_watch","summary":"Manual transaction"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ManualTransactionEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ManualTransactionEvent"}},"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"}],"pointer":"/paths/~1manual_transactions~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/manual-transactions/manual_transactions_watch"}],"panels":[]}]},"httpPath":"/manual_transactions/watch"}],"content":{"contentType":"group","meta":{"name":"Manual Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual Transactions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/manual_transactions/watch","summary":"Manual transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/manual-transactions/manual_transactions_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Fees","link":"/products/webhooks/openapi/fees","routeSlug":"/products/webhooks/openapi/fees","items":[{"label":"FeeWatch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/fees/fees_watch","routeSlug":"/products/webhooks/openapi/fees/fees_watch","metadata":{"seo":{"title":"FeeWatch","description":"Notification that a fee has been charged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fees_watch","name":"FeeWatch","isWebhook":true,"pointer":"/paths/~1fees~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FeeWatch","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a fee has been charged."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1fees~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargeFeeEvent"}},"schemaId":"components/schemas/ChargeFeeEvent","pointer":"/paths/~1fees~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/fees/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ChargeFeeEvent"}},"responseCodes":["204"],"pointer":"/fees/watch","href":"fees/fees_watch","openApiOperationId":"fees_watch","summary":"FeeWatch"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ChargeFeeEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChargeFeeEvent"}},"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"}],"pointer":"/paths/~1fees~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/fees_watch"}],"panels":[]}]},"httpPath":"/fees/watch"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/fees/watch","summary":"FeeWatch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/fees_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Login","link":"/products/webhooks/openapi/login","routeSlug":"/products/webhooks/openapi/login","items":[{"label":"Login attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/login/login_watch","routeSlug":"/products/webhooks/openapi/login/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":"login_watch","name":"Login attempt","isWebhook":true,"pointer":"/paths/~1login~1watch/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."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1login~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoginEvent"}},"schemaId":"components/schemas/LoginEvent","pointer":"/paths/~1login~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/login/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/LoginEvent"}},"responseCodes":["204"],"pointer":"/login/watch","href":"login/login_watch","openApiOperationId":"login_watch","summary":"Login attempt"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/LoginEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LoginEvent"}},"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"}],"pointer":"/paths/~1login~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/login/login_watch"}],"panels":[]}]},"httpPath":"/login/watch"}],"content":{"contentType":"group","meta":{"name":"Login"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/login/watch","summary":"Login attempt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/login/login_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Stepup","link":"/products/webhooks/openapi/stepup","routeSlug":"/products/webhooks/openapi/stepup","items":[{"label":"Step-up status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/stepup/stepup_watch","routeSlug":"/products/webhooks/openapi/stepup/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/~1stepup~1watch/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_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1stepup~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StepupEvent"}},"schemaId":"components/schemas/StepupEvent","pointer":"/paths/~1stepup~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/stepup/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/StepupEvent"}},"responseCodes":["204"],"pointer":"/stepup/watch","href":"stepup/stepup_watch","openApiOperationId":"stepup_watch","summary":"Step-up status"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/StepupEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StepupEvent"}},"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"}],"pointer":"/paths/~1stepup~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stepup/stepup_watch"}],"panels":[]}]},"httpPath":"/stepup/watch"}],"content":{"contentType":"group","meta":{"name":"Stepup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stepup","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/stepup/watch","summary":"Step-up status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stepup/stepup_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Authentication Factors","link":"/products/webhooks/openapi/authentication-factors","routeSlug":"/products/webhooks/openapi/authentication-factors","items":[{"label":"Enrolment status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/authentication-factors/authentication_factors_watch","routeSlug":"/products/webhooks/openapi/authentication-factors/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/~1authentication_factors~1watch/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_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1authentication_factors~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrolmentEvent"}},"schemaId":"components/schemas/EnrolmentEvent","pointer":"/paths/~1authentication_factors~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/authentication_factors/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/EnrolmentEvent"}},"responseCodes":["204"],"pointer":"/authentication_factors/watch","href":"authentication-factors/authentication_factors_watch","openApiOperationId":"authentication_factors_watch","summary":"Enrolment status"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/EnrolmentEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EnrolmentEvent"}},"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"}],"pointer":"/paths/~1authentication_factors~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication-factors/authentication_factors_watch"}],"panels":[]}]},"httpPath":"/authentication_factors/watch"}],"content":{"contentType":"group","meta":{"name":"Authentication Factors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication Factors","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/authentication_factors/watch","summary":"Enrolment status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-factors/authentication_factors_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Trusted Payees","link":"/products/webhooks/openapi/trusted-payees","routeSlug":"/products/webhooks/openapi/trusted-payees","items":[{"label":"Beneficiary batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/trusted-payees/beneficiary_batch_watch","routeSlug":"/products/webhooks/openapi/trusted-payees/beneficiary_batch_watch","metadata":{"seo":{"title":"Beneficiary batch","description":"Notification that a Beneficiary batch has been submitted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"beneficiary_batch_watch","name":"Beneficiary batch","isWebhook":true,"pointer":"/paths/~1beneficiaries~1batch~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Beneficiary batch","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that a Beneficiary batch has been submitted."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1beneficiaries~1batch~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatchEvent"}},"schemaId":"components/schemas/BeneficiaryBatchEvent","pointer":"/paths/~1beneficiaries~1batch~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/beneficiaries/batch/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatchEvent"}},"responseCodes":["204"],"pointer":"/beneficiaries/batch/watch","href":"trusted-payees/beneficiary_batch_watch","openApiOperationId":"beneficiary_batch_watch","summary":"Beneficiary batch"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BeneficiaryBatchEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeneficiaryBatchEvent"}},"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"}],"pointer":"/paths/~1beneficiaries~1batch~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/trusted-payees/beneficiary_batch_watch"}],"panels":[]}]},"httpPath":"/beneficiaries/batch/watch"}],"content":{"contentType":"group","meta":{"name":"Trusted Payees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trusted Payees","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/beneficiaries/batch/watch","summary":"Beneficiary batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/trusted-payees/beneficiary_batch_watch","deprecated":false}]}]}]}]}},{"type":"group","label":"Bulk Operations","link":"/products/webhooks/openapi/bulk-operations","routeSlug":"/products/webhooks/openapi/bulk-operations","items":[{"label":"Bulk Process End","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/bulk-operations/bulk_process_end","routeSlug":"/products/webhooks/openapi/bulk-operations/bulk_process_end","metadata":{"seo":{"title":"Bulk Process End","description":"Reports on the final state of execution of a bulk process the moment it ends:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulk_process_end","name":"Bulk Process End","isWebhook":true,"pointer":"/paths/~1bulk_process_end~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Process End","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reports on the final state of execution of a bulk process the moment it ends:"},"children":[]}]}]},{"$$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":"COMPLETED: the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED: none of the operations of the bulk process have executed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIALLY_COMPLETED: the execution of the bulk process is complete and some of the bulk operations of the bulk process failed."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"webhooks_key","scopes":[]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"request-ref","in":"header","schemaId":"schema_716","description":"A unique call reference included in every call, that enables the receiver to avoid duplicate handling of a webhook request (e.g. webhook was resent)."},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true}],"pointer":"/paths/~1bulk_process_end~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkProcessProgressEvent"}},"schemaId":"components/schemas/BulkProcessProgressEvent","pointer":"/paths/~1bulk_process_end~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/bulk_process_end/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"request-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkProcessProgressEvent"}},"responseCodes":["204"],"pointer":"/bulk_process_end/watch","href":"bulk-operations/bulk_process_end","openApiOperationId":"bulk_process_end","summary":"Bulk Process End"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BulkProcessProgressEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkProcessProgressEvent"}},"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"}],"pointer":"/paths/~1bulk_process_end~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bulk-operations/bulk_process_end"}],"panels":[]}]},"httpPath":"/bulk_process_end/watch"}],"content":{"contentType":"group","meta":{"name":"Bulk Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Operations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/bulk_process_end/watch","summary":"Bulk Process End","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bulk-operations/bulk_process_end","deprecated":false}]}]}]}]}},{"type":"group","label":"Authorised Users","link":"/products/webhooks/openapi/authorised-users","routeSlug":"/products/webhooks/openapi/authorised-users","items":[{"label":"Auth user deactivation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/products/webhooks/openapi/authorised-users/auth_users_user_deactivated_watch","routeSlug":"/products/webhooks/openapi/authorised-users/auth_users_user_deactivated_watch","metadata":{"seo":{"title":"Auth user deactivation","description":"Notification that an auth user has been deactivated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"auth_users_user_deactivated_watch","name":"Auth user deactivation","isWebhook":true,"pointer":"/paths/~1auth~1users~1user_deactivated~1watch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auth user deactivation","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Notification that an auth user has been deactivated."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"call-ref","in":"header","schemaId":"schema_716","description":"A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255"},{"name":"published-timestamp","in":"header","schemaId":"schema_717","description":"The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.","required":true},{"name":"signature","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true,"deprecated":true},{"name":"signature-v2","in":"header","schemaId":"schema_716","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"call-ref + payload + published-timestamp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using your API key."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1auth~1users~1user_deactivated~1watch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"schemaId":"components/schemas/IdentityDeactivatedEvent","pointer":"/paths/~1auth~1users~1user_deactivated~1watch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"/auth/users/user_deactivated/watch","servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"call-ref","in":"header","required":false,"schemaId":"schema_716"},{"name":"published-timestamp","in":"header","required":true,"schemaId":"schema_717","style":"simple","explode":false},{"name":"signature","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false},{"name":"signature-v2","in":"header","required":true,"schemaId":"schema_716","style":"simple","explode":false}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"responseCodes":["204"],"pointer":"/auth/users/user_deactivated/watch","href":"authorised-users/auth_users_user_deactivated_watch","openApiOperationId":"auth_users_user_deactivated_watch","summary":"Auth user deactivation"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/IdentityDeactivatedEvent","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityDeactivatedEvent"}},"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"}],"pointer":"/paths/~1auth~1users~1user_deactivated~1watch/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorised-users/auth_users_user_deactivated_watch"}],"panels":[]}]},"httpPath":"/auth/users/user_deactivated/watch"}],"content":{"contentType":"group","meta":{"name":"Authorised Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorised Users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"/auth/users/user_deactivated/watch","summary":"Auth user deactivation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorised-users/auth_users_user_deactivated_watch","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/KybEvent":{"id":"components/schemas/KybEvent","kind":"json-schema","title":"KybEvent","data":{"type":"object","properties":{"corporateId":{"type":"string","pattern":"^[0-9]+$","description":"Id of the corporate."},"corporateEmail":{"type":"string","description":"Email of the corporate."},"status":{"$ref":"#/components/schemas/KyiStatus","deprecated":true,"description":"Effective KYB status of the corporate. Deprecated in favour of corporateKybStatus."},"details":{"type":"array","deprecated":true,"description":"Action which my be required to re-process kyb in case of temporary rejections. Deprecated in favour of the KYB Run information.","items":{"$ref":"#/components/schemas/CorporateKybFailureReason"}},"rejectionComment":{"type":"string","description":"Reason shown to the user in case of temporary rejection."},"ongoingStatus":{"$ref":"#/components/schemas/KyiStatus","deprecated":true,"description":"Ongoing KYB Status of the corporate. Deprecated in favour of corporateKybStatus."},"corporateKybStatus":{"$ref":"#/components/schemas/CorporateKybStatus","description":"The Corporate KYB Status for the corporate's regulatory FI. Indicates whether the corporate can use the FI service."},"kybRuns":{"type":"array","description":"The latest KYB Run per regulatory FI.","items":{"$ref":"#/components/schemas/KybRun"}}}}},"components/schemas/CorporateKybStatus":{"id":"components/schemas/CorporateKybStatus","kind":"json-schema","title":"CorporateKybStatus","data":{"type":"string","enum":["NEW","PENDING","APPROVED","REJECTED","CLOSED"]}},"components/schemas/KybRun":{"id":"components/schemas/KybRun","kind":"json-schema","title":"KybRun","data":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"Id of the KYB Run."},"regulatoryFi":{"type":"string","description":"The regulatory FI the run verifies the corporate against."},"status":{"$ref":"#/components/schemas/KybRunStatus","description":"The status of the KYB Run."},"runType":{"$ref":"#/components/schemas/KybRunType","description":"Whether the run is the initial onboarding verification or a KYB refresh."},"startedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"endedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision. Absent while the run is open."},"notes":{"type":"string","description":"Compliance note attached to the run."}}}},"components/schemas/KybRunStatus":{"id":"components/schemas/KybRunStatus","kind":"json-schema","title":"KybRunStatus","data":{"type":"string","enum":["COLLECTION.NOT_STARTED","COLLECTION.READY_TO_START","COLLECTION.IN_PROGRESS","REVIEW.IN_PROGRESS","RESUBMISSION.IN_PROGRESS","KYB_RUN.APPROVED","KYB_RUN.REJECTED","KYB_RUN.CANCELLED"]}},"components/schemas/KybRunType":{"id":"components/schemas/KybRunType","kind":"json-schema","title":"KybRunType","data":{"type":"string","enum":["INITIAL_ONBOARDING","REFRESH"]}},"components/schemas/CorporateKybFailureReason":{"id":"components/schemas/CorporateKybFailureReason","kind":"json-schema","title":"CorporateKybFailureReason","data":{"type":"string","enum":["UNDEFINED_REQUIRED_INTERVENTION","DOCUMENTS_UNSATISFACTORY","SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH","LANGUAGE_IN_DOCUMENTS_UNSUPPORTED","SELFIE_UNSATISFACTORY","SELFIE_AND_DOCUMENTS_MISMATCH","CORPORATE_DETAILS_UNSATISFACTORY","BENEFICIARY_DETAILS_UNSATISFACTORY","REPRESENTATIVE_DETAILS_UNSATISFACTORY","OTHER","ROOT_USER_UNMATCHED_TO_DIRECTOR_OR_REPRESENTATIVE","UNSUPPORTED_COUNTRY","EXPIRED_KYC_DOCUMENTS"]}},"components/schemas/BeneficiaryVerifiedEvent":{"id":"components/schemas/BeneficiaryVerifiedEvent","kind":"json-schema","title":"BeneficiaryVerifiedEvent","data":{"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":{"$ref":"#/components/schemas/BeneficiaryEventType"}},"eventDetails":{"type":"array","description":"A reason, if any, describing why this event has occurred.","items":{"$ref":"#/components/schemas/CorporateKybFailureReason"}},"additionalInformation":{"$ref":"#/components/schemas/BeneficiaryVerifiedEventAdditionalInformation","description":"Additional information related to the event triggering this notification."},"rejectionComment":{"type":"string","description":"Reason shown to the user in case of temporary rejection."}}}},"components/schemas/BeneficiaryEventType":{"id":"components/schemas/BeneficiaryEventType","kind":"json-schema","title":"BeneficiaryEventType","data":{"type":"string","enum":["STATUS_UPDATED","BENEFICIARY_TYPE_UPDATED","FIRST_NAME_UPDATED","MIDDLE_NAME_UPDATED","LAST_NAME_UPDATED","EMAIL_UPDATED"]}},"components/schemas/BeneficiaryVerifiedEventAdditionalInformation":{"id":"components/schemas/BeneficiaryVerifiedEventAdditionalInformation","kind":"json-schema","title":"BeneficiaryVerifiedEventAdditionalInformation","data":{"type":"object","properties":{"corporateId":{"type":"string","pattern":"^[0-9]+$","description":"The corporate id whose beneficiary has triggered this event."},"corporateName":{"type":"string","description":"The corporate name whose beneficiary has triggered this event."},"rootUserEmail":{"type":"string","description":"The corporate's root user email."},"kybStatus":{"$ref":"#/components/schemas/KyiStatus","description":"The status of the Full Company Verification Checks for the corporate entity."},"beneficiary":{"$ref":"#/components/schemas/BeneficiaryInfo"},"documentExpiryDate":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"identityRestrictionDate":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/KycEventAdditionalInformation":{"id":"components/schemas/KycEventAdditionalInformation","kind":"json-schema","title":"KycEventAdditionalInformation","data":{"type":"object","properties":{"documentExpiryDate":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"identityRestrictionDate":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/BeneficiaryInfo":{"id":"components/schemas/BeneficiaryInfo","kind":"json-schema","title":"BeneficiaryInfo","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/BeneficiaryType","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":{"$ref":"#/components/schemas/KyiStatus","description":"Effective KYB Status of the beneficiary."},"ongoingKybStatus":{"$ref":"#/components/schemas/KyiStatus","description":"Ongoing KYB Status of the beneficiary."}}}},"components/schemas/KyiStatus":{"id":"components/schemas/KyiStatus","kind":"json-schema","title":"KyiStatus","data":{"type":"string","enum":["UNDEFINED","NOT_STARTED","INITIATED","PENDING_REVIEW","APPROVED","REJECTED"]}},"components/schemas/BeneficiaryValidationFailure":{"id":"components/schemas/BeneficiaryValidationFailure","kind":"json-schema","title":"BeneficiaryValidationFailure","data":{"type":"string","enum":["INSTRUMENT_DETAILS_NOT_FOUND","BENEFICIARY_DETAILS_ALREADY_EXIST","BENEFICIARY_BELONGS_TO_SAME_IDENTITY","BENEFICIARY_VALIDATION_FAILURE_UNKNOWN"]}},"components/schemas/BeneficiaryType":{"id":"components/schemas/BeneficiaryType","kind":"json-schema","title":"BeneficiaryType","data":{"type":"string","enum":["UNDEFINED_BENEFICIARY_TYPE","UBO","DIRECTOR","UNKNOWN","SHAREHOLDER","PARTNER","OTHER_DIRECTOR"]}},"components/schemas/IdentityActivatedEvent":{"id":"components/schemas/IdentityActivatedEvent","kind":"json-schema","title":"IdentityActivatedEvent","data":{"required":["actionDoneBy","emailAddress"],"type":"object","properties":{"actionDoneBy":{"$ref":"#/components/schemas/ActionDoneBy"},"emailAddress":{"type":"string"},"corporateKybStatus":{"$ref":"#/components/schemas/CorporateKybStatus","description":"The Corporate KYB Status. Only populated for corporates."},"kybRuns":{"type":"array","description":"The latest KYB Run per regulatory FI. Only populated for corporates.","items":{"$ref":"#/components/schemas/KybRun"}}}}},"components/schemas/ActionDoneBy":{"id":"components/schemas/ActionDoneBy","kind":"json-schema","title":"ActionDoneBy","data":{"type":"string","enum":["UNDEFINED","ADMIN","INNOVATOR"]}},"components/schemas/IdentityDeactivatedEvent":{"id":"components/schemas/IdentityDeactivatedEvent","kind":"json-schema","title":"IdentityDeactivatedEvent","data":{"required":["actionDoneBy","emailAddress","reasonCode"],"type":"object","properties":{"actionDoneBy":{"$ref":"#/components/schemas/ActionDoneBy"},"emailAddress":{"type":"string"},"reasonCode":{"$ref":"#/components/schemas/IdentityDeactivatedReasonCode"},"corporateKybStatus":{"$ref":"#/components/schemas/CorporateKybStatus","description":"The Corporate KYB Status. Only populated for corporates."},"kybRuns":{"type":"array","description":"The latest KYB Run per regulatory FI. Only populated for corporates.","items":{"$ref":"#/components/schemas/KybRun"}}}}},"components/schemas/IdentityDeactivatedReasonCode":{"id":"components/schemas/IdentityDeactivatedReasonCode","kind":"json-schema","title":"IdentityDeactivatedReasonCode","data":{"type":"string","enum":["UNDEFINED_REASON","ACCOUNT_REVIEW","ACCOUNT_SECURITY","TEMPORARY","ACCOUNT_CLOSURE","ACCOUNT_ABANDONED"]}},"components/schemas/KycEvent":{"id":"components/schemas/KycEvent","kind":"json-schema","title":"KycEvent","data":{"type":"object","properties":{"consumerId":{"type":"string","pattern":"^[0-9]+$"},"consumerEmail":{"type":"string"},"status":{"$ref":"#/components/schemas/KyiStatus"},"details":{"type":"array","description":"Action which my be required to re-process kyc in case of temporary rejections.","items":{"$ref":"#/components/schemas/KycRejectionReason"}},"rejectionComment":{"type":"string","description":"Reason shown to the user in case of temporary rejection."},"kycLevel":{"$ref":"#/components/schemas/KycLevel"},"ongoingStatus":{"$ref":"#/components/schemas/KyiStatus"},"ongoingKycLevel":{"$ref":"#/components/schemas/KycLevel"},"eventTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"additionalInformation":{"$ref":"#/components/schemas/KycEventAdditionalInformation","description":"Additional information related to the event triggering this notification."}}}},"components/schemas/KycRejectionReason":{"id":"components/schemas/KycRejectionReason","kind":"json-schema","title":"KycRejectionReason","data":{"type":"string","enum":["UNDEFINED_KYC_FAILURE_REASON","DOCUMENTS_UNSATISFACTORY","SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH","LANGUAGE_IN_DOCUMENTS_UNSUPPORTED","SELFIE_UNSATISFACTORY","SELFIE_AND_DOCUMENTS_MISMATCH","OTHER","UNSUPPORTED_COUNTRY","PEP_STATUS","REJECTED_DUPLICATE","EXPIRED_KYC_DOCUMENTS"]}},"components/schemas/IbanEvent":{"id":"components/schemas/IbanEvent","kind":"json-schema","title":"IbanEvent","data":{"required":["iban","publishedTimestamp","type"],"type":"object","properties":{"iban":{"$ref":"#/components/schemas/IbanInstrument"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"type":{"$ref":"#/components/schemas/IbanEventType"}}}},"components/schemas/LinkedAccountEvent":{"id":"components/schemas/LinkedAccountEvent","kind":"json-schema","title":"LinkedAccountEvent","data":{"required":["linkedAccount","publishedTimestamp","eventType"],"type":"object","properties":{"linkedAccount":{"$ref":"#/components/schemas/LinkedAccount"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"eventType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of event that occurred related to the linked account. Possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_VERIFICATION"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account is pending verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VERIFIED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The overall verification run was successfully completed. The linked account is now verified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCKED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account has been blocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNBLOCKED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account has been unblocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMOVED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account has been removed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The linked account was rejected."},"children":[]}]}]}]}],"$ref":"#/components/schemas/LinkedAccountEventType"}}}},"components/schemas/ManagedAccountEvent":{"id":"components/schemas/ManagedAccountEvent","kind":"json-schema","title":"ManagedAccountEvent","data":{"required":["account","publishedTimestamp","type"],"type":"object","properties":{"account":{"$ref":"#/components/schemas/LegacyManagedAccount"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"type":{"$ref":"#/components/schemas/ManagedAccountEventType"}}}},"components/schemas/ManagedAccountLowBalanceEvent":{"id":"components/schemas/ManagedAccountLowBalanceEvent","kind":"json-schema","title":"ManagedAccountLowBalanceEvent","data":{"required":["id","currency","availableBalance","publishedTimestamp"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId"},"currency":{"$ref":"#/components/schemas/Currency"},"availableBalance":{"type":"integer","format":"int64"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/LegacyManagedAccount":{"id":"components/schemas/LegacyManagedAccount","kind":"json-schema","title":"LegacyManagedAccount","data":{"required":["creationTimestamp","currency","friendlyName","id","owner","profileId"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId"},"profileId":{"type":"string","pattern":"^[0-9]+$"},"tag":{"maxLength":50,"pattern":"^$|^[a-zA-Z0-9_-]+$","type":"string"},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"friendlyName":{"maxLength":50,"minLength":1,"type":"string"},"active":{"type":"boolean"},"currency":{"$ref":"#/components/schemas/Currency"},"balances":{"type":"object","properties":{"availableBalance":{"type":"string","pattern":"^[0-9]+$"},"actualBalance":{"type":"string","pattern":"^[0-9]+$"}}},"state":{"$ref":"#/components/schemas/InstrumentStateLegacy"},"creationTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"bankAccountDetails":{"$ref":"#/components/schemas/BankAccountDetails","description":"The bank account details to be used when loading funds to this managed account."}}}},"components/schemas/LegacyCurrencyAmount":{"id":"components/schemas/LegacyCurrencyAmount","kind":"json-schema","title":"LegacyCurrencyAmount","data":{"required":["currency","amount"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"string","pattern":"^[0-9]+$","description":"The monetary amount, scaled to the lowest denomination of the currency."}},"description":"The object representing a monetary amount in a particular currency."}},"components/schemas/InstrumentStateLegacy":{"id":"components/schemas/InstrumentStateLegacy","kind":"json-schema","title":"InstrumentStateLegacy","data":{"type":"object","properties":{"blockTypes":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"destroyType":{"type":"string"}}}},"components/schemas/BankAccountDetails":{"id":"components/schemas/BankAccountDetails","kind":"json-schema","title":"BankAccountDetails","data":{"type":"object","properties":{"beneficiary":{"type":"string"},"address":{"type":"string"},"beneficiaryBank":{"type":"string"},"bankIdentifierCode":{"type":"string"},"iban":{"type":"string"},"accountNumber":{"type":"string"},"sortCode":{"type":"string"},"paymentReference":{"type":"string","description":"A reference required by the partner bank to execute a load on this managed account."}}}},"components/schemas/IbanEventType":{"id":"components/schemas/IbanEventType","kind":"json-schema","title":"IbanEventType","data":{"type":"string","enum":["CREATED","UPDATED","REQUESTED","REJECTED","BLOCKED","UNBLOCKED","DESTROYED"]}},"components/schemas/ManagedAccountEventType":{"id":"components/schemas/ManagedAccountEventType","kind":"json-schema","title":"ManagedAccountEventType","data":{"type":"string","enum":["CREATED","UPDATED","REQUESTED","REJECTED","BLOCKED","UNBLOCKED","DESTROYED"]}},"components/schemas/LinkedAccountEventType":{"id":"components/schemas/LinkedAccountEventType","kind":"json-schema","title":"LinkedAccountEventType","data":{"type":"string","enum":["PENDING_VERIFICATION","VERIFIED","BLOCKED","UNBLOCKED","REMOVED","REJECTED"]}},"components/schemas/ManagedAccountsDepositEvent":{"id":"components/schemas/ManagedAccountsDepositEvent","kind":"json-schema","title":"ManagedAccountsDepositEvent","data":{"required":["id","owner","transactionAmount","transactionId","transactionTimestamp"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the managed account where an incoming wire transfer has been received."},"transactionId":{"type":"string","pattern":"^[0-9]+$","description":"The id of the transaction, for reference."},"transactionAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The amount of the transaction."},"transactionTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"The timestamp of the transaction, using epoch timestamp with millisecond precision."},"paymentNetwork":{"$ref":"#/components/schemas/TransferType","description":"The field specifies the payment system through which the incoming wire transfer was processed."},"emailAddress":{"type":"string","description":"The email address of the user who effected the incoming wire transfer."},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"senderName":{"type":"string"},"state":{"$ref":"#/components/schemas/ManagedAccountsIwtEventIwtState"},"senderIban":{"type":"string"},"senderSortCode":{"type":"string"},"senderAccountNumber":{"type":"string"},"senderAccountDescriptor":{"type":"string"},"transactionFee":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"Any fee amount taken with the incoming wire transfer"},"senderReference":{"type":"string","description":"A reference provided by the sender of the incoming wire transfer"}}}},"components/schemas/ManagedAccountsIwtEventIwtState":{"id":"components/schemas/ManagedAccountsIwtEventIwtState","kind":"json-schema","title":"ManagedAccountsIwtEventIwtState","data":{"type":"string","enum":["PENDING","COMPLETED","REJECTED"]}},"components/schemas/ManagedCardsStateChangeEvent":{"id":"components/schemas/ManagedCardsStateChangeEvent","kind":"json-schema","title":"ManagedCardsStateChangeEvent","data":{"required":["id","timestamp","eventType","cardType","renewalType"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId","description":null},"timestamp":{"type":"string","pattern":"^[0-9]+$","description":"The timestamp of the state change, using epoch timestamp with millisecond precision."},"eventType":{"$ref":"#/components/schemas/StateChangeEventType"},"state":{"$ref":"#/components/schemas/StateChangeState"},"cardType":{"$ref":"#/components/schemas/CardType"},"renewalType":{"$ref":"#/components/schemas/CardRenewalType"}}}},"components/schemas/ManagedCardsAuthorisationEvent":{"id":"components/schemas/ManagedCardsAuthorisationEvent","kind":"json-schema","title":"ManagedCardsAuthorisationEvent","data":{"required":["authorisationType","id","merchantData","merchantName","owner","sourceAmount","transactionAmount","transactionId","transactionTimestamp"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the managed card on which an authorisation has been performed."},"transactionId":{"type":"string","pattern":"^[0-9]+$","description":"The id of the transaction, for reference."},"transactionAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The amount in the currency of the card."},"transactionTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"The timestamp of the transaction, using epoch timestamp with millisecond precision."},"sourceAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The amount in the currency of the merchant."},"merchantData":{"$ref":"#/components/schemas/MerchantData","description":"Merchant related information"},"merchantName":{"type":"string","description":"The name of the merchant where the authorisation has been made.","deprecated":true},"merchantCategoryCode":{"type":"string","description":"The merchant category code.","deprecated":true},"merchantId":{"type":"string","description":"The merchant ID.","deprecated":true},"approved":{"type":"boolean","description":"Indicates whether the authorisation has been approved or denied."},"availableBalance":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The updated card available balance after this authorisation was processed."},"declineReason":{"$ref":"#/components/schemas/AuthDeclineReason","description":"An indication of why the authorisation was declined"},"authRuleFailedReason":{"$ref":"#/components/schemas/AuthRuleChecksFailedReason","description":"If the authorisation was declined due to auth rule checks, this indicates the auth rule that was violated."},"authorisationType":{"$ref":"#/components/schemas/CardAuthorisationDetailsAuthorisationType","description":"The type of authorisation that was processed."},"authorisationCategory":{"$ref":"#/components/schemas/AuthorisationCategory"},"relatedAuthorisationId":{"type":"string","pattern":"^[0-9]+$","description":"The related authorisation id which this authorisation is performing further updates on.","deprecated":true},"relatedAuthorisationIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The list of related authorisation ids which this authorisation is related to."},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"cardholderPresent":{"$ref":"#/components/schemas/CardHolderPresent","description":"Optional detail indicating if the card holder was present when the authorisation occurred."},"cardPresent":{"type":"boolean","description":"Optional detail indicating if the card was present when the authorisation occurred."},"details":{"$ref":"#/components/schemas/ManagedCardModeDetails"},"authCode":{"maxLength":6,"minLength":1,"type":"string","description":"The authorisation code associated with this authorisation."},"forexPadding":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The forex padding amount, if any, that has been included in the transactionAmount."},"forexFee":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The forex fee, if any, that has been included in the transactionAmount."},"authForwardingDetails":{"$ref":"#/components/schemas/AuthForwardingDetails","description":"Contains information about the authorisations that have been forwarded."},"merchantCountryCode":{"type":"string","description":"The merchant country code.","deprecated":true},"digitalWalletDetails":{"$ref":"#/components/schemas/DigitalWalletDetails"},"userCurrencyTransactionDetails":{"$ref":"#/components/schemas/UserCurrencyTransactionDetails","description":"The object representing the localised transaction's details"},"transactionType":{"$ref":"#/components/schemas/CardAuthorisationDetailsTransactionType","description":"The fine-grained transaction classification, e.g. ATM cash withdrawal, account funding transaction, original credit transaction."}}}},"components/schemas/AuthDeclineReason":{"id":"components/schemas/AuthDeclineReason","kind":"json-schema","title":"AuthDeclineReason","data":{"type":"string","enum":["NO_REASON","PHYSICAL_NOT_ACTIVATED","INSUFFICIENT_BALANCE","CVV_CHECKS_FAILED","CVV_RETRIES_EXCEEDED","CARD_STATUS_NOT_ALLOWED","PIN_CHECKS_FAILED","PIN_RETRIES_EXCEEDED","CARD_EXPIRY_CHECKS_FAILED","AVS_CHECKS_FAILED","ATM_WITHDRAWAL_LIMIT_EXCEEDED","SCA_REQUIRED","AUTH_RULE_CHECKS_FAILED","TRANSACTION_NOT_PERMITTED","TIMEOUT","SINGLE_SPEND","EXCEEDS_PER_TRANSACTION_LIMIT"]}},"components/schemas/CardAuthorisationDetailsAuthorisationType":{"id":"components/schemas/CardAuthorisationDetailsAuthorisationType","kind":"json-schema","title":"CardAuthorisationDetailsAuthorisationType","data":{"type":"string","enum":["AUTHORISED","AUTHORISED_CREDIT","DECLINED","ONLINE_REVERSE","EXPIRED","MANUAL_CLOSE","CANCELLED"]}},"components/schemas/AuthRuleChecksFailedReason":{"id":"components/schemas/AuthRuleChecksFailedReason","kind":"json-schema","title":"AuthRuleChecksFailedReason","data":{"type":"string","enum":["NONE","MERCHANT_CATEGORY_NOT_IN_ALLOWED_LIST","MERCHANT_CATEGORY_BLOCKED","MERCHANT_ID_NOT_IN_ALLOWED_LIST","MERCHANT_ID_BLOCKED","ATM_NOT_ALLOWED","CONTACTLESS_NOT_ALLOWED","ECOMMERCE_NOT_ALLOWED","CASHBACK_NOT_ALLOWED","CREDIT_AUTHORISATIONS_NOT_ALLOWED","SPEND_LIMIT_EXCEEDED","MERCHANT_COUNTRY_NOT_IN_ALLOWED_LIST","MERCHANT_COUNTRY_BLOCKED","MIN_TRANSACTION_AMOUNT_EXCEEDED","MAX_TRANSACTION_AMOUNT_EXCEEDED","AUTH_FORWARDING"]}},"components/schemas/StateChangeEventType":{"id":"components/schemas/StateChangeEventType","kind":"json-schema","title":"StateChangeEventType","data":{"type":"string","enum":["ENABLED","ACTIVATED","BLOCKED","UNBLOCKED","DESTROYED"]}},"components/schemas/StateChangeState":{"id":"components/schemas/StateChangeState","kind":"json-schema","title":"StateChangeState","data":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/InstrumentState"},"blockedReason":{"$ref":"#/components/schemas/BlockedReason"},"destroyedReason":{"$ref":"#/components/schemas/DestroyedReason"}}}},"components/schemas/ManagedCardModeDetails":{"id":"components/schemas/ManagedCardModeDetails","kind":"json-schema","title":"ManagedCardModeDetails","data":{"type":"object","properties":{"prepaidModeDetails":{"$ref":"#/components/schemas/PrepaidModeDetails"},"debitModeDetails":{"$ref":"#/components/schemas/DebitModeDetails"}}}},"components/schemas/PrepaidModeDetails":{"id":"components/schemas/PrepaidModeDetails","kind":"json-schema","title":"PrepaidModeDetails","data":{"type":"object","properties":{"availableBalance":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The updated card available balance after this authorisation was processed."}}}},"components/schemas/DebitModeDetails":{"id":"components/schemas/DebitModeDetails","kind":"json-schema","title":"DebitModeDetails","data":{"type":"object","properties":{"parentManagedAccountId":{"type":"string","description":"Id of the managed account holding funds which the managed card can access, up to a configurable spend limit."},"availableToSpend":{"type":"array","description":"The amount of funds from the parent managed account that are available to be spent through the card, in a given time interval, after this transaction was performed.","items":{"type":"object","properties":{"availableAmount":{"type":"string","pattern":"^[0-9]+$","description":"The amount and currency that is available to spend, (for the given interval).","deprecated":true},"value":{"$ref":"#/components/schemas/CurrencyAmount","description":"The amount in the currency of the card."},"interval":{"$ref":"#/components/schemas/SpendLimitInterval"}}}}}}},"components/schemas/AuthForwardingDetails":{"id":"components/schemas/AuthForwardingDetails","kind":"json-schema","title":"AuthForwardingDetails","data":{"type":"object","properties":{"authForwardingTriggered":{"type":"boolean","description":"Indicates whether the authorisation forwarding was triggered or not."},"authForwardingDecisionOutcome":{"$ref":"#/components/schemas/AuthForwardingDefaultTimeoutDecision","description":"The default timeout decision outcome that was processed."},"authForwardingInnovatorTimedOut":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the authorisation forwarding was timed out while expecting a response from the Innovator’s system."},"children":[]}]}]}]}}}},"components/schemas/AuthForwardingDefaultTimeoutDecision":{"id":"components/schemas/AuthForwardingDefaultTimeoutDecision","kind":"json-schema","title":"AuthForwardingDefaultTimeoutDecision","data":{"type":"string","enum":["APPROVE","DECLINE"]}},"components/schemas/ManagedCardsAdjustmentEvent":{"id":"components/schemas/ManagedCardsAdjustmentEvent","kind":"json-schema","title":"ManagedCardsAdjustmentEvent","data":{"required":["adjustmentAmount","adjustmentType","id","owner","transactionId","transactionTimestamp"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the managed card on which a settlement has been performed."},"transactionId":{"type":"string","pattern":"^[0-9]+$","description":"The id of the transaction, for reference."},"adjustmentType":{"$ref":"#/components/schemas/CardAdjustmentDetailsAdjustmentType","description":"The type of adjustment that was processed."},"adjustmentAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The amount in the currency of the card."},"transactionTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"The timestamp of the transaction, using epoch timestamp with millisecond precision."},"availableBalance":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The updated card available balance after this adjustment was processed."},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"details":{"$ref":"#/components/schemas/ManagedCardModeDetails"}}}},"components/schemas/CardAdjustmentDetailsAdjustmentType":{"id":"components/schemas/CardAdjustmentDetailsAdjustmentType","kind":"json-schema","title":"CardAdjustmentDetailsAdjustmentType","data":{"type":"string","enum":["DEFAULT_ADJUSTMENT","LOST_STOLEN_REPLACEMENT_BALANCE_TRANSFER"]}},"components/schemas/ManagedCardsSettlementEvent":{"id":"components/schemas/ManagedCardsSettlementEvent","kind":"json-schema","title":"ManagedCardsSettlementEvent","data":{"required":["feeAmount","id","merchantData","owner","settlementType","sourceAmount","state","transactionAmount","transactionId","transactionTimestamp"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the managed card on which a settlement has been performed."},"transactionId":{"type":"string","pattern":"^[0-9]+$","description":"The id of the transaction, for reference."},"settlementType":{"$ref":"#/components/schemas/CardMerchantSettlementMerchantTransactionType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of settlement that was processed. Refer to our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.weavr.io/instruments/cards/multi-card-notifications/#card-settlements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for further information related to this field."},"children":[]}]}]}]},"transactionAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The amount in the currency of the card."},"transactionTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"The timestamp of the transaction, using epoch timestamp with millisecond precision."},"sourceAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The amount in the currency of the merchant."},"merchantData":{"$ref":"#/components/schemas/MerchantData","description":"Merchant related information"},"merchantName":{"type":"string","description":"The name of the merchant where the authorisation has been made.","deprecated":true},"merchantCategoryCode":{"type":"string","description":"The merchant category code.","deprecated":true},"merchantId":{"type":"string","description":"The merchant ID.","deprecated":true},"details":{"$ref":"#/components/schemas/ManagedCardModeDetails"},"availableBalance":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The updated card available balance after this authorisation was processed."},"relatedAuthorisationId":{"type":"string","pattern":"^[0-9]+$","description":"The related authorisation id which this settlement is clearing.","deprecated":true},"relatedSettlementId":{"type":"string","pattern":"^[0-9]+$","description":"The related settlement id.","deprecated":true},"relatedAuthorisationIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The list of related authorisation ids which this Settlement is related to."},"relatedSettlementIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The list of related settlement ids which this Settlement is related to."},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"feeAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The settlement fee, in the currency of the card."},"authCode":{"maxLength":6,"minLength":1,"type":"string","description":"The authorisation code associated with this settlement."},"state":{"$ref":"#/components/schemas/ManagedCardsSettlementEventSettlementState","description":"The state of the settlement."},"forexFee":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"The forex fee, if any, that has been included in the transactionAmount."},"merchantCountryCode":{"type":"string","description":"The merchant country code.","deprecated":true},"digitalWalletDetails":{"$ref":"#/components/schemas/DigitalWalletDetails"},"userCurrencyTransactionDetails":{"$ref":"#/components/schemas/UserCurrencyTransactionDetails","description":"The object representing the localised transaction's details"}}}},"components/schemas/CardMerchantSettlementMerchantTransactionType":{"id":"components/schemas/CardMerchantSettlementMerchantTransactionType","kind":"json-schema","title":"CardMerchantSettlementMerchantTransactionType","data":{"type":"string","enum":["SALE_PURCHASE","CASH_WITHDRAWAL","CASH_DISBURSEMENT","SALE_WITH_CASHBACK","MAIL_OR_TELEPHONE_ORDER","PURCHASE_REFUND_REVERSAL","ORIGINAL_CREDIT_TRANSACTION_REVERSAL","CASH_WITHDRAWAL_REVERSAL","PURCHASE_REFUND","PURCHASE_REVERSAL","ORIGINAL_CREDIT_TRANSACTION","ACCOUNT_FUNDING_TRANSACTION","FIRST_CHARGEBACK","FIRST_CHARGEBACK_REVERSAL","FIRST_REPRESENTMENT","FIRST_REPRESENTMENT_REVERSAL","SECOND_CHARGEBACK","SECOND_CHARGEBACK_REVERSAL","SECOND_REPRESENTMENT","ARBITRATION_CHARGEBACK","BALANCE_INQUIRY"]}},"components/schemas/ManagedCardsSettlementEventSettlementState":{"id":"components/schemas/ManagedCardsSettlementEventSettlementState","kind":"json-schema","title":"ManagedCardsSettlementEventSettlementState","data":{"type":"string","enum":["PENDING","COMPLETED"]}},"components/schemas/TransferEvent":{"id":"components/schemas/TransferEvent","kind":"json-schema","title":"TransferEvent","data":{"required":["eventType","publishedTimestamp","transfer"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/TransferEventTransferEventType"},"transfer":{"$ref":"#/components/schemas/LegacyTransfer"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/ManagedCardsExpiryAndRenewalEvent":{"id":"components/schemas/ManagedCardsExpiryAndRenewalEvent","kind":"json-schema","title":"ManagedCardsExpiryAndRenewalEvent","data":{"required":["id","eventType","state","cardType","renewalType"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the managed card on which the event occurred."},"eventType":{"$ref":"#/components/schemas/ManagedCardsExpiryAndRenewalEventType","description":"The type of event."},"state":{"$ref":"#/components/schemas/ManagedInstrumentState","description":"The state of the instrument."},"cardType":{"$ref":"#/components/schemas/CardType"},"expiryMmyy":{"description":"The end date of this card, in MMYY format.","type":"string"},"renewalType":{"$ref":"#/components/schemas/CardRenewalType","description":"Indicates how the card will be handled once it is close to expiring."},"renewalTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"The timestamp when the card will be renewed, expressed in Epoch timestamp using millisecond precision."}}}},"components/schemas/ManagedCardsExpiryAndRenewalEventType":{"id":"components/schemas/ManagedCardsExpiryAndRenewalEventType","kind":"json-schema","title":"ManagedCardsExpiryAndRenewalEventType","data":{"type":"string","enum":["CARD_ABOUT_TO_EXPIRE","CARD_EXPIRED","CARD_RENEWED"]}},"components/schemas/ManagedCardsUpgradeToPhysicalEvent":{"id":"components/schemas/ManagedCardsUpgradeToPhysicalEvent","kind":"json-schema","title":"ManagedCardsUpgradeToPhysicalEvent","data":{"required":["id","physicalCardDetails","upgradedTimestamp"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the managed card on which the event occurred."},"physicalCardDetails":{"$ref":"#/components/schemas/PhysicalCardDetails"},"upgradedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/ManagedCardsReplacementEventType":{"id":"components/schemas/ManagedCardsReplacementEventType","kind":"json-schema","title":"ManagedCardsReplacementEventType","data":{"type":"string","enum":["VIRTUAL_REPLACEMENT","PHYSICAL_REPLACEMENT"]}},"components/schemas/ManagedCardsReplacementEvent":{"id":"components/schemas/ManagedCardsReplacementEvent","kind":"json-schema","title":"ManagedCardsReplacementEvent","data":{"type":"object","required":["eventType","id","replacementReason","replacementTimestamp"],"description":"The event that is triggered when a managed card is replaced. This can be either a virtual or physical replacement.\n","properties":{"eventType":{"$ref":"#/components/schemas/ManagedCardsReplacementEventType","description":"The type of replacement event that occurred."},"id":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the managed card on which the event occurred."},"replacementId":{"$ref":"#/components/schemas/InstrumentId","description":"The id of the replacement card."},"replacementReason":{"$ref":"#/components/schemas/ReplacementType"},"replacementTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"userId":{"$ref":"#/components/schemas/UserId","description":"The id of the user linked to the managed card that was replaced."}}}},"components/schemas/ManagedCardsCardPaymentEvent":{"id":"components/schemas/ManagedCardsCardPaymentEvent","kind":"json-schema","title":"ManagedCardsCardPaymentEvent","data":{"type":"object","required":["eventType","cardPayment"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification of a CardPayment lifecycle change. The CardPayment payload"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is identical in shape to the response of GET /multi/card_payments/{id},"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carrying the current aggregate state plus the full discriminated events"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timeline. The triggering event sits at the end of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPayment.events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"eventType":{"$ref":"#/components/schemas/CardPaymentEventType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the triggering event (authorisation, settlement, refund, original credit). Combine with the trailing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPayment.events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag to distinguish reversals."},"children":[]}]}]}]},"cardPayment":{"$ref":"#/components/schemas/CardPayment"}}}},"components/schemas/TransferEventTransferEventType":{"id":"components/schemas/TransferEventTransferEventType","kind":"json-schema","title":"TransferEventTransferEventType","data":{"type":"string","enum":["PENDING","COMPLETED","FAILED","SCHEDULED","CANCELLED"]}},"components/schemas/LegacyTransfer":{"id":"components/schemas/LegacyTransfer","kind":"json-schema","title":"LegacyTransfer","data":{"required":["creationTimestamp","destination","destinationAmount","id","profileId","source","state"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringWrappedTypeId"},"profileId":{"type":"string","pattern":"^[0-9]+$"},"tag":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"source":{"$ref":"#/components/schemas/InstrumentId"},"destination":{"$ref":"#/components/schemas/InstrumentId"},"destinationAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount"},"state":{"$ref":"#/components/schemas/TransferState"},"creationTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"conflict":{"$ref":"#/components/schemas/CreateTransferConflictErrorCode"},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"},"executionTimestamp":{"$ref":"#/components/schemas/ExecutionTimestamp"}}}},"components/schemas/TransferState":{"id":"components/schemas/TransferState","kind":"json-schema","title":"TransferState","data":{"type":"string","enum":["INITIALISED","COMPLETED","REJECTED","FAILED","PENDING","SCHEDULED","CANCELLED"]}},"components/schemas/CreateTransferConflictErrorCode":{"id":"components/schemas/CreateTransferConflictErrorCode","kind":"json-schema","title":"CreateTransferConflictErrorCode","data":{"type":"string","enum":["UNDEFINED","NO_ERROR","PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","DENIED_BY_INTERCEPTOR","DENIED_BY_INSTRUMENT","DENIED_BY_FOREX_TRADE","CURRENCY_MISMATCH","INSUFFICIENT_FUNDS","SYSTEM_ERROR","SOURCE_NOT_FOUND","DESTINATION_NOT_FOUND","FEE_NOT_CONFIGURED_FOR_CURRENCY","DESTINATION_LIMIT_EXCEEDED","TRANSFER_BETWEEN_INSTRUMENTS_UNSUPPORTED","SOURCE_INSTRUMENT_BLOCKED","DESTINATION_INSTRUMENT_BLOCKED","INVALID_AMOUNT","SCHEDULED_TIMESTAMP_INVALID"]}},"components/schemas/SendEvent":{"id":"components/schemas/SendEvent","kind":"json-schema","title":"SendEvent","data":{"required":["eventType","publishedTimestamp","send"],"type":"object","properties":{"eventType":{"$ref":"#/components/schemas/SendEventSendEventType"},"send":{"$ref":"#/components/schemas/LegacySend"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$"}}}},"components/schemas/SendEventSendEventType":{"id":"components/schemas/SendEventSendEventType","kind":"json-schema","title":"SendEventSendEventType","data":{"type":"string","enum":["PENDING","COMPLETED","FAILED","PENDING_CHALLENGE","INVALID","SCHEDULED","CANCELLED"]}},"components/schemas/LegacySend":{"id":"components/schemas/LegacySend","kind":"json-schema","title":"LegacySend","data":{"required":["creationTimestamp","destination","destinationAmount","id","profileId","source","state","transactionAmount"],"type":"object","properties":{"beneficiaryId":{"type":"string","pattern":"^[0-9]+$"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"},"challengeExemptionReason":{"$ref":"#/components/schemas/ChallengeExemptionReason"},"conflict":{"$ref":"#/components/schemas/CreateSendConflictErrorCode"},"creationTimestamp":{"type":"string","pattern":"^[0-9]+$"},"description":{"type":"string","maxLength":255,"pattern":"^[a-zA-Z0-9\\/\\-?:().$_,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":"The description details that are included in the transaction as reference."},"destination":{"$ref":"#/components/schemas/InstrumentId"},"destinationAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount"},"destinationFee":{"allOf":[{"$ref":"#/components/schemas/LegacyCurrencyAmount"},{"type":"object","description":"The fee applied to the destination."}]},"executionTimestamp":{"$ref":"#/components/schemas/ExecutionTimestamp"},"id":{"$ref":"#/components/schemas/StringWrappedTypeId"},"profileId":{"type":"string","pattern":"^[0-9]+$"},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"source":{"$ref":"#/components/schemas/InstrumentId"},"sourceFee":{"allOf":[{"$ref":"#/components/schemas/LegacyCurrencyAmount"},{"type":"object","description":"The fee applied to the source."}]},"state":{"$ref":"#/components/schemas/SendState"},"tag":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"transactionAmount":{"allOf":[{"$ref":"#/components/schemas/LegacyCurrencyAmount"},{"type":"object","description":"The original transaction amount before any fees were deducted."}]}}}},"components/schemas/SendState":{"id":"components/schemas/SendState","kind":"json-schema","title":"SendState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the send transaction, as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INITIALISED: The initial state of a send transaction when SCA is not required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CHALLENGE: The send transaction requires verification before it can be initialised. Use the /sends/{id}/challenges/otp/{channel} API endpoint to start the verification process."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING:  The transaction has exceeded the destination limit and is pending treasury approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPROVED: The send transaction was approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: The send transaction has been completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The send transaction was rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED: There was an issue with the send transaction, and the transaction has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULED: The send transaction will execute at the scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: The scheduled send transaction has been cancelled."},"children":[]}]}]}]}],"enum":["UNDEFINED","INITIALISED","COMPLETED","REJECTED","FAILED","PENDING","PENDING_CHALLENGE","APPROVED","INVALID","SCHEDULED","CANCELLED"]}},"components/schemas/ChallengeExemptionReason":{"id":"components/schemas/ChallengeExemptionReason","kind":"json-schema","title":"ChallengeExemptionReason","data":{"type":"string","enum":["NO_EXEMPTION","LOW_VALUE","NOT_ENABLED","TRUSTED_BENEFICIARY"],"description":"The Reason the transaction was exempted from SCA verification"}},"components/schemas/CreateSendConflictErrorCode":{"id":"components/schemas/CreateSendConflictErrorCode","kind":"json-schema","title":"CreateSendConflictErrorCode","data":{"type":"string","enum":["NO_ERROR","PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","DENIED_BY_INTERCEPTOR","DENIED_BY_INSTRUMENT","DENIED_BY_FOREX_TRADE","CURRENCY_MISMATCH","SOURCE_NOT_FOUND","DESTINATION_NOT_FOUND","FEE_NOT_CONFIGURED_FOR_CURRENCY","DESTINATION_LIMIT_EXCEEDED","SEND_TO_INSTRUMENT_UNSUPPORTED","INSUFFICIENT_FUNDS","SOURCE_INSTRUMENT_BLOCKED","DESTINATION_INSTRUMENT_BLOCKED","INVALID_AMOUNT","IDENTITY_KYC_LEVEL_STEPUP_REQUIRED","PROFILE_NOT_FOUND","SCHEDULED_TIMESTAMP_INVALID"]}},"components/schemas/OutgoingWireTransferEvent":{"id":"components/schemas/OutgoingWireTransferEvent","kind":"json-schema","title":"OutgoingWireTransferEvent","data":{"required":["owner","eventType","publishedTimestamp","transfer"],"type":"object","properties":{"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"transfer":{"$ref":"#/components/schemas/LegacyOutgoingWireTransfer"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"eventType":{"$ref":"#/components/schemas/OutgoingWireTransferEventType"}}}},"components/schemas/LegacyOutgoingWireTransfer":{"id":"components/schemas/LegacyOutgoingWireTransfer","kind":"json-schema","title":"LegacyOutgoingWireTransfer","data":{"required":["creationTimestamp","destination","id","profileId","source","state","transactionAmount","type"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/StringWrappedTypeId"},"profileId":{"type":"string","pattern":"^[0-9]+$"},"tag":{"maxLength":50,"pattern":"^$|^[a-zA-Z0-9_-]+$","type":"string"},"source":{"$ref":"#/components/schemas/InstrumentId"},"transferAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount"},"description":{"maxLength":50,"type":"string"},"type":{"$ref":"#/components/schemas/OutgoingWireTransferType"},"destination":{"$ref":"#/components/schemas/Destination"},"externalAccountId":{"$ref":"#/components/schemas/ExternalAccountId"},"beneficiaryId":{"type":"string","pattern":"^$|^[0-9]+$"},"state":{"$ref":"#/components/schemas/OutgoingWireTransferState"},"challengeExemptionReason":{"$ref":"#/components/schemas/ChallengeExemptionReason"},"creationTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"transactionAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount"},"transactionFee":{"$ref":"#/components/schemas/LegacyCurrencyAmount","description":"Any fee amount taken with the OWT"},"conflict":{"$ref":"#/components/schemas/OWTConflictErrorCode"},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"},"executionTimestamp":{"$ref":"#/components/schemas/ExecutionTimestamp"},"validationOutcomes":{"type":"array","items":{"$ref":"#/components/schemas/OutgoingWireTransferValidationOutcome"}}}}},"components/schemas/OWTConflictErrorCode":{"id":"components/schemas/OWTConflictErrorCode","kind":"json-schema","title":"OWTConflictErrorCode","data":{"type":"string","enum":["UNDEFINED","NO_ERROR","PROFILE_INACTIVE","MODEL_CONSTRAINTS_VIOLATED","DENIED_BY_INTERCEPTOR","DENIED_BY_INSTRUMENT","UNSUPPORTED_CURRENCY","INVALID_AMOUNT","INSUFFICIENT_FUNDS","SOURCE_NOT_FOUND","SOURCE_INSTRUMENT_BLOCKED","FEE_NOT_CONFIGURED_FOR_CURRENCY","TYPE_NOT_SUPPORTED_BY_PROFILE","SOURCE_INSTRUMENT_DESTROYED","IDENTITY_KYC_LEVEL_STEPUP_REQUIRED","CURRENCY_MISMATCH","BENEFICIARY_NOT_FOUND","BENEFICIARY_TYPE_INVALID","PROFILE_NOT_FOUND","SCHEDULED_TIMESTAMP_INVALID","BENEFICIARY_BANK_DETAILS_INVALID","PROVIDER_ERROR","SOURCE_HAS_NO_ACCESS_INSTRUMENT","EXTERNAL_DESTINATION_ACCOUNT_NOT_FOUND"]}},"components/schemas/Destination":{"id":"components/schemas/Destination","kind":"json-schema","title":"Destination","data":{"required":["beneficiaryName"],"type":"object","properties":{"beneficiaryName":{"maxLength":100,"type":"string","pattern":"^$|^.*$","description":"The name of the beneficiary"},"beneficiaryAddress":{"maxLength":150,"type":"string","pattern":"^$|^.*$","description":"The beneficiary address"},"beneficiaryBankName":{"maxLength":150,"type":"string","pattern":"^$|^.*$","description":"The name of the beneficiary bank"},"beneficiaryBankAddress":{"maxLength":150,"type":"string","pattern":"^$|^.*$","description":"The beneficiary bank address"},"beneficiaryBankCountry":{"maxLength":2,"pattern":"^$|^[A-Z]+$","type":"string","description":"The beneficiary bank country - using ISO 3166 alpha-2"},"beneficiaryAccountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of beneficiary account. Required only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetailsOrBACSBankDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are specified"},"children":[]}]}]}],"enum":["PERSONAL","BUSINESS"]},"beneficiaryNationality":{"$ref":"#/components/schemas/Nationality"},"beneficiaryDateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"},"sepa":{"$ref":"#/components/schemas/IBANDetails"},"fasterPayments":{"$ref":"#/components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails"},"swift":{"required":["iban","swift"],"type":"object","properties":{"iban":{"type":"string"},"swift":{"type":"string"}}}}}},"components/schemas/SwiftBeneficiary":{"id":"components/schemas/SwiftBeneficiary","kind":"json-schema","title":"SwiftBeneficiary","data":{"required":["name","iban","bankIdentifierCode","purpose"],"type":"object","description":"Beneficiary details for SWIFT wire transfers.","properties":{"name":{"type":"string","minLength":1,"maxLength":150,"description":"The beneficiary's full name."},"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SWIFT."},"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/SWIFT code, identifying a particular bank or branch, required for wire transfer over SWIFT."},"purpose":{"type":"string","maxLength":255,"description":"The purpose of the payment."},"address":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's address."},"bankName":{"type":"string","description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/OutgoingWireTransferEventType":{"id":"components/schemas/OutgoingWireTransferEventType","kind":"json-schema","title":"OutgoingWireTransferEventType","data":{"type":"string","enum":["PENDING_CHALLENGE","SUBMITTED","APPROVED","REJECTED","FAILED","COMPLETED","RETURNED","INVALID","SCHEDULED","CANCELLED","PENDING_CONFIRMATION"]}},"components/schemas/CorrespondentBankTransferEvent":{"id":"components/schemas/CorrespondentBankTransferEvent","kind":"json-schema","title":"CorrespondentBankTransferEvent","data":{"required":["owner","eventType","publishedTimestamp","transfer"],"type":"object","properties":{"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"transfer":{"$ref":"#/components/schemas/CorrespondentBankingOwt"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"eventType":{"$ref":"#/components/schemas/CorrespondentBankTransferEventType"}}}},"components/schemas/CorrespondentBankTransferEventType":{"id":"components/schemas/CorrespondentBankTransferEventType","kind":"json-schema","title":"CorrespondentBankTransferEventType","data":{"type":"string","enum":["PENDING_CHALLENGE","SUBMITTED","APPROVED","REJECTED","FAILED","COMPLETED","RETURNED","INVALID","SCHEDULED","CANCELLED","PENDING_CONFIRMATION"]}},"components/schemas/ManualTransactionEvent":{"id":"components/schemas/ManualTransactionEvent","kind":"json-schema","title":"ManualTransactionEvent","data":{"required":["targetInstrument","transactionId","transactionTimestamp"],"type":"object","properties":{"transactionId":{"type":"string","pattern":"^[0-9]+$","description":"Id of the transaction."},"targetInstrument":{"$ref":"#/components/schemas/InstrumentId","description":"Id of the instrument on which the manual operation was performed."},"availableBalanceAdjustment":{"type":"string","pattern":"^[0-9]+$","description":"The amount credited or debited on the available balance of the instrument."},"actualBalanceAdjustment":{"type":"string","pattern":"^[0-9]+$","description":"The amount credited or debited on the actual balance of the instrument."},"transactionTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"The timestamp when the transaction was processed by the system, expressed in Epoch timestamp using millisecond precision."},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"}}}},"components/schemas/ChargeFeeEvent":{"id":"components/schemas/ChargeFeeEvent","kind":"json-schema","title":"ChargeFeeEvent","data":{"required":["chargeFee","publishedTimestamp","type"],"type":"object","properties":{"chargeFee":{"type":"object","required":["feeSpec","feeType","id","source"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"feeType":{"$ref":"#/components/schemas/FeeType"},"feeSubType":{"maxLength":50,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional sub fee type value (e.g. PRINTED_STATEMENT)"},"children":[]}]}]}]},"note":{"type":"string","description":"Note added to the transaction and visible in the statements as an additional field"},"source":{"$ref":"#/components/schemas/InstrumentId"},"feeSpec":{"$ref":"#/components/schemas/LegacyFeeSpec"},"batch":{"$ref":"#/components/schemas/LegacyTransactionBatch","description":"The transaction batch if a transaction was executed for the charge"},"profileId":{"type":"string"}}},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"type":{"$ref":"#/components/schemas/ChargeFeeEventType"}}}},"components/schemas/ChargeFeeEventType":{"id":"components/schemas/ChargeFeeEventType","kind":"json-schema","title":"ChargeFeeEventType","data":{"type":"string","enum":["UNDEFINED","COMPLETED"]}},"components/schemas/LegacyFeeSpec":{"id":"components/schemas/LegacyFeeSpec","kind":"json-schema","title":"LegacyFeeSpec","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/FeeSpecType"},"flatAmount":{"type":"array","description":"The flat fee amounts to be taken per currency. Required for FLAT, MAX, MIN and PLUS fee types.","items":{"$ref":"#/components/schemas/LegacyCurrencyAmount"}},"percentage":{"$ref":"#/components/schemas/LegacyScaledAmount","description":"The percentage amount to be taken as a fee. Required for PERCENTAGE, MAX, MIN and PLUS fee types."}}}},"components/schemas/LegacyScaledAmount":{"id":"components/schemas/LegacyScaledAmount","kind":"json-schema","title":"LegacyScaledAmount","data":{"type":"object","properties":{"value":{"type":"string","pattern":"^[0-9]+$"},"scale":{"maximum":127,"minimum":-128,"type":"integer","format":"int32"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value * pow(10, -scale)."},"children":[]}]}]}]}},"components/schemas/LegacyTransactionBatch":{"id":"components/schemas/LegacyTransactionBatch","kind":"json-schema","title":"LegacyTransactionBatch","data":{"required":["id","instrument","state","transaction"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"transaction":{"$ref":"#/components/schemas/StringWrappedTypeId"},"relatedBatchId":{"type":"string","pattern":"^[0-9]+$"},"intercept":{"type":"array","items":{"$ref":"#/components/schemas/TransactionBatchIntercept"}},"instrument":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LegacyTransactionBatchInstrument"},"description":"The id of the map should be the instrument id"},"forexTrade":{"type":"array","items":{"$ref":"#/components/schemas/LegacyTransactionBatchForexTrade"}},"completedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"state":{"$ref":"#/components/schemas/TransactionBatchState"},"conflict":{"$ref":"#/components/schemas/TransactionBatchErrorType"},"authSessionId":{"type":"string","pattern":"^[0-9]+$"},"note":{"type":"string"}}}},"components/schemas/LegacyTransactionBatchInstrument":{"id":"components/schemas/LegacyTransactionBatchInstrument","kind":"json-schema","title":"LegacyTransactionBatchInstrument","data":{"required":["id","instrument","instrumentId","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"instrumentId":{"$ref":"#/components/schemas/InstrumentId"},"instrument":{"$ref":"#/components/schemas/LegacyInstrumentParticipant"},"state":{"$ref":"#/components/schemas/TransactionBatchParticipantState"},"conflict":{"$ref":"#/components/schemas/InstrumentParticipantErrorType"},"after":{"$ref":"#/components/schemas/LegacyInstrumentBalances"},"executedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"remaining":{"$ref":"#/components/schemas/LegacyTransactionBatchInstrumentRemaining"},"afterCompensation":{"$ref":"#/components/schemas/LegacyInstrumentBalances"},"compensatedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"treasuryPending":{"type":"boolean"}}}},"components/schemas/LegacyInstrumentParticipant":{"id":"components/schemas/LegacyInstrumentParticipant","kind":"json-schema","title":"LegacyInstrumentParticipant","data":{"required":["channelProvider","currency","fiProvider","owner"],"type":"object","properties":{"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"},"fiProvider":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"channelProvider":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"originalAmount":{"$ref":"#/components/schemas/LegacyCurrencyAmount"},"currency":{"maxLength":3,"minLength":3,"pattern":"^[A-Z]*$","type":"string"},"availableAdjustment":{"type":"string","pattern":"^[0-9]+$"},"reservedAdjustment":{"type":"string","pattern":"^[0-9]+$"},"pendingAdjustment":{"type":"string","pattern":"^[0-9]+$"},"availableSync":{"type":"string","pattern":"^[0-9]+$"},"deltaAdjustment":{"type":"string","pattern":"^[0-9]+$"},"limitAdjustment":{"type":"string","pattern":"^[0-9]+$"},"fee":{"type":"object","additionalProperties":{"type":"object","properties":{"amount":{"type":"string","pattern":"^[0-9]+$"},"feeSpecificType":{"type":"string"}}}},"system":{"type":"object","additionalProperties":{"type":"string","pattern":"^[0-9]+$"}},"create":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set, expects runtime_info to contain creation payload"},"children":[]}]}]}]},"upgrade":{"type":"boolean"},"activate":{"type":"boolean"},"blockType":{"$ref":"#/components/schemas/BlockedDetailsType"},"blockSubType":{"$ref":"#/components/schemas/BlockedDetailsSubType"},"unblockType":{"$ref":"#/components/schemas/BlockedDetailsType"},"unblockSubType":{"$ref":"#/components/schemas/BlockedDetailsSubType"},"destroyType":{"$ref":"#/components/schemas/DestroyType"},"replacementType":{"$ref":"#/components/schemas/ReplacementType"},"related":{"type":"boolean"},"forceState":{"type":"boolean","description":"If set, force the action bypassing system blocks"},"forceBalance":{"type":"boolean","description":"If set, force the action bypassing balance limits"}}}},"components/schemas/LegacyTransactionBatchForexTrade":{"id":"components/schemas/LegacyTransactionBatchForexTrade","kind":"json-schema","title":"LegacyTransactionBatchForexTrade","data":{"required":["forexTrade","id"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"forexTrade":{"$ref":"#/components/schemas/LegacyForexTradeParticipant"},"state":{"$ref":"#/components/schemas/TransactionBatchParticipantState"},"conflict":{"$ref":"#/components/schemas/ForexTradeParticipantErrorType"},"executedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"compensatedRateId":{"type":"string","pattern":"^[0-9]+$"},"sourceSystemCompensation":{"type":"string","pattern":"^[0-9]+$","description":"The difference between the source and the actual compensation amount, may be positive (profit) or negative (loss)"},"compensatedRate":{"$ref":"#/components/schemas/LegacyScaledAmount","description":"The compensation forex rate between unscaled amount of given currencies"},"compensatedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/LegacyInstrumentBalances":{"id":"components/schemas/LegacyInstrumentBalances","kind":"json-schema","title":"LegacyInstrumentBalances","data":{"type":"object","properties":{"availableBalance":{"type":"string","pattern":"^[0-9]+$"},"reservedBalance":{"type":"string","pattern":"^[0-9]+$"},"deltaBalance":{"type":"string","pattern":"^[0-9]+$"},"pendingBalance":{"type":"string","pattern":"^[0-9]+$"},"limitBalance":{"type":"string","pattern":"^[0-9]+$"}}}},"components/schemas/LegacyTransactionBatchInstrumentRemaining":{"id":"components/schemas/LegacyTransactionBatchInstrumentRemaining","kind":"json-schema","title":"LegacyTransactionBatchInstrumentRemaining","data":{"type":"object","properties":{"availableRemaining":{"type":"string","pattern":"^[0-9]+$"},"reservedRemaining":{"type":"string","pattern":"^[0-9]+$"},"pendingRemaining":{"type":"string","pattern":"^[0-9]+$"},"feeRemaining":{"type":"object","additionalProperties":{"type":"string","pattern":"^[0-9]+$"}}}}},"components/schemas/LegacyForexTradeParticipant":{"id":"components/schemas/LegacyForexTradeParticipant","kind":"json-schema","title":"LegacyForexTradeParticipant","data":{"required":["provider","rate","rateId","sourceCurrency","targetCurrency"],"type":"object","properties":{"rateId":{"type":"string","pattern":"^[0-9]+$"},"provider":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"sourceCurrency":{"maxLength":3,"minLength":3,"pattern":"^[A-Z]*$","type":"string"},"sourceAmount":{"type":"string","pattern":"^[0-9]+$"},"sourceSystem":{"type":"string","pattern":"^[0-9]+$","description":"The rounding error when aggregating multiple conversions. Always positive"},"targetCurrency":{"maxLength":3,"minLength":3,"pattern":"^[A-Z]*$","type":"string"},"targetAmount":{"type":"string","pattern":"^[0-9]+$"},"rate":{"$ref":"#/components/schemas/LegacyScaledAmount","description":"The forex rate between unscaled amount of given currencies"}}}},"components/schemas/LoginEvent":{"id":"components/schemas/LoginEvent","kind":"json-schema","title":"LoginEvent","data":{"required":["credential","publishedTimestamp","status","type"],"type":"object","properties":{"credential":{"$ref":"#/components/schemas/CredentialId"},"identity":{"$ref":"#/components/schemas/StringWrappedTypeId"},"type":{"type":"string","description":"Login type can be with password or with auth/access token"},"status":{"$ref":"#/components/schemas/LoginEventLoginEventStatus"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/LoginEventLoginEventStatus":{"id":"components/schemas/LoginEventLoginEventStatus","kind":"json-schema","title":"LoginEventLoginEventStatus","data":{"type":"string","enum":["VERIFIED","DECLINED","EXPIRED"]}},"components/schemas/StepupEvent":{"id":"components/schemas/StepupEvent","kind":"json-schema","title":"StepupEvent","data":{"required":["challengeId","credential","identity","publishedTimestamp","status","type"],"type":"object","properties":{"credential":{"$ref":"#/components/schemas/CredentialId"},"identity":{"$ref":"#/components/schemas/StringWrappedTypeId"},"challengeId":{"type":"string","pattern":"^[0-9]+$"},"type":{"type":"string"},"status":{"$ref":"#/components/schemas/StepupEventEventStatus"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"authToken":{"type":"string"}}}},"components/schemas/StepupEventEventStatus":{"id":"components/schemas/StepupEventEventStatus","kind":"json-schema","title":"StepupEventEventStatus","data":{"type":"string","enum":["VERIFIED","DECLINED","EXPIRED"]}},"components/schemas/EnrolmentEvent":{"id":"components/schemas/EnrolmentEvent","kind":"json-schema","title":"EnrolmentEvent","data":{"required":["credentialId","publishedTimestamp","status","type"],"type":"object","properties":{"credentialId":{"$ref":"#/components/schemas/CredentialId"},"type":{"type":"string"},"status":{"$ref":"#/components/schemas/EnrolmentEventEnrolmentStatus"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."}}}},"components/schemas/EnrolmentEventEnrolmentStatus":{"id":"components/schemas/EnrolmentEventEnrolmentStatus","kind":"json-schema","title":"EnrolmentEventEnrolmentStatus","data":{"type":"string","enum":["ACTIVE","INACTIVE"]}},"components/schemas/BeneficiaryBatchEvent":{"id":"components/schemas/BeneficiaryBatchEvent","kind":"json-schema","title":"BeneficiaryBatchEvent","data":{"required":["id","operation","eventType","publishedTimestamp","beneficiaries"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"operation":{"$ref":"#/components/schemas/BeneficiaryBatchOperation"},"tag":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"publishedTimestamp":{"type":"string","pattern":"^[0-9]+$","description":"Epoch timestamp using millisecond precision."},"eventType":{"$ref":"#/components/schemas/BeneficiaryBatchEventType"},"beneficiaries":{"type":"array","items":{"$ref":"#/components/schemas/LegacyBeneficiary"}}}}},"components/schemas/BeneficiaryBatchEventType":{"id":"components/schemas/BeneficiaryBatchEventType","kind":"json-schema","title":"BeneficiaryBatchEventType","data":{"type":"string","enum":["INITIALISED","FAILED","PENDING_CHALLENGE","CHALLENGE_FAILED","CHALLENGE_COMPLETED"]}},"components/schemas/LegacyBeneficiary":{"id":"components/schemas/LegacyBeneficiary","kind":"json-schema","title":"LegacyBeneficiary","data":{"required":["trustLevel","id","beneficiaryInformation","beneficiaryDetails","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"externalRefs":{"type":"array","items":{"type":"string"}},"group":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"trustLevel":{"$ref":"#/components/schemas/BeneficiaryTrustLevel"},"beneficiaryInformation":{"type":"object","properties":{"businessBeneficiaryType":{"$ref":"#/components/schemas/BusinessBeneficiaryType"},"consumerBeneficiaryType":{"$ref":"#/components/schemas/ConsumerBeneficiaryType"}}},"beneficiaryDetails":{"type":"object","properties":{"instrumentDetailsBeneficiary":{"$ref":"#/components/schemas/InstrumentDetailsBeneficiary"},"bankAccountDetailsBeneficiary":{"$ref":"#/components/schemas/LegacyBankAccountDetailsBeneficiary"}}},"state":{"$ref":"#/components/schemas/BeneficiaryState"},"validationFailure":{"$ref":"#/components/schemas/BeneficiaryValidationFailure"}}}},"components/schemas/LegacyBankAccountDetailsBeneficiary":{"id":"components/schemas/LegacyBankAccountDetailsBeneficiary","kind":"json-schema","title":"LegacyBankAccountDetailsBeneficiary","data":{"type":"object","properties":{"beneficiaryName":{"maxLength":100,"minLength":1,"type":"string","description":"The name of the beneficiary"},"address":{"maxLength":150,"type":"string","description":"The beneficiary address"},"bankName":{"maxLength":150,"type":"string","description":"The name of the beneficiary bank"},"bankAddress":{"maxLength":150,"type":"string","description":"The beneficiary bank address"},"bankCountry":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"The beneficiary bank country - using ISO 3166 alpha-2"},"sepaBankDetails":{"$ref":"#/components/schemas/IBANDetails"},"fasterPaymentsBankDetails":{"$ref":"#/components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails"}}}},"components/schemas/BulkProcessProgressEvent":{"id":"components/schemas/BulkProcessProgressEvent","kind":"json-schema","title":"BulkProcessProgressEvent","data":{"type":"object","properties":{"bulkId":{"description":"The bulk id of the bulk process","type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"RUNNING\"  : the execution of the bulk process is in progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"COMPLETED\"  : the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully. This is a final state for the bulk process"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"PARTIALLY_COMPLETED\" : the execution of the bulk process is complete and some of the bulk operations of the bulk process failed. This is a final state for the bulk process"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"FAILED\" : none of the operations of the bulk process have executed. This is a final state for the bulk process"},"children":[]}]}]}],"$ref":"#/components/schemas/BulkProcessProgressStatus"},"submittedItemsCount":{"description":"The number of bulk operations in the bulk process","type":"integer"},"operationStatusCounts":{"type":"array","items":{"$ref":"#/components/schemas/BulkProcessOperationStatusCounts"}}}}},"components/schemas/KycLevel":{"id":"components/schemas/KycLevel","kind":"json-schema","title":"KycLevel","data":{"deprecated":true,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The KYC level, which determines what KYC information will be requested from the consumer:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC_LEVEL_1: The most basic level of KYC required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC_LEVEL_2: Full due diligence level 2"},"children":[]}]}]}]}],"enum":["KYC_LEVEL_1","KYC_LEVEL_2"]}},"components/schemas/IbanInstrument":{"id":"components/schemas/IbanInstrument","kind":"json-schema","title":"IbanInstrument","data":{"required":["id","managedAccountId","profileId","incomingWireTransferProfileId","friendlyName","currency","creationTimestamp","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of an Iban"},"managedAccountId":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the linked managed account"},"profileId":{"$ref":"#/components/schemas/ProfileId"},"incomingWireTransferProfileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"minLength":1,"maxLength":50,"type":"string","description":"The friendly name given to the iban."},"currency":{"$ref":"#/components/schemas/Currency"},"state":{"$ref":"#/components/schemas/IbanInstrumentState"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the iban was created, expressed in Epoch timestamp using millisecond precision."},"bankAccountDetails":{"description":"A list of bank account details associated with the IBAN.\nMultiple details can be provided if multiple IBAN providers are supported by your payment model.","type":"array","items":{"required":["beneficiaryNameAndSurname","beneficiaryBank","beneficiaryBankAddress","type","details"],"type":"object","properties":{"beneficiaryNameAndSurname":{"type":"string","description":"The beneficiary name and surname details to be used when initiating a deposit onto the IBAN."},"beneficiaryBank":{"type":"string","description":"The beneficiary bank name to be used when initiating a deposit onto the IBAN."},"beneficiaryBankAddress":{"type":"string","description":"The beneficiary bank address to be used when initiating a deposit onto the IBAN."},"paymentReference":{"type":"string","description":"A reference required by the partner bank to execute a deposit on the iban.\n\n\nIf provided, make sure that this is included as part of the wire transfer details when initiating a deposit.\n"},"details":{"description":"The bank details required to initiate a deposit on the managed account.\n\nThe details required to deposit on the IBAN vary depending on the wire transfer channel that will be used.\n","anyOf":[{"$ref":"#/components/schemas/IBANDetails"},{"$ref":"#/components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails"},{"$ref":"#/components/schemas/SwiftBankDetails"}]}}}}}}},"components/schemas/LinkedAccount":{"id":"components/schemas/LinkedAccount","kind":"json-schema","title":"LinkedAccount","data":{"required":["id","profileId","name","country","state"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the linked account.","pattern":"^[0-9]+$"},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"friendlyName":{"minLength":1,"maxLength":50,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A user-friendly label assigned to the Linked Account to help end-users easily identify it within the application. This name can be updated at any time using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},"name":{"minLength":1,"maxLength":100,"type":"string","description":"The full name or corporate name of the account holder as registered with the external bank or payment service provider. This is the name under which the account is officially held.\n"},"type":{"$ref":"#/components/schemas/AccountType"},"currency":{"$ref":"#/components/schemas/Currency"},"country":{"description":"The country of the bank or institution at which the account is held.","type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]+$"},"accountReference":{"description":"The IBAN or Account Number and Sort Code of the account held at the external bank or payment service provider.","oneOf":[{"$ref":"#/components/schemas/AccountNumberAndSortCode"},{"$ref":"#/components/schemas/Iban"},{"$ref":"#/components/schemas/AccountDescriptor"}]},"state":{"$ref":"#/components/schemas/LinkedAccountState"},"creationTimestamp":{"description":"The timestamp when the linked account was created, expressed in Epoch timestamp using millisecond precision.","type":"integer","format":"int64"},"owner":{"$ref":"#/components/schemas/StringWrappedTypeId"}}}},"components/schemas/InstrumentId":{"id":"components/schemas/InstrumentId","kind":"json-schema","title":"InstrumentId","data":{"required":["id","type"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"},"type":{"$ref":"#/components/schemas/InstrumentType"}}}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"type":"string","description":"The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.","maxLength":3,"minLength":3,"pattern":"^[A-Z]*$"}},"components/schemas/StringWrappedTypeId":{"id":"components/schemas/StringWrappedTypeId","kind":"json-schema","title":"StringWrappedTypeId","data":{"required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"id":{"type":"string","pattern":"^[0-9]+$"}}}},"components/schemas/BlockedDetailsType":{"id":"components/schemas/BlockedDetailsType","kind":"json-schema","title":"BlockedDetailsType","data":{"type":"string","enum":["VELOCITY","USER","ACCOUNT","ADMIN"]}},"components/schemas/TransferType":{"id":"components/schemas/TransferType","kind":"json-schema","title":"TransferType","data":{"enum":["SEPA","FASTER_PAYMENTS","SWIFT","BACS","CHAPS","RIX","TARGET"],"type":"string"}},"components/schemas/CardType":{"id":"components/schemas/CardType","kind":"json-schema","title":"CardType","data":{"enum":["VIRTUAL","PHYSICAL"],"type":"string"}},"components/schemas/CardRenewalType":{"id":"components/schemas/CardRenewalType","kind":"json-schema","title":"CardRenewalType","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates how the card will be handled once it is close to expiring."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RENEW: The card will be automatically renewed, keeping the same card number but with a new expiry date and CVV."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_RENEW: Once the expiry date is reached, the card is destroyed."},"children":[]}]}]}]}],"enum":["RENEW","NO_RENEW"],"type":"string"}},"components/schemas/MerchantData":{"id":"components/schemas/MerchantData","kind":"json-schema","title":"MerchantData","data":{"required":["merchantName","merchantCategoryCode","merchantId"],"type":"object","properties":{"merchantName":{"type":"string","description":"The name of the merchant where the authorisation has been made."},"merchantCategoryCode":{"type":"string","description":"The merchant category code."},"merchantId":{"type":"string","description":"The merchant ID."},"merchantDescription":{"type":"string","description":"The merchant description"},"merchantStreet":{"type":"string","description":"The merchant street address (if available)"},"merchantCity":{"type":"string","description":"The merchant city (if available)"},"merchantState":{"type":"string","description":"The merchant state address (if available)"},"merchantPostalCode":{"type":"string","description":"The merchant postal code (if available)"},"merchantCountry":{"type":"string","description":"The merchant country address"},"merchantTelephone":{"type":"string","description":"The merchant telephone number"},"merchantURL":{"type":"string","description":"The merchant URL"},"merchantNameOther":{"type":"string","description":"The alternative merchant name"},"merchantNetworkId":{"type":"string","description":"The merchant's network id"},"merchantContact":{"type":"string","description":"The merchant's contact (if available)"}}}},"components/schemas/AuthorisationCategory":{"id":"components/schemas/AuthorisationCategory","kind":"json-schema","title":"AuthorisationCategory","data":{"type":"string","description":"The category of the authorisation.","enum":["PRE_AUTH","FINAL_AUTH"]}},"components/schemas/CardHolderPresent":{"id":"components/schemas/CardHolderPresent","kind":"json-schema","title":"CardHolderPresent","data":{"type":"string","enum":["PRESENT","NOT_PRESENT","PRESENCE_UNKNOWN"]}},"components/schemas/DigitalWalletDetails":{"id":"components/schemas/DigitalWalletDetails","kind":"json-schema","title":"DigitalWalletDetails","data":{"type":"object","description":"Contains information about the digital wallet, if it has been used.","properties":{"digitalWalletType":{"$ref":"#/components/schemas/DigitalWalletType"}}}},"components/schemas/UserCurrencyTransactionDetails":{"id":"components/schemas/UserCurrencyTransactionDetails","kind":"json-schema","title":"UserCurrencyTransactionDetails","data":{"required":["userTransactionAmount","userExchangeRate"],"type":"object","properties":{"userTransactionAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"type":"string"}},"description":"The object representing the user transaction's currency, amount and rate."}},"components/schemas/CardAuthorisationDetailsTransactionType":{"id":"components/schemas/CardAuthorisationDetailsTransactionType","kind":"json-schema","title":"CardAuthorisationDetailsTransactionType","data":{"enum":["SALE_PURCHASE","MAIL_OR_TELEPHONE_ORDER","CASH_WITHDRAWAL","ORIGINAL_CREDIT_TRANSACTION","ACCOUNT_FUNDING_TRANSACTION","CASH_DISBURSEMENT","PURCHASE_REFUND","BALANCE_INQUIRY","PIN_CHANGE","PIN_UNBLOCK"],"type":"string"}},"components/schemas/InstrumentState":{"id":"components/schemas/InstrumentState","kind":"json-schema","title":"InstrumentState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the instrument indicating what it can and cannot do as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE: The instrument is in an active state and can be used in transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blockedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides more information as to why it was blocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESTROYED: The instrument has been permanently destroyed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destroyReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides more information as to why it was destroyed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOT_ENABLED: The instrument is not enabled for use, since the linked user has not completed all necessary verification steps."},"children":[]}]}]}]}],"enum":["ACTIVE","BLOCKED","DESTROYED","NOT_ENABLED"]}},"components/schemas/BlockedReason":{"id":"components/schemas/BlockedReason","kind":"json-schema","title":"BlockedReason","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the instrument has been blocked:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USER: The root, or an authorised user, of the identity owning the instrument has temporarily blocked the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SYSTEM: The platform or an administrator of the platform has temporarily blocked the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOST: The instrument has been blocked because it was marked as lost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_SPEND: The instrument has been automatically blocked after its first successful transaction (single-spend card)."},"children":[]}]}]}]}],"enum":["USER","SYSTEM","LOST","SINGLE_SPEND"]}},"components/schemas/DestroyedReason":{"id":"components/schemas/DestroyedReason","kind":"json-schema","title":"DestroyedReason","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the instrument has been destroyed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SYSTEM: The platform or an administrator of the platform has destroyed the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USER: The root, or an authorised user, of the identity owning the instrument has destroyed the instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOST: The instrument was automatically destroyed as it was marked as lost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"STOLEN: The instrument was automatically destroyed as it was marked as stolen."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED: The instrument was automatically destroyed as it expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPROMISED: The instrument was automatically destroyed as it was marked as compromised."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SINGLE_SPEND: The instrument was automatically destroyed as it was a single-spend card that was used."},"children":[]}]}]}]}],"enum":["SYSTEM","USER","LOST","STOLEN","EXPIRED","COMPROMISED","SINGLE_SPEND"]}},"components/schemas/CurrencyAmount":{"id":"components/schemas/CurrencyAmount","kind":"json-schema","title":"CurrencyAmount","data":{"required":["currency","amount"],"type":"object","properties":{"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"integer","format":"int64","description":"The monetary amount, scaled to the lowest denomination of the currency.\n\nExample, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.\n"}},"description":"The object representing a monetary amount in a particular currency."}},"components/schemas/SpendLimitInterval":{"id":"components/schemas/SpendLimitInterval","kind":"json-schema","title":"SpendLimitInterval","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time period for which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spendLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAILY: starting from 00:00:00 UTC of current day to 23:59:59 UTC of current day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WEEKLY: 00:00:00 UTC Monday of current week to following Sunday 23:59:59 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MONTHLY: 1st of current calendar month to end of current calendar month"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUARTERLY: starting from beginning of current quarter where quarters are defined as follows:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 January 00:00:00 UTC to 31 March 23:59:59 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 April 00:00:00 UTC to 30 Jun 23:59:59 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 July 00:00:00 UTC to 30 September 23:59:59 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 October 00:00:00 UTC to 31 December 23:59:59 UTC"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YEARLY: 1 January 00:00:00 UTC of current calendar year to 31 December 23:59:59 UTC of current calendar year."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALWAYS: This indicates that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"spendLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the total amount that can be spent through the card throughout the whole lifetime of the card."},"children":[]}]}]}]}]}],"type":"string","enum":["DAILY","WEEKLY","MONTHLY","QUARTERLY","YEARLY","ALWAYS"]}},"components/schemas/ManagedInstrumentState":{"id":"components/schemas/ManagedInstrumentState","kind":"json-schema","title":"ManagedInstrumentState","data":{"required":["state"],"type":"object","properties":{"state":{"$ref":"#/components/schemas/InstrumentState"},"blockedReason":{"$ref":"#/components/schemas/BlockedReason"},"destroyedReason":{"$ref":"#/components/schemas/DestroyedReason"}}}},"components/schemas/PhysicalCardDetails":{"id":"components/schemas/PhysicalCardDetails","kind":"json-schema","title":"PhysicalCardDetails","data":{"required":["pendingActivation"],"type":"object","properties":{"bulkDelivery":{"$ref":"#/components/schemas/BulkCardDelivery"},"productReference":{"type":"string","description":"The unique reference indicating the configuration of the physical card. Example the card design."},"carrierType":{"type":"string"},"pendingActivation":{"type":"boolean","description":"Indicates if the physical card is activated for physical usage such as with physical terminals."},"pinBlocked":{"type":"boolean","description":"Indicates if the physical card is blocked due to providing incorrect PINs."},"manufacturingState":{"$ref":"#/components/schemas/ManufacturingState"},"replacement":{"deprecated":true,"type":"object","description":"Indicates if the physical card is replaced by another card.","properties":{"replacementReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the physical card was replaced."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAMAGED: The physical card was damaged and cannot be used at a physical terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOST_STOLEN: The physical card was either lost or stolen and cannot be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED: The physical card expired."},"children":[]}]}]}]}],"enum":["DAMAGED","LOST_STOLEN","EXPIRED"]},"replacementId":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the new card that replaces this card."}}},"deliveryAddress":{"$ref":"#/components/schemas/DeliveryAddress"},"deliveryMethod":{"$ref":"#/components/schemas/DeliveryMethod"},"deliveryTrackingCode":{"$ref":"#/components/schemas/DeliveryTrackingCode"},"deliveryTrackingMethod":{"$ref":"#/components/schemas/DeliveryTrackingMethod"},"deliveryTrackingUrl":{"$ref":"#/components/schemas/DeliveryTrackingUrl"},"nameOnCardLine2":{"deprecated":true,"maxLength":27,"pattern":"^[a-zA-Z0-9ßÀÁÂÃÄÅǍÆÇÈÉÊËÌÍÎÏÒÓÔÕÖØŠÙÚÛÜŸÝĄĆČĎĘĹĽŁŃŇÑŐŔŚȘȚŤŰŹŻŽàáâãäåǎæçèéêëìíîïòóôõöøšùúûüÿýąćčďęĺľłńňñőŕśșțťűźżž\\-^. '-]*$","type":"string","description":"Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards. This field is deprecated"}}}},"components/schemas/ReplacementType":{"id":"components/schemas/ReplacementType","kind":"json-schema","title":"ReplacementType","data":{"type":"string","enum":["DAMAGED","LOST_STOLEN","RENEW","COMPROMISED"]}},"components/schemas/UserId":{"id":"components/schemas/UserId","kind":"json-schema","title":"UserId","data":{"type":"string","pattern":"^[0-9]+$"}},"components/schemas/CardPaymentEventType":{"id":"components/schemas/CardPaymentEventType","kind":"json-schema","title":"CardPaymentEventType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of event recorded against a CardPayment. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag on each event distinguishes a reversal from the original action."},"children":[]}]}]}],"enum":["AUTHORISATION","SETTLEMENT","REFUND","ORIGINAL_CREDIT"]}},"components/schemas/CardPayment":{"id":"components/schemas/CardPayment","kind":"json-schema","title":"CardPayment","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One card transaction's full lifecycle — authorisation, settlement, refunds — as a single resource that the platform keeps up to date as scheme events arrive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Designed for two audiences:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Building UI?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Read the top-level summary fields ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). They are platform-maintained — show them as-is. No need to understand auth-vs-clearing, reversals, or scheme messages. The debit/credit direction is implicit from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (purchases / cash withdrawals / account funding debit the card; refunds / original credits credit it). For the issuer authorisation code, walk "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — every event in the lifecycle carries it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Need scheme-level detail?"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Walk "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full per-step audit trail — every authorisation, clearing, reversal, and refund step — with original scheme amounts (merchant + card currency, with exchange rates), reason codes, and fees attached to the event that triggered them."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each card payment corresponds to one card-scheme lifecycle (Visa Transaction Identifier / Mastercard TLID). Related-but-separate transactions (refunds, tips, recurring follow-ups) are separate card payments linked via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedCardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (direct parent)."},"children":[]}]}]}],"required":["id","type","card","merchant","displayAmount","status","events","creationTimestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"Stable identifier across the entire payment lifecycle."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The high-level type of card payment. For finer-grained classification (e.g. distinguishing a sale-purchase from a sale with cashback), see the per-event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subtype"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"$ref":"#/components/schemas/CardPaymentType"},"card":{"description":"The managed card used for this payment.","$ref":"#/components/schemas/Card"},"merchant":{"$ref":"#/components/schemas/Merchant"},"displayAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform-maintained headline amount of the card payment, in the cardholder's preferred display currency (which matches the card billing currency unless a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set when the card was created). The amount is derived from card payment events and can be displayed in your transaction activity UI as the amount of the card payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a headline amount, it reflects the intended amount of the payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of a full reversal or cancellation and within-lifecycle dispute swings it stays stable. For example, an auth-50 → settle-50 → reverse-50 cycle still reads as 50 here, even though the net ledger impact is zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of a partial reversal it reflects the net amount, so the display amount of the card payment reflects the revised amount. For example, an auth-50 (displayAmount 50) → settle-40 with a release of the remaining auth of 10, displayAmount updated to 40."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To compute the actual net (for accounting), sum the amounts of your chosen type, from all the events, yourself."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Magnitude is always positive. The debit/credit direction is implicit from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (purchases debit, refunds and OCTs credit). For the lifecycle phase, read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For amounts in the merchant's currency (transaction currency) or the card's currency (if different from your preferred currency), read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"status":{"$ref":"#/components/schemas/CardPaymentStatus"},"relatedCardPaymentId":{"type":"string","pattern":"^[0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct parent linkage — id of the single prior card payment that this payment derives from. Set on:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments referring to the original purchase"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments referring to the prior purchase being credited"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip / add-on payments referring to the original ride / fare / service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installment / recurring payments referring to the initial setup transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corresponds to Visa's \"Original Transaction ID\" linkage and Mastercard's DE 105 subelement 002 (Economically Related Transaction Identifier). Not used for messages that share a single lifecycle — those are events on the same card payment."},"children":[]}]}]}]},"events":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ordered event stream — every scheme message in this card payment's lifecycle. For headline display use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"displayAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; walk this when you need scheme-level detail (per-event amounts, fees, reason codes, reversals)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CardPaymentEvent"}},"creationTimestamp":{"type":"integer","format":"int64","description":"When the first event for this payment was received, Epoch millis."},"lastUpdatedTimestamp":{"type":"integer","format":"int64","description":"When the most recent event for this payment was received, Epoch millis."}}}},"components/schemas/ScheduledTimestamp":{"id":"components/schemas/ScheduledTimestamp","kind":"json-schema","title":"ScheduledTimestamp","data":{"pattern":"^[0-9]+$","type":"string","description":"The epoch timestamp at which the transaction is scheduled to be executed."}},"components/schemas/TransactionCancellationReason":{"id":"components/schemas/TransactionCancellationReason","kind":"json-schema","title":"TransactionCancellationReason","data":{"type":"string","pattern":"^[ a-zA-Z0-9_-]+$","maxLength":50,"description":"The reason the scheduled transaction was cancelled."}},"components/schemas/ExecutionTimestamp":{"id":"components/schemas/ExecutionTimestamp","kind":"json-schema","title":"ExecutionTimestamp","data":{"pattern":"^[0-9]+$","type":"string","description":"The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED."}},"components/schemas/OutgoingWireTransferType":{"id":"components/schemas/OutgoingWireTransferType","kind":"json-schema","title":"OutgoingWireTransferType","data":{"type":"string","description":"The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.","enum":["SEPA","FASTER_PAYMENTS","SWIFT","RIX"]}},"components/schemas/ExternalAccountId":{"id":"components/schemas/ExternalAccountId","kind":"json-schema","title":"ExternalAccountId","data":{"type":"object","description":"The id of an external account, such as a Linked Account, registered with the Weavr Platform.","required":["type","id"],"properties":{"type":{"$ref":"#/components/schemas/ExternalAccountType"},"id":{"type":"string","pattern":"^[0-9]+$"}}}},"components/schemas/OutgoingWireTransferState":{"id":"components/schemas/OutgoingWireTransferState","kind":"json-schema","title":"OutgoingWireTransferState","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the Outgoing wire transfer transaction, as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID: The wire transfer has failed initial validation checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CHALLENGE: The wire transfer requires the completion of a transaction confirmation challenge before it can be submitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUBMITTED: The wire transfer has been submitted to the sending financial institution for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The wire transfer that was submitted was rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPROVED: The wire transfer that was submitted has been approved and is being processed by the sending financial institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED: There was an issue with the wire transfer, and the transaction has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: The requested funds have been sent from the source instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNED: The wire transfer has been returned to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULED: The wire transfer will be executed at the scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: The scheduled wire transfer has been cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CONFIRMATION: The wire transfer requires a manual confirmation by the user before proceeding."},"children":[]}]}]}]}],"type":"string","enum":["INVALID","PENDING_CHALLENGE","SUBMITTED","REJECTED","APPROVED","FAILED","COMPLETED","RETURNED","SCHEDULED","CANCELLED","PENDING_CONFIRMATION"]}},"components/schemas/OutgoingWireTransferValidationOutcome":{"id":"components/schemas/OutgoingWireTransferValidationOutcome","kind":"json-schema","title":"OutgoingWireTransferValidationOutcome","data":{"type":"object","required":["category","categoryResult"],"properties":{"category":{"type":"string","enum":["UK_CONFIRMATION_OF_PAYEE","SEPA_VERIFICATION_OF_PAYEE"]},"categoryResult":{"oneOf":[{"$ref":"#/components/schemas/UKConfirmationOfPayeeResult"},{"$ref":"#/components/schemas/SEPAVerificationOfPayeeResult"}]}}}},"components/schemas/Nationality":{"id":"components/schemas/Nationality","kind":"json-schema","title":"Nationality","data":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"Nationality of the user - using ISO 3166 alpha-2."}},"components/schemas/DateOfBirth":{"id":"components/schemas/DateOfBirth","kind":"json-schema","title":"DateOfBirth","data":{"type":"string","format":"date","description":"The date of birth in ISO 8601 format (YYYY-MM-DD)."}},"components/schemas/IBANDetails":{"id":"components/schemas/IBANDetails","kind":"json-schema","title":"IBANDetails","data":{"required":["iban"],"type":"object","description":"Bank details used in case the wire transfer is executed over SEPA or RIX","properties":{"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SEPA or RIX"},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC, for wire transfer over SEPA or RIX"}}}},"components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails":{"id":"components/schemas/FasterPaymentsBankDetailsOrBACSBankDetails","kind":"json-schema","title":"FasterPaymentsBankDetailsOrBACSBankDetails","data":{"required":["accountNumber","sortCode"],"type":"object","description":"Bank details used in case the wire transfer is executed over Faster Payments.","properties":{"accountNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string"}}}},"components/schemas/CorrespondentBankingOwt":{"id":"components/schemas/CorrespondentBankingOwt","kind":"json-schema","title":"CorrespondentBankingOwt","data":{"required":["id","profileId","creationTimestamp","sourceInstrument","amount","originator","beneficiary","purpose","state"],"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the Correspondent Banking OWT."},"profileId":{"$ref":"#/components/schemas/ProfileId"},"tag":{"$ref":"#/components/schemas/Tag"},"sourceInstrument":{"required":["type","id"],"type":"object","description":"The source managed account from where the funds were taken.","properties":{"type":{"type":"string","enum":["managed_accounts"]},"id":{"type":"string","pattern":"^[0-9]+$"}}},"amount":{"description":"The amount transferred.","$ref":"#/components/schemas/CurrencyAmount"},"originator":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingIndividualOriginator"},{"$ref":"#/components/schemas/CorrespondentBankingBusinessOriginator"}]},"beneficiary":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingSEPABeneficiary"},{"$ref":"#/components/schemas/CorrespondentBankingRIXBeneficiary"},{"$ref":"#/components/schemas/CorrespondentBankingFasterPaymentsBeneficiary"}]},"purpose":{"type":"string","maxLength":255,"description":"The purpose of the payment."},"description":{"maxLength":35,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These details are passed to the beneficiary as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This field is mandatory for wire transfers executed over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The allowed length is dependent on the payment type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"35"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters. An extended character set is accepted to cater for all European languages. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not support a particular character, it is automatically converted to an acceptable alternative, in line with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scheme guidance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Faster Payments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"18"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]}]},"externalData":{"type":"array","description":"Additional external data as key-value pairs.","items":{"$ref":"#/components/schemas/CorrespondentBankingExternalData"}},"state":{"$ref":"#/components/schemas/CorrespondentBankingOwtState"},"creationTimestamp":{"type":"integer","format":"int64","description":"The time when the transaction was created, expressed in Epoch timestamp using millisecond precision."},"scheduledTimestamp":{"$ref":"#/components/schemas/ScheduledTimestamp"},"cancellationReason":{"$ref":"#/components/schemas/TransactionCancellationReason"},"validationOutcomes":{"type":"array","items":{"$ref":"#/components/schemas/CorrespondentBankingOwtValidationOutcome"}}}}},"components/schemas/FeeType":{"id":"components/schemas/FeeType","kind":"json-schema","title":"FeeType","data":{"type":"string","enum":["DEPOSIT","WITHDRAWAL","PURCHASE","REFUND","ATM_WITHDRAWAL","CHARGEBACK","TRANSFER","SEND","OWT","CUSTOM","OTHER"]}},"components/schemas/FeeSpecType":{"id":"components/schemas/FeeSpecType","kind":"json-schema","title":"FeeSpecType","data":{"type":"string","enum":["FLAT","PERCENTAGE","PLUS","MAX","MIN"]}},"components/schemas/TransactionBatchIntercept":{"id":"components/schemas/TransactionBatchIntercept","kind":"json-schema","title":"TransactionBatchIntercept","data":{"required":["provider"],"type":"object","properties":{"provider":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string"},"state":{"$ref":"#/components/schemas/TransactionBatchInterceptState"},"denialReason":{"maxLength":50,"type":"string"},"suspendedReason":{"maxLength":255,"type":"string"}}}},"components/schemas/TransactionBatchState":{"id":"components/schemas/TransactionBatchState","kind":"json-schema","title":"TransactionBatchState","data":{"type":"string","enum":["EXECUTION_PENDING","EXECUTED","COMPLETED","COMPENSATION_PENDING","REJECTED","FAILED","EXECUTION_SUSPENDED","COMPENSATION_SUSPENDED"]}},"components/schemas/TransactionBatchErrorType":{"id":"components/schemas/TransactionBatchErrorType","kind":"json-schema","title":"TransactionBatchErrorType","data":{"type":"string","enum":["REVERSAL_EXCEEDS_REMAINING","DENIED_BY_INTERCEPTOR","DENIED_BY_INSTRUMENT","DENIED_BY_FOREX_TRADE","FI_PROVIDER_TREASURY_UNSUPPORTED","DENIED_BY_SUSPENSE","DENIED_BY_STATE_CHANGE"]}},"components/schemas/TransactionBatchParticipantState":{"id":"components/schemas/TransactionBatchParticipantState","kind":"json-schema","title":"TransactionBatchParticipantState","data":{"type":"string","enum":["EXECUTION_PENDING","EXECUTED","COMMITTED","REJECTED","FAILED","COMPENSATION_PENDING","COMPENSATED","OBSOLETE","EXECUTION_SUSPENDED","COMPENSATION_SUSPENDED"]}},"components/schemas/InstrumentParticipantErrorType":{"id":"components/schemas/InstrumentParticipantErrorType","kind":"json-schema","title":"InstrumentParticipantErrorType","data":{"type":"string","enum":["NO_INSTRUMENT_ERROR","BALANCE_LIMIT_EXCEEDED","INSTRUMENT_ALREADY_EXISTS","INSTRUMENT_ALREADY_DESTROYED","STATE_DOES_NOT_PERMIT_ACTION","UNSUPPORTED_CURRENCY","INSTRUMENT_ALREADY_RESTRICTED","INSTRUMENT_ALREADY_ACTIVE","INSTRUMENT_EXPIRED","PROVIDER_REJECTED","INSTRUMENT_ALREADY_BLOCKED","INSTRUMENT_NOT_BLOCKED"]}},"components/schemas/BlockedDetailsSubType":{"id":"components/schemas/BlockedDetailsSubType","kind":"json-schema","title":"BlockedDetailsSubType","data":{"type":"string","enum":["FREEZE","LOST","SINGLE_SPEND","PENDING_APPROVAL"]}},"components/schemas/DestroyType":{"id":"components/schemas/DestroyType","kind":"json-schema","title":"DestroyType","data":{"type":"string","enum":["USER","ADMIN","SYSTEM","LOST","STOLEN","SINGLE_SPEND","ACCOUNT_REJECTED","EXPIRED","COMPROMISED"]}},"components/schemas/ForexTradeParticipantErrorType":{"id":"components/schemas/ForexTradeParticipantErrorType","kind":"json-schema","title":"ForexTradeParticipantErrorType","data":{"type":"string","enum":["NO_FOREX_TRADE_ERROR","RATE_EXPIRED"]}},"components/schemas/CredentialId":{"id":"components/schemas/CredentialId","kind":"json-schema","title":"CredentialId","data":{"required":["type","id"],"type":"object","properties":{"type":{"maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","type":"string","enum":["ROOT","USER","API_CLIENT"],"description":"The type of user."},"id":{"type":"string","pattern":"^[0-9]+$","description":"The identifier of the user."}}}},"components/schemas/BeneficiaryBatchOperation":{"id":"components/schemas/BeneficiaryBatchOperation","kind":"json-schema","title":"BeneficiaryBatchOperation","data":{"type":"string","enum":["CREATE","REMOVE"]}},"components/schemas/BeneficiaryTrustLevel":{"id":"components/schemas/BeneficiaryTrustLevel","kind":"json-schema","title":"BeneficiaryTrustLevel","data":{"type":"string","description":"The value that determines whether a Beneficiary is trusted or not.","enum":["TRUSTED"]}},"components/schemas/BusinessBeneficiaryType":{"id":"components/schemas/BusinessBeneficiaryType","kind":"json-schema","title":"BusinessBeneficiaryType","data":{"required":["businessName"],"type":"object","properties":{"businessName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business beneficiary name. The allowed length and pattern is dependent on the beneficiary details type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InstrumentDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IBANDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetailsOrBACSBankDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"140"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters with a pattern of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^[a-zA-Z0-9\\/\\-?:().,’+\\s#=!\"%&*<>;\\{@\\r\\n]*$"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(please note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"’"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))"},"children":[]}]}]}]}}}},"components/schemas/ConsumerBeneficiaryType":{"id":"components/schemas/ConsumerBeneficiaryType","kind":"json-schema","title":"ConsumerBeneficiaryType","data":{"required":["fullName"],"type":"object","properties":{"nationality":{"type":"string","description":"The nationality of the consumer. Must be a valid ISO 3166-1 alpha-2 country code (e.g., 'GB', 'FR').","pattern":"^[A-Z]{2}$"},"dateOfBirth":{"type":"string","description":"The date of birth of the consumer. Must be a valid date in ISO 8601 format (YYYY-MM-DD) and should not be a future date.","format":"date"},"fullName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The person beneficiary name. The allowed length and pattern is dependent on the beneficiary details type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InstrumentDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IBANDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"150"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BankAccountDetailsBeneficiary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FasterPaymentsBankDetailsOrBACSBankDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": >= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character and <= "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"140"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" characters with a pattern of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"^[a-zA-Z0-9\\/\\-?:().,’+\\s#=!\"%&*<>;\\{@\\r\\n]*$"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(please note that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"’"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" symbol is the unicode value U+2019 (right single quotation mark) and not the unicode value U+0027 (apostrophe))"},"children":[]}]}]}]}}}},"components/schemas/InstrumentDetailsBeneficiary":{"id":"components/schemas/InstrumentDetailsBeneficiary","kind":"json-schema","title":"InstrumentDetailsBeneficiary","data":{"required":["instrument"],"type":"object","description":"Represents a Weavr beneficiary instrument typically used in Send transactions.","properties":{"instrument":{"$ref":"#/components/schemas/InstrumentId"}}}},"components/schemas/BeneficiaryState":{"id":"components/schemas/BeneficiaryState","kind":"json-schema","title":"BeneficiaryState","data":{"type":"string","enum":["INITIALISED","INVALID","PENDING_CHALLENGE","CHALLENGE_FAILED","ACTIVE","REMOVED"]}},"components/schemas/BulkProcessProgressStatus":{"id":"components/schemas/BulkProcessProgressStatus","kind":"json-schema","title":"BulkProcessProgressStatus","data":{"type":"string","enum":["RUNNING","PARTIALLY_COMPLETED","COMPLETED","FAILED","PAUSED","CANCELLED"]}},"components/schemas/BulkProcessOperationStatusCounts":{"id":"components/schemas/BulkProcessOperationStatusCounts","kind":"json-schema","title":"BulkProcessOperationStatusCounts","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/BulkProcessOperationStatus"},"count":{"type":"integer"}}}},"components/schemas/ProfileId":{"id":"components/schemas/ProfileId","kind":"json-schema","title":"ProfileId","data":{"type":"string","description":"The profile Id which a specific identity, instrument or transaction type is linked to.\n\nProfiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.\n\nYou can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.\n\nProfile Ids can be found in the Multi Portal, in the API Credentials page.\n","pattern":"^[0-9]+$"}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"type":"string","description":"The tag field is a custom field that can be used to search and filter.","maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$"}},"components/schemas/IbanInstrumentState":{"id":"components/schemas/IbanInstrumentState","kind":"json-schema","title":"IbanInstrumentState","data":{"required":["state"],"type":"object","properties":{"state":{"$ref":"#/components/schemas/IbanState"},"destroyedReason":{"$ref":"#/components/schemas/DestroyedReason"}}}},"components/schemas/SwiftBankDetails":{"id":"components/schemas/SwiftBankDetails","kind":"json-schema","title":"SwiftBankDetails","data":{"required":["iban","code"],"type":"object","description":"Bank details used in case the wire transfer is executed over SWIFT.","properties":{"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SWIFT."},"code":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"SWIFT code, identifying a particular bank or branch, required for wire transfer over SWIFT."}}}},"components/schemas/AccountType":{"id":"components/schemas/AccountType","kind":"json-schema","title":"AccountType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An account can be of two types, Personal or Business:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a natural person or consumer identity;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS means that the account held at the external bank or PSP is registered under the ownership of a corporate entity."},"children":[]}]}]}]}],"enum":["BUSINESS","PERSONAL"]}},"components/schemas/AccountNumberAndSortCode":{"id":"components/schemas/AccountNumberAndSortCode","kind":"json-schema","title":"AccountNumberAndSortCode","data":{"required":["accountNumber","sortCode"],"type":"object","description":"Bank details","properties":{"accountNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"Account number"},"sortCode":{"type":"string","pattern":"^[0-9]{6}$","description":"Sort code"},"secondaryReference":{"type":"string","description":"Optional secondary reference for accounts without unique sort codes."}}}},"components/schemas/Iban":{"id":"components/schemas/Iban","kind":"json-schema","title":"Iban","data":{"required":["iban"],"type":"object","description":"Bank details","properties":{"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC, for wire transfer over SEPA or RIX."}}}},"components/schemas/AccountDescriptor":{"id":"components/schemas/AccountDescriptor","kind":"json-schema","title":"AccountDescriptor","data":{"required":["accountDescriptor"],"type":"object","description":"Identifier or account number which does not follow either the IBAN or Faster Payment (sort code and account number) format, such as a US bank account identifier.","properties":{"accountDescriptor":{"type":"string"}}}},"components/schemas/LinkedAccountState":{"id":"components/schemas/LinkedAccountState","kind":"json-schema","title":"LinkedAccountState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the linked account:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_VERIFICATION"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is pending the completion of the required verification steps."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is verified and active, ready to be used for self-to-self wire transfers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCKED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account is temporarily blocked, preventing any use of this external account in self-to-self wire transfers. A Linked Account can be unblocked by calling the Multi API endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /linked_accounts/{id}/unblock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REMOVED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account has been removed from the platform and can no longer be used for self-to-self wire transfers unless a new verification is completed in future."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Linked Account failed the verification process and cannot be used for self-to-self wire transfers unless a new verification is completed in future."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Linked Account can transition through these different overall states, starting at the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING_VERIFICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state until all verification steps are followed through."},"children":[]}]}]}]}],"enum":["PENDING_VERIFICATION","BLOCKED","ACTIVE","REJECTED","REMOVED"]}},"components/schemas/Id":{"id":"components/schemas/Id","kind":"json-schema","title":"Id","data":{"type":"string","pattern":"^[0-9]+$"}},"components/schemas/InstrumentType":{"id":"components/schemas/InstrumentType","kind":"json-schema","title":"InstrumentType","data":{"type":"string","enum":["managed_cards","managed_accounts"]}},"components/schemas/DigitalWalletType":{"id":"components/schemas/DigitalWalletType","kind":"json-schema","title":"DigitalWalletType","data":{"type":"string","description":"The digital wallet type.","enum":["GOOGLE_PAY","APPLE_PAY","MERCHANT_TOKEN"]}},"components/schemas/BulkCardDelivery":{"id":"components/schemas/BulkCardDelivery","kind":"json-schema","title":"BulkCardDelivery","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bulk delivery is available for deliveryMethods REGISTERED_MAIL or COURIER."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All cards marked as bulk and ordered within the fulfilment centre’s dispatch window will be sent in bulk. Delivery address must be identical for all orders. contactNumber in the deliveryAddress object is mandatory when bulk is selected. Maximum number of cards delivered in a single box/packet is REGISTERED_MAIL = 90, COURIER = 200."},"children":[]}]}]}]}},"components/schemas/ManufacturingState":{"id":"components/schemas/ManufacturingState","kind":"json-schema","title":"ManufacturingState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information on the manufacturing of the physical card, as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REQUESTED: The upgrade of the card to physical has been requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SENT_FOR_FULFILLMENT - The card has been sent for printing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISPATCHED: The card has been manufactured and dispatched. You may receive a second DISPATCHED event when the manufacturer provides a tracking code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELIVERED: The card has been received and activated by the recipient."},"children":[]}]}]}]}],"enum":["REQUESTED","SENT_FOR_FULFILLMENT","DISPATCHED","DELIVERED"]}},"components/schemas/DeliveryAddress":{"id":"components/schemas/DeliveryAddress","kind":"json-schema","title":"DeliveryAddress","data":{"required":["name","surname","addressLine1","city","postCode","country"],"type":"object","description":"The delivery address where the physical card is delivered.","properties":{"name":{"maxLength":100,"type":"string"},"surname":{"maxLength":100,"type":"string"},"addressLine1":{"maxLength":50,"minLength":1,"type":"string"},"addressLine2":{"maxLength":50,"minLength":1,"type":"string"},"city":{"maxLength":50,"type":"string"},"postCode":{"maxLength":10,"pattern":"^[A-Za-z0-9 -]*$","type":"string"},"state":{"maxLength":50,"type":"string"},"country":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]+$","type":"string","description":"Country of the identity in ISO 3166 alpha-2 format."},"contactNumber":{"$ref":"#/components/schemas/PhoneNumber","description":"Mandatory when bulk delivery is selected. Will be printed on the box/packet to assist delivery."}}}},"components/schemas/DeliveryMethod":{"id":"components/schemas/DeliveryMethod","kind":"json-schema","title":"DeliveryMethod","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery methods supported for delivering printed physical cards. If not specified, the STANDARD_DELIVERY method will be used."},"children":[]}]}]}],"enum":["STANDARD_DELIVERY","REGISTERED_MAIL","COURIER","FIRST_CLASS_MAIL"]}},"components/schemas/DeliveryTrackingCode":{"id":"components/schemas/DeliveryTrackingCode","kind":"json-schema","title":"DeliveryTrackingCode","data":{"type":"string","description":"The delivery tracking code for tracking the physical card's delivery status. This may not always be available on the first dispatched event, and so you will receive an additional dispatched notification with the delivery tracking code populated as soon as it is available."}},"components/schemas/DeliveryTrackingMethod":{"id":"components/schemas/DeliveryTrackingMethod","kind":"json-schema","title":"DeliveryTrackingMethod","data":{"type":"string","description":"The delivery tracking method for tracking the physical card's delivery status."}},"components/schemas/DeliveryTrackingUrl":{"id":"components/schemas/DeliveryTrackingUrl","kind":"json-schema","title":"DeliveryTrackingUrl","data":{"type":"string","description":"The delivery tracking URL for tracking the physical card's delivery status."}},"components/schemas/CardPaymentType":{"id":"components/schemas/CardPaymentType","kind":"json-schema","title":"CardPaymentType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High-level type of card payment, derived from the first event."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PURCHASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — standard purchase at a merchant. A purchase of zero is the check a merchant runs to prove the card is live before storing it on file: no money moves, no hold is placed, and it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on arrival since nothing further will follow. If the merchant later charges the same purchase, the card payment adopts the real type and amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — refund from a merchant to the cardholder."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — push credit to the cardholder (OCT)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_FUNDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — load funds onto an account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CASH_WITHDRAWAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — cash withdrawn at ATM or scheme cash service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE_INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — non-financial balance check."},"children":[]}]}]}]}],"enum":["PURCHASE","REFUND","ORIGINAL_CREDIT","ACCOUNT_FUNDING","CASH_WITHDRAWAL","BALANCE_INQUIRY"]}},"components/schemas/Card":{"id":"components/schemas/Card","kind":"json-schema","title":"Card","data":{"type":"object","required":["id","type"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about a managed card — used wherever a card appears (the card on a card payment, or the access instrument that initiated a transaction)."},"children":[]}]}]}],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":"The unique identifier of the managed card."},"type":{"type":"string","enum":["managed_cards"]},"mode":{"type":"string","enum":["prepaid","debit"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The mode the card was created in."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prepaid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has its own balance and can have funds transferred to or from it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card has no balance of its own; it draws on its parent managed account up to a configurable spend limit."},"children":[]}]}]}]}]},"friendlyName":{"type":"string","description":"The friendly name chosen for the card."},"nameOnCard":{"type":"string","description":"The cardholder name printed on the card."},"cardBrand":{"type":"string","enum":["MASTERCARD","VISA"],"description":"The scheme of the card. Restricted to schemes supported by card payments."},"cardNumberFirstSix":{"type":"string","pattern":"^[0-9]{6}$","description":"The first six digits of the card number (BIN range)."},"cardNumberLastFour":{"type":"string","pattern":"^[0-9]{4}$","description":"The last four digits of the card number."},"linkedUserId":{"type":"string","pattern":"^[0-9]+$","description":"Identifier of the authorised user the card is assigned to. Populated only when the card has been assigned to a specific user."},"parentManagedAccountId":{"type":"string","pattern":"^[0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the managed account this card draws funds from. Populated only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"Merchant","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity."},"children":[]}]}]}],"required":["id","name"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant identifier (MID) — the acquirer-assigned code that identifies the merchant on card-scheme messages (ISO 8583 DE 42 Card Acceptor Identification Code)."},"children":[]}]}]}]},"name":{"type":"string","description":"Merchant name (DBA name)."},"nameOther":{"type":"string","description":"Alternative merchant name as supplied by the card network, when present."},"networkId":{"type":"string","description":"Identifier assigned by the acquirer or scheme to the merchant."},"categoryCode":{"type":"string","description":"ISO 18245 merchant category code (MCC)."},"description":{"type":"string","description":"Free-text description of the merchant."},"street":{"type":"string","description":"Street address of the merchant terminal."},"city":{"type":"string","description":"City of the merchant terminal."},"state":{"type":"string","description":"Subdivision (state, province, region) of the merchant terminal."},"postalCode":{"type":"string","description":"Postal code of the merchant terminal."},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the merchant terminal."},"telephone":{"type":"string","description":"Merchant telephone."},"url":{"type":"string","description":"Merchant website."},"contact":{"type":"string","description":"Merchant contact (name or email of a representative, when present)."},"reference":{"type":"string","description":"Merchant-supplied reference for the transaction (the merchant's own identifier for what they billed)."},"logoUrl":{"type":"string","description":"Merchant logo URL, when available."}}}},"components/schemas/CardPaymentStatus":{"id":"components/schemas/CardPaymentStatus","kind":"json-schema","title":"CardPaymentStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lifecycle status of a CardPayment."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT_IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — authorised, not yet (or not fully) settled. The hold is still on the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — terminal; nothing further is expected. The customer has been charged, except for a zero-amount card check, which settles on arrival without a charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the latest authorisation was declined; no money moved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the authorisation was cancelled/reversed before settlement; no charge applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the authorisation timed out without settling."},"children":[]}]}]}]}],"enum":["SETTLEMENT_IN_PROGRESS","SETTLED","DECLINED","CANCELLED","EXPIRED"]}},"components/schemas/CardPaymentEvent":{"id":"components/schemas/CardPaymentEvent","kind":"json-schema","title":"CardPaymentEvent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An event in a card payment's lifecycle, lean — used "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"nested"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPayment.events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The parent card payment provides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so the lean variants don't repeat them. Each event carries its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Four variants discriminated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTHORISATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentAuthorisationEvent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SETTLEMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentSettlementEvent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentRefundEvent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ORIGINAL_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentOriginalCreditEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Visa OCT / Mastercard MoneySend)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"standalone"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /card_payment_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — which carries "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so each row is self-contained — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentEventDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["type"],"properties":{"type":{"$ref":"#/components/schemas/CardPaymentEventType"}},"discriminator":{"propertyName":"type","mapping":{"AUTHORISATION":"#/components/schemas/CardPaymentAuthorisationEvent","SETTLEMENT":"#/components/schemas/CardPaymentSettlementEvent","REFUND":"#/components/schemas/CardPaymentRefundEvent","ORIGINAL_CREDIT":"#/components/schemas/CardPaymentOriginalCreditEvent"}}}},"components/schemas/ExternalAccountType":{"id":"components/schemas/ExternalAccountType","kind":"json-schema","title":"ExternalAccountType","data":{"type":"string","enum":["linked_accounts"]}},"components/schemas/UKConfirmationOfPayeeResult":{"id":"components/schemas/UKConfirmationOfPayeeResult","kind":"json-schema","title":"UKConfirmationOfPayeeResult","data":{"type":"object","required":["match"],"properties":{"match":{"type":"string","description":"The result of matching performed by the UK Confirmation of Payee responder","enum":["EXACT_MATCH","CLOSE_MATCH","NO_MATCH","NOT_POSSIBLE"]},"reasonCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason why the matching failed at the UK Confirmation of Payee responder:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ANNM: The CoP responder confirms that the account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided does not match;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MBAM: The CoP responder indicates that the account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided closely matches the actual account in its records, the actual account name is returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BANM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'PERSONAL', but the CoP responder indicates that the actual account matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is actually BUSINESS;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PANM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'BUSINESS', but the CoP responder indicates that the actual account matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is actually PERSONAL;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAMM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'PERSONAL', but the CoP responder indicates that an account closely matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is BUSINESS;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAMM: The account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the user specified is 'BUSINESS', but the CoP responder indicates that an account closely matching the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is PERSONAL;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AC01: The account does not exist in the CoP responders books, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified is likely incorrect;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IVCR: The CoP responder was unable to locate an account based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondaryReference"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACNS: The account is not supported for CoP by the CoP responder;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OPTO: The owner of the account has opted out of CoP service by the CoP responder;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CASS: The account has been switched using the Current Account Switch Service;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCNS: The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided is not supported at endpoint;"},"children":[]}]}]}]}],"enum":["ANNM","MBAM","BANM","PANM","BAMM","PAMM","AC01","IVCR","ACNS","OPTO","CASS","SCNS"]},"accountName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CoP: Returned when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSE_MATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is MBAM, BAMM or PAMM"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VoP: Returned when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSE_MATCH"},"children":[]}]}]}]}}}},"components/schemas/SEPAVerificationOfPayeeResult":{"id":"components/schemas/SEPAVerificationOfPayeeResult","kind":"json-schema","title":"SEPAVerificationOfPayeeResult","data":{"type":"object","required":["match"],"properties":{"match":{"type":"string","description":"The result of the SEPA Verification of Payee check performed by the responding PSP.","enum":["MATCH","NO_MATCH","CLOSE_MATCH","NOT_POSSIBLE"]},"accountName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the account holder as registered with the responding PSP."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the match result is CLOSE_MATCH to help the payer verify the payee."},"children":[]}]}]}]}}}},"components/schemas/CorrespondentBankingIndividualOriginator":{"id":"components/schemas/CorrespondentBankingIndividualOriginator","kind":"json-schema","title":"CorrespondentBankingIndividualOriginator","data":{"required":["name","address","country","bankAccountDetails"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An individual (natural person) originator of the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travel Rule Requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory: Full name and account number (via bankAccountDetails)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory: At least one supplementary information type (address + birth details, or address + official ID)"},"children":[]}]}]}]}],"properties":{"tag":{"$ref":"#/components/schemas/Tag"},"name":{"type":"string","maxLength":140,"description":"Full name of the individual as documented on official ID."},"address":{"type":"string","maxLength":255,"description":"Full residential address of the individual."},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code."},"bankAccountDetails":{"$ref":"#/components/schemas/CorrespondentBankingBankAccountDetails","description":"Account and financial institution details of the originator (travel rule mandatory)."},"supplementaryInformation":{"oneOf":[{"$ref":"#/components/schemas/CorrespondentBankingIndividualAddressAndIdInfo"},{"$ref":"#/components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo"}]}}}},"components/schemas/CorrespondentBankingBusinessOriginator":{"id":"components/schemas/CorrespondentBankingBusinessOriginator","kind":"json-schema","title":"CorrespondentBankingBusinessOriginator","data":{"required":["name","registrationAddress","registrationCountry","bankAccountDetails"],"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A business (legal entity) originator of the transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travel Rule Requirements:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory: Full legal name and account number (via bankAccountDetails)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mandatory: Registered address and business identification (LEI, registration number, or tax ID)"},"children":[]}]}]}]}],"properties":{"tag":{"$ref":"#/components/schemas/Tag"},"name":{"type":"string","maxLength":140,"description":"Full legal name of the business entity."},"registrationAddress":{"type":"string","maxLength":255,"description":"Registered address of the business entity."},"registrationCountry":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"ISO 3166-1 alpha-2 country code of registration."},"bankAccountDetails":{"$ref":"#/components/schemas/CorrespondentBankingBankAccountDetails","description":"Account and financial institution details of the originator (travel rule mandatory)."},"supplementaryInformation":{"$ref":"#/components/schemas/CorrespondentBankingBusinessAddressAndIdInfo"}}}},"components/schemas/CorrespondentBankingSEPABeneficiary":{"id":"components/schemas/CorrespondentBankingSEPABeneficiary","kind":"json-schema","title":"CorrespondentBankingSEPABeneficiary","data":{"required":["name","iban","address"],"type":"object","description":"CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.","properties":{"name":{"type":"string","minLength":1,"maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 35 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An extended character set is accepted to cater for all European languages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If SEPA does not support a particular character, it is automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"converted to an acceptable alternative, in line with SEPA scheme guidance."},"children":[]}]}]}]},"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over SEPA."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC (Bank Identifier Code) for wire transfer over SEPA."},"address":{"maxLength":105,"minLength":1,"type":"string","description":"The beneficiary's address. Required for correspondent banking transfers.\nMaximum 105 characters (split into 3x35-char lines by the provider).\n"},"bankName":{"type":"string","maxLength":150,"description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/CorrespondentBankingRIXBeneficiary":{"id":"components/schemas/CorrespondentBankingRIXBeneficiary","kind":"json-schema","title":"CorrespondentBankingRIXBeneficiary","data":{"required":["name","iban","address"],"type":"object","description":"CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.","properties":{"name":{"type":"string","minLength":1,"maxLength":35,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 35 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An extended character set is accepted to cater for all European languages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If RIX does not support a particular character, it is automatically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"converted to an acceptable alternative."},"children":[]}]}]}]},"iban":{"type":"string","minLength":15,"maxLength":34,"pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$","description":"International Bank Account Number, required for wire transfer over RIX."},"bankIdentifierCode":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$","description":"BIC (Bank Identifier Code) for wire transfer over RIX."},"address":{"maxLength":105,"minLength":1,"type":"string","description":"The beneficiary's address. Required for correspondent banking transfers.\nMaximum 105 characters (split into 3x35-char lines by the provider).\n"},"bankName":{"type":"string","maxLength":150,"description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/CorrespondentBankingFasterPaymentsBeneficiary":{"id":"components/schemas/CorrespondentBankingFasterPaymentsBeneficiary","kind":"json-schema","title":"CorrespondentBankingFasterPaymentsBeneficiary","data":{"required":["name","type","accountNumber","sortCode","address"],"type":"object","description":"CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.","properties":{"name":{"type":"string","minLength":1,"maxLength":35,"pattern":"^[a-zA-Z0-9\\/\\-?:().,'+\\s#=!\"%&*<>;\\{@\\r\\n]*$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The beneficiary's full name. >= 1 character and <= 35 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: the ' symbol is the unicode value U+2019 (right single quotation mark)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and not the unicode value U+0027 (apostrophe)."},"children":[]}]}]}]},"type":{"type":"string","description":"The type of beneficiary account. Required for Faster Payments.","enum":["PERSONAL","BUSINESS"]},"accountNumber":{"type":"string","pattern":"^[0-9]{8}$","description":"Account number, required for wire transfer over Faster Payments."},"sortCode":{"type":"string","pattern":"^[0-9]{6}$","description":"Sort code, required for wire transfer over Faster Payments."},"secondaryReference":{"type":"string","description":"Optional secondary reference for accounts without unique sort codes."},"address":{"maxLength":105,"minLength":1,"type":"string","description":"The beneficiary's address. Required for correspondent banking transfers.\nMaximum 105 characters (split into 3x35-char lines by the provider).\n"},"bankName":{"type":"string","maxLength":150,"description":"The beneficiary's bank name."},"bankAddress":{"maxLength":150,"minLength":1,"type":"string","description":"The beneficiary's bank address."},"bankCountry":{"type":"string","description":"The beneficiary's bank country in ISO 3166 alpha-2 format.","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$"},"nationality":{"$ref":"#/components/schemas/Nationality"},"dateOfBirth":{"$ref":"#/components/schemas/DateOfBirth"}}}},"components/schemas/CorrespondentBankingExternalData":{"id":"components/schemas/CorrespondentBankingExternalData","kind":"json-schema","title":"CorrespondentBankingExternalData","data":{"type":"object","description":"External data key-value pair.","required":["name","value"],"properties":{"name":{"type":"string","maxLength":50,"description":"Name/key of the external data."},"value":{"type":"string","maxLength":255,"description":"Value of the external data."}}}},"components/schemas/CorrespondentBankingOwtState":{"id":"components/schemas/CorrespondentBankingOwtState","kind":"json-schema","title":"CorrespondentBankingOwtState","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the correspondent bank transfer transaction, as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID: The transfer has failed initial validation checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CHALLENGE: The transfer requires the completion of a transaction confirmation challenge before it can be submitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUBMITTED: The transfer has been submitted to the sending financial institution for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The transfer that was submitted was rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APPROVED: The transfer that was submitted has been approved and is being processed by the sending financial institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILED: There was an issue with the transfer, and the transaction has failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETED: The requested funds have been sent from the source instrument."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RETURNED: The transfer has been returned to the sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SCHEDULED: The transfer will be executed at the scheduled time."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: The scheduled transfer has been cancelled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING_CONFIRMATION: The transfer requires a manual confirmation by the user before proceeding."},"children":[]}]}]}]}],"type":"string","enum":["INVALID","PENDING_CHALLENGE","SUBMITTED","REJECTED","APPROVED","FAILED","COMPLETED","RETURNED","SCHEDULED","CANCELLED","PENDING_CONFIRMATION"]}},"components/schemas/CorrespondentBankingOwtValidationOutcome":{"id":"components/schemas/CorrespondentBankingOwtValidationOutcome","kind":"json-schema","title":"CorrespondentBankingOwtValidationOutcome","data":{"type":"object","required":["category","categoryResult"],"properties":{"category":{"type":"string","enum":["SEPA_VERIFICATION_OF_PAYEE","UK_CONFIRMATION_OF_PAYEE"]},"categoryResult":{"oneOf":[{"$ref":"#/components/schemas/SEPAVerificationOfPayeeResult"},{"$ref":"#/components/schemas/UKConfirmationOfPayeeResult"}]}}}},"components/schemas/TransactionBatchInterceptState":{"id":"components/schemas/TransactionBatchInterceptState","kind":"json-schema","title":"TransactionBatchInterceptState","data":{"type":"string","enum":["PENDING","ALLOWED","DENIED","FAILED","SUSPENDED"]}},"components/schemas/BulkProcessOperationStatus":{"id":"components/schemas/BulkProcessOperationStatus","kind":"json-schema","title":"BulkProcessOperationStatus","data":{"type":"string","enum":["SUBMITTED","RUNNING","COMPLETED","FAILED","CANCELLED"]}},"components/schemas/IbanState":{"id":"components/schemas/IbanState","kind":"json-schema","title":"IbanState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the instrument indicating what it can and cannot do as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING: The instrument is pending creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVE: The instrument is in an active state and can be used in transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blockedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides more information as to why it was blocked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REJECTED: The instrument was rejected from being created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DESTROYED: The instrument has been permanently destroyed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destroyReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provides more information as to why it was destroyed."},"children":[]}]}]}]}],"enum":["PENDING","ACTIVE","BLOCKED","REJECTED","DESTROYED"]}},"components/schemas/PhoneNumber":{"id":"components/schemas/PhoneNumber","kind":"json-schema","title":"PhoneNumber","data":{"maxLength":20,"minLength":5,"pattern":"^\\+[0-9]+$","type":"string"}},"components/schemas/CardPaymentAuthorisationEvent":{"id":"components/schemas/CardPaymentAuthorisationEvent","kind":"json-schema","title":"CardPaymentAuthorisationEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorisation lifecycle event — the merchant asked the bank for funds, or an existing hold was adjusted / released. No money moves until clearing. Used inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPayment.events[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the parent card payment provides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardPaymentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so this lean variant doesn't repeat them. For a standalone version with that context attached, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentAuthorisationEventDetail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","subtype","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card-scheme network classification of the underlying transaction, representing the type of activity the authorisation is for. Reversal-vs-original lives on the separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["sale_purchases","cash_withdrawals","sales_with_cashback","mail_or_telephone_orders","account_funding"]},"reversal":{"type":"boolean","description":"True when this event is a reversal of a prior authorisation in the same lifecycle (e.g. merchant void, expiry, explicit cancellation). False for originals."},"result":{"description":"Approved or declined by the issuer. Populated on originals; omitted on reversals.","$ref":"#/components/schemas/CardPaymentEventResult"},"authorisationCategory":{"description":"Pre-auth (provisional hold, will clear separately) or final auth (estimated amount equals final amount).","$ref":"#/components/schemas/AuthorisationCategory"},"authForwardingDetails":{"description":"When the card is configured for auth forwarding, the forwarding context for this event.","$ref":"#/components/schemas/CardPaymentAuthForwardingDetails"},"declineReason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/CardPaymentDeclineReason"},"authRuleFailedReason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specific auth rule that caused the decline. Present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"declineReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTH_RULE_CHECKS_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mirrors the legacy authorisation webhook's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authRuleFailedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"cancellationReason":{"type":"string","maxLength":255,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text reason for an explicit cancellation of an authorisation hold. Populated on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events driven by explicit cancellation rather than network reversal."},"children":[]}]}]}]},"transactionAmount":{"description":"The amount for this event, in the merchant's currency (ISO 8583 DE 4).","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount applied to the card, in the card's currency (ISO 8583 DE 6).","$ref":"#/components/schemas/CurrencyAmount"},"forex":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth-time FX context — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"padding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Populated on cross-currency authorisations."},"children":[]}]}]}],"$ref":"#/components/schemas/CardPaymentForex"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code on this scheme message (ISO 8583 DE 38). Echoed by subsequent settlement, refund, OCT messages in the same lifecycle."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this event occurred at the point-of-interaction, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CardPaymentSettlementEvent":{"id":"components/schemas/CardPaymentSettlementEvent","kind":"json-schema","title":"CardPaymentSettlementEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A settlement event — money actually moves between the cardholder's account and the merchant, or back the other way. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Financial Transaction 0220 · Mastercard First Presentment 1240."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","subtype","settlementState","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"subtype":{"type":"string","description":"Card-scheme network classification of the underlying transaction being settled.","enum":["sale_purchases","cash_withdrawals","sales_with_cashback","mail_or_telephone_orders","account_funding"]},"reversal":{"type":"boolean","description":"True when this event reverses a prior settlement; funds return to the card. False for originals."},"settlementState":{"description":"Processing state of this settlement on the platform.","$ref":"#/components/schemas/CardPaymentSettlementState"},"transactionAmount":{"description":"The amount cleared, in the merchant's currency (ISO 8583 DE 4).","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount billed against the card, in the card's currency (ISO 8583 DE 6). May differ from any earlier authorisation due to final amount and forex movement.","$ref":"#/components/schemas/CurrencyAmount"},"exchangeRate":{"description":"Forex rate applied at clearing time.","$ref":"#/components/schemas/ScaledAmount"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code (ISO 8583 DE 38) echoed from the originating authorisation."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this settlement event occurred, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CardPaymentRefundEvent":{"id":"components/schemas/CardPaymentRefundEvent","kind":"json-schema","title":"CardPaymentRefundEvent","data":{"description":"A refund credited to the card, tied to an earlier purchase.","allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"reversal":{"type":"boolean","description":"True when this event reverses a prior refund (money was returned to the cardholder and is now being clawed back). False for an original refund credit."},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card-scheme network classification of the refund. Reversal-vs-original lives on the separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["purchase_refunds","purchase_refund_reversals"]},"reasonCode":{"type":"string","description":"Network reason code accompanying the event, when provided by the scheme."},"transactionAmount":{"description":"The amount credited / reversed, in the merchant's currency.","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount applied to the card, in the card's currency.","$ref":"#/components/schemas/CurrencyAmount"},"exchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forex rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code (ISO 8583 DE 38) echoed from the originating authorisation."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this event occurred, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CardPaymentOriginalCreditEvent":{"id":"components/schemas/CardPaymentOriginalCreditEvent","kind":"json-schema","title":"CardPaymentOriginalCreditEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A push credit to the card not tied to a prior purchase. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa Original Credit Transaction (OCT) · Mastercard MoneySend."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentEvent"},{"type":"object","required":["id","timestamp"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$"},"reversal":{"type":"boolean","description":"True when this event reverses a prior OCT (push credit being clawed back). False for an original push credit."},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card-scheme network classification of the OCT. Reversal-vs-original lives on the separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["original_credit_transactions","original_credit_transaction_reversals"]},"reasonCode":{"type":"string","description":"Network reason code accompanying the event, when provided by the scheme."},"transactionAmount":{"description":"The amount credited / reversed, in the merchant's currency.","$ref":"#/components/schemas/CurrencyAmount"},"billingAmount":{"description":"The amount applied to the card, in the card's currency.","$ref":"#/components/schemas/CurrencyAmount"},"exchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forex rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"userAmount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presentation-only amount to be shown to the cardholder in their app. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will only differ from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was set for the card during card creation."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"},"userExchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Presentation-only."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"authCode":{"type":"string","description":"Issuer authorisation code (ISO 8583 DE 38) echoed from the originating authorisation."},"fees":{"type":"array","description":"Fees applied as part of this specific event (e.g. interchange on a settlement, forex markup on an authorisation, chargeback fee on a dispute step).","items":{"$ref":"#/components/schemas/CardPaymentFee"}},"timestamp":{"type":"integer","format":"int64","description":"When this event occurred, Epoch millis."},"processedTimestamp":{"type":"integer","format":"int64","description":"When this event was processed by the platform, Epoch millis."}}}]}},"components/schemas/CorrespondentBankingBankAccountDetails":{"id":"components/schemas/CorrespondentBankingBankAccountDetails","kind":"json-schema","title":"CorrespondentBankingBankAccountDetails","data":{"required":["account","financialInstitution"],"type":"object","description":"Bank account details for the originator.","properties":{"account":{"type":"string","minLength":1,"maxLength":34,"pattern":"^[a-zA-Z0-9]{1,34}$","description":"Can be either an account number or an International Bank Account Number (IBAN)."},"financialInstitution":{"type":"string","minLength":8,"maxLength":11,"pattern":"^[a-zA-Z0-9]{8,11}$","description":"Bank Identifier Code (BIC) of the originator's financial institution."}}}},"components/schemas/CorrespondentBankingIndividualAddressAndIdInfo":{"id":"components/schemas/CorrespondentBankingIndividualAddressAndIdInfo","kind":"json-schema","title":"CorrespondentBankingIndividualAddressAndIdInfo","data":{"required":["documentType","documentNumber"],"type":"object","description":"Personal identification for an individual originator.","properties":{"documentType":{"type":"string","enum":["NATIONAL_ID","PASSPORT","TAX_ID","OTHER"],"description":"Type of personal identification document."},"documentNumber":{"type":"string","maxLength":35,"description":"Personal identification document number."}}}},"components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo":{"id":"components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo","kind":"json-schema","title":"CorrespondentBankingIndividualAddressAndBirthInfo","data":{"required":["dateOfBirth","placeOfBirth"],"type":"object","description":"Birth information for an individual originator.","properties":{"dateOfBirth":{"type":"string","format":"date","description":"Date of birth in YYYY-MM-DD format."},"placeOfBirth":{"type":"string","maxLength":140,"description":"Place of birth - city and country."}}}},"components/schemas/CorrespondentBankingBusinessAddressAndIdInfo":{"id":"components/schemas/CorrespondentBankingBusinessAddressAndIdInfo","kind":"json-schema","title":"CorrespondentBankingBusinessAddressAndIdInfo","data":{"required":["documentType","documentNumber"],"type":"object","description":"Business identification for a business originator.","properties":{"documentType":{"type":"string","enum":["LEI","REGISTRATION_NUMBER","TAX_ID","OTHER"],"description":"Type of business identification document."},"documentNumber":{"type":"string","maxLength":35,"description":"Business identification document number (e.g. LEI code, company registration number)."}}}},"components/schemas/CardPaymentEventResult":{"id":"components/schemas/CardPaymentEventResult","kind":"json-schema","title":"CardPaymentEventResult","data":{"type":"string","description":"Outcome of an authorisation event.","enum":["APPROVED","DECLINED"]}},"components/schemas/CardPaymentAuthForwardingDetails":{"id":"components/schemas/CardPaymentAuthForwardingDetails","kind":"json-schema","title":"CardPaymentAuthForwardingDetails","data":{"type":"object","description":"Details of auth-forwarding handling on the authorisation.","properties":{"triggered":{"type":"boolean","description":"True if auth forwarding was triggered for this authorisation."},"decisionOutcome":{"description":"Default decision applied if the innovator did not respond in time.","$ref":"#/components/schemas/CardPaymentAuthForwardingDecisionOutcome"},"innovatorTimedOut":{"type":"boolean","description":"True if the innovator failed to respond within the configured timeout and the default decision was applied."}}}},"components/schemas/CardPaymentDeclineReason":{"id":"components/schemas/CardPaymentDeclineReason","kind":"json-schema","title":"CardPaymentDeclineReason","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason an authorisation was declined; populated only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result = DECLINED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Mirrors the legacy authorisation webhook's decline reason values."},"children":[]}]}]}],"enum":["NO_REASON","PHYSICAL_NOT_ACTIVATED","INSUFFICIENT_BALANCE","CVV_CHECKS_FAILED","CVV_RETRIES_EXCEEDED","CARD_STATUS_NOT_ALLOWED","PIN_CHECKS_FAILED","PIN_RETRIES_EXCEEDED","CARD_EXPIRY_CHECKS_FAILED","AVS_CHECKS_FAILED","ATM_WITHDRAWAL_LIMIT_EXCEEDED","SCA_REQUIRED","AUTH_RULE_CHECKS_FAILED","TRANSACTION_NOT_PERMITTED","TIMEOUT","SINGLE_SPEND","EXCEEDS_PER_TRANSACTION_LIMIT"]}},"components/schemas/CardPaymentForex":{"id":"components/schemas/CardPaymentForex","kind":"json-schema","title":"CardPaymentForex","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth-time FX context: the rate applied at authorisation and the cushion blocked to cater for rate movement before settlement. Surfaced as a pair on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTHORISATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events only — on settlement/refund/oct the rate sits at the event top-level (it modifies that event's amounts directly) and padding has already been absorbed or released at clearing time."},"children":[]}]}]}],"properties":{"exchangeRate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate applied to convert "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billingAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at authorisation time. Populated on cross-currency authorisations."},"children":[]}]}]}],"$ref":"#/components/schemas/ScaledAmount"},"padding":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extra amount blocked at authorisation time to cater for currency fluctuation between auth and settlement. Already included in the event's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; surfaced separately so the embedder can show the cardholder how much of the charge is the FX cushion. Released or absorbed at clearing time."},"children":[]}]}]}],"$ref":"#/components/schemas/CurrencyAmount"}}}},"components/schemas/ScaledAmount":{"id":"components/schemas/ScaledAmount","kind":"json-schema","title":"ScaledAmount","data":{"type":"object","properties":{"value":{"type":"integer","format":"int64"},"scale":{"maximum":127,"minimum":-128,"type":"integer","format":"int32"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value * pow(10, -scale)."},"children":[]}]}]}]}},"components/schemas/CardPaymentFee":{"id":"components/schemas/CardPaymentFee","kind":"json-schema","title":"CardPaymentFee","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee accrued on a specific card payment event. Discriminated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLATFORM_FEE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentPlatformFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — fee charged by the platform; points at the underlying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FOREX_FEE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CardPaymentForexFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — forex padding + forex fee captured at authorisation on a cross-currency event."},"children":[]}]}]}]}],"required":["type"],"properties":{"type":{"$ref":"#/components/schemas/CardPaymentFeeType"}},"discriminator":{"propertyName":"type","mapping":{"PLATFORM_FEE":"#/components/schemas/CardPaymentPlatformFee","FOREX_FEE":"#/components/schemas/CardPaymentForexFee"}}}},"components/schemas/CardPaymentSettlementState":{"id":"components/schemas/CardPaymentSettlementState","kind":"json-schema","title":"CardPaymentSettlementState","data":{"type":"string","description":"Processing state of a settlement event at the scheme.","enum":["PENDING","COMPLETED"]}},"components/schemas/CardPaymentAuthForwardingDecisionOutcome":{"id":"components/schemas/CardPaymentAuthForwardingDecisionOutcome","kind":"json-schema","title":"CardPaymentAuthForwardingDecisionOutcome","data":{"type":"string","description":"Default decision applied if the innovator does not respond in time during auth-forwarding.","enum":["APPROVE","DECLINE"]}},"components/schemas/CardPaymentFeeType":{"id":"components/schemas/CardPaymentFeeType","kind":"json-schema","title":"CardPaymentFeeType","data":{"type":"string","enum":["PLATFORM_FEE","FOREX_FEE"]}},"components/schemas/CardPaymentPlatformFee":{"id":"components/schemas/CardPaymentPlatformFee","kind":"json-schema","title":"CardPaymentPlatformFee","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee charged by the platform on this card payment event (a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posted against the cardholder's instrument). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" points at the underlying fee transaction, retrievable in full via the Transaction Activity API."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentFee"},{"type":"object","required":["id","subtype","amount"],"properties":{"id":{"type":"string","pattern":"^[0-9]+$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the underlying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FeeTransaction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"subtype":{"description":"Category of fee.","$ref":"#/components/schemas/CardPaymentFeeSubtype"},"amount":{"description":"Fee amount, in the currency of the instrument the fee was applied to.","$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/CardPaymentForexFee":{"id":"components/schemas/CardPaymentForexFee","kind":"json-schema","title":"CardPaymentForexFee","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forex fee charged on a cross-currency event. Already included in the event's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — surfaced here so the embedder can show the cardholder how much of the charge was the forex fee."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/CardPaymentFee"},{"type":"object","properties":{"amount":{"description":"The forex fee charged on this event, in the currency of the instrument the fee was applied to.","$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/CardPaymentFeeSubtype":{"id":"components/schemas/CardPaymentFeeSubtype","kind":"json-schema","title":"CardPaymentFeeSubtype","data":{"type":"string","description":"The category of a platform fee accrued on a card payment event. Restricted to subtypes that can fire on card payments.","enum":["purchase_fees","refund_fees","atm_withdrawal_fees","withdrawal_fees","chargeback_fees","fee_reversals","custom_fees","other_fees"]}},"schema_716":{"kind":"json-schema","data":{"type":"string"},"id":"schema_716"},"schema_717":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_717"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"\"\""},{"url":"/_mock/products/webhooks/openapi","isMockServer":true,"description":"Mock server"}],"logo":{"imageUrl":"https://storage.googleapis.com/weavr-cdn/weavr_logo-new.png","href":"https://weavr.io","altText":"Weavr","backgroundColor":"#FFFFFF"}},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/products/webhooks/openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/webhooks/openapi.json?download"},{"url":"/_bundle/products/webhooks/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Weavr Webhook","description":"For Verification, create a base64 hash using HmacSHA256 using Published-Timestamp header as message and your API key as secret. The result should match the Signature header."}},"baseSlug":"/products/webhooks/openapi","routesMapping":{}}