{"items":[{"type":"link","label":"Overview","link":"/apis/outbound","routeSlug":"/apis/outbound","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"Contact","email":"viablocks-support@viamericas.com","label":"viablocks-support@viamericas.com","withCopyButton":true,"copyContent":"viablocks-support@viamericas.com"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://corporate.viamericas.com/wp-content/uploads/2025/09/Terms-and-Conditions-updated-September-2025.pdf"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Overview (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"textAlign":"center"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"img","attrs":{"src":"/assets/logo_viamericas.24a97b2aec7930c77c05c45c7c75dba4d888a24f4d6de869618cbf682346a484.9c1bb791.png","width":"60&#37"}},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ViaBlocks API Outbound is a secure, server-to-server REST API that enables regulated partners to create, manage, and track "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outbound cross-border money transfers from the United States to international destinations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the Viamericas network."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API supports the full outbound transaction lifecycle, including U.S.-based sender onboarding, international beneficiary onboarding, transaction creation, funding initiation, foreign exchange (FX) handling, payout execution, and end-to-end status monitoring."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partners interact with the platform through two primary endpoints:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /transaction/create"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — used to submit sender, beneficiary, and transfer details to initiate an outbound transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST /transaction/status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — used to retrieve the most recent processing status and lifecycle updates for an existing transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is designed for licensed and compliant U.S. partners and abstracts regulatory, compliance, routing, and payout complexities, allowing integrators to focus on building scalable international money transfer experiences."},"children":[]}]}]}]}],"sectionId":"/apis/outbound"}],"sectionId":"/apis/outbound"}]}]}},{"type":"group","label":"Beneficiary","link":"/apis/outbound/beneficiary","routeSlug":"/apis/outbound/beneficiary","items":[{"label":"/beneficiary","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/beneficiary/paths/~1beneficiary/post","routeSlug":"/apis/outbound/beneficiary/paths/~1beneficiary/post","metadata":{"seo":{"title":"/beneficiary","description":"Creates a new beneficiary (recipient) associated with a sender."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/beneficiary","isWebhook":false,"pointer":"/paths/~1beneficiary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/beneficiary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new beneficiary (recipient) associated with a sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/post/request/purpose","deepLinkHash":"/beneficiary/paths/~1beneficiary/post#beneficiary/paths/~1beneficiary/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers a new beneficiary in the system, linking them to a sender. If a beneficiary with the same full name already exists for that sender, the existing record is returned instead of creating a duplicate."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/post/request/how-it-works","deepLinkHash":"/beneficiary/paths/~1beneficiary/post#beneficiary/paths/~1beneficiary/post/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How It Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates the request fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks if a beneficiary with the same name already exists for the sender"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If new, creates the beneficiary with a unique UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the beneficiary UUID for use in transaction creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/post/request/important-notes","deepLinkHash":"/beneficiary/paths/~1beneficiary/post#beneficiary/paths/~1beneficiary/post/request/important-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A beneficiary can be shared across multiple senders"},"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":"senderUuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field identifies which sender this beneficiary belongs to"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the beneficiary already exists, the existing UUID is returned"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/post/request/authentication","deepLinkHash":"/beneficiary/paths/~1beneficiary/post#beneficiary/paths/~1beneficiary/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1beneficiary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/post/requestBody/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/post/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1beneficiary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beneficiary","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/post/requestBody/content/application~1json/examples/default"]}},"responseCodes":["200","400","401","404","422","500"],"pointer":"/beneficiary","href":"beneficiary/paths/~1beneficiary/post","summary":"/beneficiary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/post/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/post/requestBody/content/application~1json/examples/default"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Beneficiary created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1beneficiary/post/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1beneficiary/post/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"The request contains invalid or missing data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_validation"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_validation"]},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/post/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Sender not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1beneficiary/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1beneficiary/post/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Business rule violation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1beneficiary/post/responses/422/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1beneficiary/post/responses/422/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1beneficiary/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1beneficiary/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1beneficiary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1beneficiary/post/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1beneficiary/post/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_validation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_validation"]}}},{"code":"401","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/post/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1beneficiary/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1beneficiary/post/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1beneficiary/post/responses/422/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1beneficiary/post/responses/422/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1beneficiary/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1beneficiary/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficiary/paths/~1beneficiary/post"}],"panels":[]}]},"httpPath":"/beneficiary"},{"label":"/beneficiary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/beneficiary/paths/~1beneficiary/get","routeSlug":"/apis/outbound/beneficiary/paths/~1beneficiary/get","metadata":{"seo":{"title":"/beneficiary","description":"Retrieves a beneficiary by its UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/beneficiary","isWebhook":false,"pointer":"/paths/~1beneficiary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/beneficiary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a beneficiary by its UUID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/get/request/purpose","deepLinkHash":"/beneficiary/paths/~1beneficiary/get#beneficiary/paths/~1beneficiary/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the details of a specific beneficiary. Optionally validates that the beneficiary belongs to a given sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/get/request/query-parameters","deepLinkHash":"/beneficiary/paths/~1beneficiary/get#beneficiary/paths/~1beneficiary/get/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]}]},{"$$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":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required): UUID of the beneficiary to retrieve"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"senderUuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): If provided, verifies the beneficiary belongs to this sender"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/get/request/authentication","deepLinkHash":"/beneficiary/paths/~1beneficiary/get#beneficiary/paths/~1beneficiary/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"uuid","in":"query","schemaId":"schema_91","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of the beneficiary to retrieve."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"senderUuid","in":"query","schemaId":"schema_92","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of the sender. If provided, verifies the beneficiary belongs to this sender before returning it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1beneficiary/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_93","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_94","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1beneficiary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beneficiary","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"uuid","in":"query","required":true,"example":"string","schemaId":"schema_91"},{"name":"senderUuid","in":"query","required":false,"example":"string","schemaId":"schema_92"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_93"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_94"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/beneficiary","href":"beneficiary/paths/~1beneficiary/get","summary":"/beneficiary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Beneficiary retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1beneficiary/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1beneficiary/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Missing required query parameter.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1beneficiary/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1beneficiary/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Beneficiary not found or does not belong to the sender.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1beneficiary/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1beneficiary/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1beneficiary/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1beneficiary/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1beneficiary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1beneficiary/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1beneficiary/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1beneficiary/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1beneficiary/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1beneficiary/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1beneficiary/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1beneficiary/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1beneficiary/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficiary/paths/~1beneficiary/get"}],"panels":[]}]},"httpPath":"/beneficiary"},{"label":"/beneficiary","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/beneficiary/paths/~1beneficiary/put","routeSlug":"/apis/outbound/beneficiary/paths/~1beneficiary/put","metadata":{"seo":{"title":"/beneficiary","description":"Updates an existing beneficiary's information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/beneficiary","isWebhook":false,"pointer":"/paths/~1beneficiary/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/beneficiary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing beneficiary's information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/put/request/purpose","deepLinkHash":"/beneficiary/paths/~1beneficiary/put#beneficiary/paths/~1beneficiary/put/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows modification of a beneficiary's personal details, contact information, and address. Only fields included in the request will be updated; omitted fields retain their current values."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"beneficiary/paths/~1beneficiary/put/request/authentication","deepLinkHash":"/beneficiary/paths/~1beneficiary/put#beneficiary/paths/~1beneficiary/put/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_93","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_94","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1beneficiary/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/put/requestBody/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/put/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1beneficiary/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beneficiary","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_93"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_94"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/put/requestBody/content/application~1json/examples/default"]}},"responseCodes":["200","400","401","500"],"pointer":"/beneficiary","href":"beneficiary/paths/~1beneficiary/put","summary":"/beneficiary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/put/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST","exampleIds":["paths/~1beneficiary/put/requestBody/content/application~1json/examples/default"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Beneficiary updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1beneficiary/put/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1beneficiary/put/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_missing_uuid","paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_validation"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_missing_uuid","paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_validation"]},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/put/responses/401/content/application~1json/examples/default"]},{"code":"500","description":"Internal error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1beneficiary/put/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1beneficiary/put/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1beneficiary/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1beneficiary/put/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1beneficiary/put/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_missing_uuid","paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_validation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_missing_uuid","paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_validation"]}}},{"code":"401","schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1beneficiary/put/responses/401/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1beneficiary/put/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1beneficiary/put/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/beneficiary/paths/~1beneficiary/put"}],"panels":[]}]},"httpPath":"/beneficiary"}],"content":{"contentType":"group","meta":{"name":"Beneficiary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Beneficiary","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beneficiary","summary":"/beneficiary","prefix":{"name":"post","color":"post"},"badges":[],"link":"/beneficiary/paths/~1beneficiary/post","deprecated":false},{"title":"/beneficiary","summary":"/beneficiary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/beneficiary/paths/~1beneficiary/get","deprecated":false},{"title":"/beneficiary","summary":"/beneficiary","prefix":{"name":"put","color":"put"},"badges":[],"link":"/beneficiary/paths/~1beneficiary/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Catalogs","link":"/apis/outbound/catalogs","routeSlug":"/apis/outbound/catalogs","items":[{"label":"catalogs/account-types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1account-types/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1account-types/get","metadata":{"seo":{"title":"catalogs/account-types","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/account-types","isWebhook":false,"pointer":"/paths/~1catalogs~1account-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/account-types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1account-types/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1account-types/get#catalogs/paths/~1catalogs~1account-types/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available bank account types (e.g., Checking, Savings) used for bank deposit delivery methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1account-types/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1account-types/get#catalogs/paths/~1catalogs~1account-types/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate account type dropdowns or selection fields in the UI"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate the account type before submitting a bank deposit transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display available account types when the recipient's delivery method requires a bank account"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1account-types/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1account-types/get#catalogs/paths/~1catalogs~1account-types/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1account-types/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1account-types/get#catalogs/paths/~1catalogs~1account-types/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account types returned are global and not country-specific"},"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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is used as the value when submitting transactions with bank deposit delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results include standard types such as Checking and Savings"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1account-types/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1account-types/get#catalogs/paths/~1catalogs~1account-types/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No account types found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1account-types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1account-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/account-types","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/account-types","href":"catalogs/paths/~1catalogs~1account-types/get","summary":"catalogs/account-types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of available bank account types.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1account-types/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1account-types/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1account-types/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1account-types/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1account-types/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1account-types/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1account-types/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1account-types/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1account-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1account-types/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1account-types/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1account-types/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1account-types/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1account-types/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1account-types/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1account-types/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1account-types/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1account-types/get"}],"panels":[]}]},"httpPath":"/catalogs/account-types"},{"label":"/catalogs/all-endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1all-endpoints/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1all-endpoints/get","metadata":{"seo":{"title":"/catalogs/all-endpoints","description":"/catalogs/all-endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/catalogs/all-endpoints","isWebhook":false,"pointer":"/paths/~1catalogs~1all-endpoints/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/catalogs/all-endpoints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_98","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., USA, MEX, COL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"example":"string"},{"name":"deliveryMode","in":"path","schemaId":"schema_99","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode: P (Payout/Cash Pickup), C (Cash Delivery), O (Other)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"example":"P"},{"name":"deliveryLocationNetwork","in":"path","schemaId":"schema_100","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout location network code (e.g., ELEKTRA, OXXO, 059568AA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"addressZipCode","in":"path","schemaId":"schema_101","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/ZIP code for location lookup"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1catalogs~1all-endpoints/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filterValue","in":"query","schemaId":"schema_102","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filter value for location lookup (used in master/location endpoint)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"deliveryLocationCode","in":"query","schemaId":"schema_103","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery location code for payers-rules endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1all-endpoints/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_104","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner client identifier for authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_105","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner secret key for authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1all-endpoints/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/all-endpoints","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":false,"example":"string","schemaId":"schema_98"},{"name":"deliveryMode","in":"path","required":false,"example":"P","schemaId":"schema_99"},{"name":"deliveryLocationNetwork","in":"path","required":false,"example":"string","schemaId":"schema_100"},{"name":"addressZipCode","in":"path","required":false,"example":"string","schemaId":"schema_101"}],"query":[{"name":"filterValue","in":"query","required":false,"example":"string","schemaId":"schema_102"},{"name":"deliveryLocationCode","in":"query","required":false,"example":"string","schemaId":"schema_103"},{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_104"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_105"}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/catalogs/all-endpoints","href":"catalogs/paths/~1catalogs~1all-endpoints/get","summary":"/catalogs/all-endpoints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success"}],"pointer":"/paths/~1catalogs~1all-endpoints/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1all-endpoints/get"}],"panels":[]}]},"httpPath":"/catalogs/all-endpoints"},{"label":"catalogs/countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries/get","metadata":{"seo":{"title":"catalogs/countries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries","isWebhook":false,"pointer":"/paths/~1catalogs~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries/get#catalogs/paths/~1catalogs~1countries/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available destination countries for outbound transactions. Each country includes its ISO 3166-1 alpha-3 code and name."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries/get#catalogs/paths/~1catalogs~1countries/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate a destination country selector in the UI"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain the list of countries available for the partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a country code before requesting states or a quote"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries/get/request/what-happens-next","deepLinkHash":"/catalogs/paths/~1catalogs~1countries/get#catalogs/paths/~1catalogs~1countries/get/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What Happens Next"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After selecting a country, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch states: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/states"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch currencies: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/currencies"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch delivery methods: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries/get#catalogs/paths/~1catalogs~1countries/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries/get#catalogs/paths/~1catalogs~1countries/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns only countries enabled for the partner's configuration"},"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":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field uses ISO 3166-1 alpha-3 codes (3 uppercase letters)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are sorted alphabetically by country name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries/get#catalogs/paths/~1catalogs~1countries/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"401000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid credentials (verify x-client-id and x-secret-key headers)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partner not authorized for this endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Internal server error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_90"}],"cookie":[]},"security":[],"responseCodes":["200","401","403","500"],"pointer":"/catalogs/countries","href":"catalogs/paths/~1catalogs~1countries/get","summary":"catalogs/countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of available destination countries.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries/get/responses/200/content/application~1json/examples/default"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries/get/responses/403/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries/get/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries/get/responses/403/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries/get"}],"panels":[]}]},"httpPath":"/catalogs/countries"},{"label":"catalogs/countries/{deliveryCountryISO}/currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/currencies","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/currencies","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/currencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available currencies for a specific destination country. Used to determine which currencies are supported for delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate currency selection fields after the user selects a destination country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate the delivery currency before requesting a quote or creating a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display available currency options for a given country"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are filtered by the destination country provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ISO 4217) is used when submitting quotes and transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A country may support multiple delivery currencies"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No currencies found for the given country"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_98","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., USA, MEX, COL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/currencies","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_98"}],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/currencies","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get","summary":"catalogs/countries/{deliveryCountryISO}/currencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of available currencies for the specified country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/currencies"},{"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/deliver-methods","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/deliver-methods","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available delivery methods for a specific destination country (e.g., bank deposit, cash pickup, mobile wallet, home delivery)."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate delivery method selection fields after the user selects a destination country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determine which delivery modes are available before requesting a quote"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display delivery method options with their descriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are filtered by the destination country provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery mode "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., 'C' for bank deposit, 'P' for cash pickup, 'E' for mobile wallet, 'H' for home delivery) is used in subsequent API calls such as payouts and payers-rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available methods vary by country and partner configuration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No delivery methods found for the given country"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_98","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., USA, MEX, COL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/deliver-methods","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_98"}],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/deliver-methods","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of available delivery methods for the specified country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},{"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the payout locations (payers) available for a delivery method in a destination country, together with their real exchange-rate tiers and transaction limits. Unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which lists only the payout networks, this endpoint returns the pricing a partner needs to build a payer-selection UI: per-payer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tiers and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dolarLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nationalLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ceilings."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present the payout locations for a corridor with their exchange rates and limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show the rate tiers ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that apply as the send amount grows"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read the effective payout ceiling ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for a payer before quoting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Exchange rates and the available payers depend on the branch, most chains operate more than one branch, and there is no safe default, so the caller must state which branch the quote is for. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that does not belong to the authenticated partner's chain is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400416"},"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":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The pricing source filters payout locations by currency and treats an absent currency as matching nothing, so omitting it would return an empty list rather than \"all currencies\". Supply the ISO 4217 code (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MXN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of the payout currency you are pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"networkPayment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'Y'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'N'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The sibling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint also returns a boolean, so the two agree."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ maxAmount, rate }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tiers ordered ascending by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with consecutive equal rates merged keeping the higher ceiling. A payer with no configured range returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rates: []"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — that is a real payer with no published tier, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a zero rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array is a legitimate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", never a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It means either there are no payers for that corridor/currency, or (for USA delivery mode "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") the ATM gate blocked the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dolarLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" semantics "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"diverge by environment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": it is computed where a dollar limit is configured and returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where none is. Treat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the reliable payout ceiling. This is an open product risk, so rely on the observable value rather than assuming a fixed meaning."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (USA, ATM):"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO=USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryMode=A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", availability is checked against the ATM network before payers are returned. When no ATM is reachable for the city, or the city is excluded, the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. This is expected behaviour a client must handle, not an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The separate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not deprecated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": 7 of 8 active partners still list it in their allowed resources, so it remains available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Migration cost from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" consolidates what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sourced from different upstream fields on those two endpoints ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idpayout"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentLocationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), so it cannot be used to join them. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also exposes PascalCase names ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AddressBranch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WhatToBring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BusinessHours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubDivisionCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses camelCase ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressBranch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"whatToBring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessHours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), so partners migrating off "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will see those fields renamed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields, unresolved subdivision or currency, or branchId not in the partner's chain)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A required field is missing (branchId or deliveryAmountCurrencyISO)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A field does not match the required pattern (e.g. deliveryCountryISO is not 3 uppercase letters)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A value is not in the allowed list, or a supplied addressState/deliveryAmountCurrencyISO does not resolve"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The branchId does not belong to the authenticated partner's chain"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error (unexpected exception)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Database error while fetching payout pricing"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_106","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., MEX, COL, BRA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"deliveryMode","in":"path","schemaId":"schema_107","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode code that defines the payout execution method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how and where the funds will be delivered to the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the delivery methods available according to your delivery country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Delivery Methods: GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery modes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery Mode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CAJERO ELEC."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an ATM (electronic cashier)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"B"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK (DEPOSIT)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Direct deposit to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"D"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash delivered to the recipient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s address with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRODUCTOS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product-based delivery (specialized)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Home delivery with super/premium configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"G"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Super home delivery (premium, alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Priority delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B with super configuration (alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"L"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unified Payments Interface (India)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"N"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"O"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"P"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE (CASH)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an authorized location (office)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NOT USED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reserved code (not currently in use)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"T"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"V"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX instant payment (Brazil)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The availability of delivery methods may vary by destination country, partner configuration, and Viamericas internal operational settings. Always consult the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to obtain the methods currently available for your integration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO=USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryMode=A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ATM), payout availability is additionally gated by the ATM network: an unreachable or excluded city yields a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"required":true,"example":"A"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"branchId","in":"query","schemaId":"schema_108","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch the quote is for. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": exchange rates and the set of available payers depend on the branch, most chains operate more than one branch, and there is no safe default. Validated against the authenticated partner's chain; a branchId belonging to another chain is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400416"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"deliveryAmountCurrencyISO","in":"query","schemaId":"schema_109","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout currency as an ISO 4217 code (3 uppercase letters, e.g., USD, COP, MXN). "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the pricing source filters payout locations by currency and treats an absent currency as matching nothing, so omitting it returns an empty list rather than all currencies. A currency that does not resolve to a supported payout currency is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400010"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use the same value you would pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAmountCurrencyISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"addressState","in":"query","schemaId":"schema_110","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional destination subdivision as an ISO 3166-2 code. Both the prefixed form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CO-ANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and the bare form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are accepted. When supplied but not recognized for the destination country, the request is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400010"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than silently widening the result. Obtain valid values from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/states"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"cityId","in":"query","schemaId":"schema_111","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional internal city identifier used to narrow payout locations to a specific city. Passed through to the pricing source unchanged. Obtain valid values from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/states/{addressState}/cities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"validations","in":"query","schemaId":"schema_112","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the validation schema instead of executing the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_106"},{"name":"deliveryMode","in":"path","required":true,"example":"A","schemaId":"schema_107"}],"query":[{"name":"branchId","in":"query","required":true,"example":"string","schemaId":"schema_108"},{"name":"deliveryAmountCurrencyISO","in":"query","required":true,"example":"string","schemaId":"schema_109"},{"name":"addressState","in":"query","required":false,"example":"string","schemaId":"schema_110"},{"name":"cityId","in":"query","required":false,"example":"string","schemaId":"schema_111"},{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_112"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout locations (payers) with their rate tiers and limits for the specified country, delivery method, branch, and currency. An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array is a valid response (no payers for the corridor/currency, or the ATM gate blocked a USA delivery mode "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/200_empty"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/200_empty"]},{"code":"400","description":"Validation error - missing or invalid headers, path parameters, or query parameters (including an unresolved subdivision/currency or a branchId that does not belong to the partner's chain).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_branch_wrong_chain","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_unresolved_currency"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_branch_wrong_chain","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_unresolved_currency"]},{"code":"401","description":"Authentication failed - invalid credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Authorization failed - partner not allowed to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/403/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error, including a database error while fetching payout pricing.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/200_empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/200_empty"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_branch_wrong_chain","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_unresolved_currency"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_branch_wrong_chain","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_unresolved_currency"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/403/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers"},{"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the dynamic field rules and validation requirements for a specific delivery method and payer in a destination country. Defines which fields are required, optional, or hidden when collecting recipient information for transaction creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamically build recipient forms based on the selected country, delivery method, and payer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determine which fields are required vs optional for a specific payer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate field lengths, formats, and constraints before submitting transaction data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Know exactly which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field each rule corresponds to"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/the-mappedfield-property","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/the-mappedfield-property"},"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":"mappedField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Property"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each rule in the response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property that indicates the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exact field path"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request body where the collected value must be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/how-to-use-mappedfield","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/how-to-use-mappedfield"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call this endpoint to get the dynamic rules for the selected payer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each rule, read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to know where the value goes in the create request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collect values from the user according to the rule constraints (type, minLength, maxLength, pattern, allowedValues)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", place each value at the path indicated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/mapping-reference","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/mapping-reference"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mapping Reference"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rule name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHONE1_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender.phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender phone number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PHONE1_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary.phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary phone number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TYPEID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary.documentType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary ID document type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMID"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary.documentNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary ID document number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACC_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionInformation.deliveryModeDetails.accountNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account/CLABE number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionInformation.deliveryModeDetails.routingNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing/bank code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_NAME_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionInformation.deliveryModeDetails.bankName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLABE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionInformation.deliveryModeDetails.accountNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CLABE number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNT_TYPE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionInformation.deliveryModeDetails.accountType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDRESS_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary.addressStreet"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary address"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COUNTRY_BIRTH_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender.addressCountry"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender country"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID_TYPE_ID_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender.documentType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender document type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER_ID_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender.documentNumber"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender document number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEN_FUNDSWILLBEUSEDFOR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionInformation.sourceOfFounds"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source of funds"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOV_EMPLOYEE_SENDER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender.governmentEmployee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender government employee (VEN only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOV_EMPLOYEE_RECEIVER"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beneficiary.governmentEmployee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary government employee (VEN only)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/rules-without-mappedfield","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/rules-without-mappedfield"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a rule does not have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property, the value should be sent via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additionalFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array in the create request."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/country-specific-compliance-rules","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/country-specific-compliance-rules"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country-Specific Compliance Rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For certain destination countries, additional required rules are appended to the response:"},"children":[]}]}]},{"$$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":"Venezuela (VEN)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Two additional required fields are added asking whether the sender and beneficiary work for the Venezuelan government or a state-owned company."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These follow the exact same structure as standard rules and include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mappedField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules are specific to the combination of country, delivery method, and payer code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each rule defines field metadata: type, min/max length, required status, regex patterns, and allowed values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowedValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include predefined options (array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{id, value}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isHidden: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should not be displayed to the user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided in the transaction create request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No payer rules found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required field missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No payer rules found for the given parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_106","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., MEX, COL, BRA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"deliveryMode","in":"path","schemaId":"schema_113","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode code that defines the payout execution method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how and where the funds will be delivered to the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the delivery methods available according to your delivery country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Delivery Methods: GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery modes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery Mode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CAJERO ELEC."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an ATM (electronic cashier)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"B"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK (DEPOSIT)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Direct deposit to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"D"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash delivered to the recipient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s address with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRODUCTOS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product-based delivery (specialized)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Home delivery with super/premium configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"G"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Super home delivery (premium, alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Priority delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B with super configuration (alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"L"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unified Payments Interface (India)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"N"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"O"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"P"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE (CASH)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an authorized location (office)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NOT USED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reserved code (not currently in use)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"T"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"V"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX instant payment (Brazil)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The availability of delivery methods may vary by destination country, partner configuration, and Viamericas internal operational settings. Always consult the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to obtain the methods currently available for your integration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"required":true,"example":"A"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deliveryLocationCode","in":"query","schemaId":"schema_114","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payer code (ProcessedByCode) obtained from the payouts endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"deliveryLocationNetwork","in":"query","schemaId":"schema_115","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout network code obtained from the payouts endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (e.g., '005141AA', 'ELEKTRA')"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"senderUuid","in":"query","schemaId":"schema_116","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional sender UUID. When provided, payer rules may include personalized field values (e.g., pre-filled phone number for hidden sender fields). If omitted, the property is sent empty to prevent errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"example":"string"},{"name":"language","in":"query","schemaId":"schema_117","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language for localized response fields (labelText, errorMessage). Defaults to 'en' if omitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"en"},{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_106"},{"name":"deliveryMode","in":"path","required":true,"example":"A","schemaId":"schema_113"}],"query":[{"name":"deliveryLocationCode","in":"query","required":true,"example":"string","schemaId":"schema_114"},{"name":"deliveryLocationNetwork","in":"query","required":true,"example":"string","schemaId":"schema_115"},{"name":"senderUuid","in":"query","required":false,"example":"string","schemaId":"schema_116"},{"name":"language","in":"query","required":false,"example":"en","schemaId":"schema_117"},{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Object containing payer field rules. Each item in the data array represents a dynamic field rule with validation constraints, localized labels, and the mappedField path indicating where to send the value in POST /transaction/create.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/200_no_country_rules"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/200_no_country_rules"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error ΓÇö missing or invalid parameters."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed ΓÇö invalid credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed ΓÇö resource not allowed for this partner."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"No payer rules found for the given parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/200_no_country_rules"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/200_no_country_rules"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules"},{"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available payout networks/agents for a specific delivery method in a destination country. These represent the payment networks or institutions where the recipient can collect funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate payout network selection fields after the user selects a country and delivery method"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display available payout agents (e.g., Elektra, BanCoppel) for cash pickup"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value required for quote and transaction creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are filtered by the combination of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameters"},"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":"deliveryLocationNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from this response is used in quote requests and transaction creation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available payout networks vary by country, delivery method, and partner configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" return pricing. Exchange rates, fees, and transaction limits per payout location are served by the dedicated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters filter the results upstream. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is NOT an ISO 4217 code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (destination local currency) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (US dollars) are accepted. Any other value matches no payout network and returns an empty list"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No payout networks found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No payout networks found for the given country and delivery method"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_106","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., MEX, COL, BRA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"deliveryMode","in":"path","schemaId":"schema_113","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode code that defines the payout execution method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how and where the funds will be delivered to the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the delivery methods available according to your delivery country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Delivery Methods: GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery modes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery Mode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CAJERO ELEC."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an ATM (electronic cashier)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"B"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK (DEPOSIT)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Direct deposit to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"D"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash delivered to the recipient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s address with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRODUCTOS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product-based delivery (specialized)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Home delivery with super/premium configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"G"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Super home delivery (premium, alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Priority delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B with super configuration (alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"L"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unified Payments Interface (India)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"N"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"O"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"P"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE (CASH)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an authorized location (office)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NOT USED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reserved code (not currently in use)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"T"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"V"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX instant payment (Brazil)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The availability of delivery methods may vary by destination country, partner configuration, and Viamericas internal operational settings. Always consult the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to obtain the methods currently available for your integration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"required":true,"example":"A"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currencyMode","in":"query","schemaId":"schema_118","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional payout currency mode used to filter payout networks. This is NOT an ISO 4217 code. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = the destination country's local currency, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = US dollars. Any other value matches no payout network and yields an empty list. Forwarded upstream to the catalog service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"example":"N"},{"name":"cityName","in":"query","schemaId":"schema_119","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional city name used to narrow payout networks to those operating in a specific city. Forwarded upstream to the catalog service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_106"},{"name":"deliveryMode","in":"path","required":true,"example":"A","schemaId":"schema_113"}],"query":[{"name":"currencyMode","in":"query","required":false,"example":"N","schemaId":"schema_118"},{"name":"cityName","in":"query","required":false,"example":"string","schemaId":"schema_119"},{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of available payout networks for the specified country and delivery method.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_colombia_bank","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_brazil_pix"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_colombia_bank","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_brazil_pix"]},{"code":"400","description":"Validation error - missing or invalid required headers or path parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication failed - invalid credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Authorization failed - partner not allowed to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"No payout networks found for the given country and delivery method combination","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_colombia_bank","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_brazil_pix"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_colombia_bank","paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_brazil_pix"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts"},{"label":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get","metadata":{"seo":{"title":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","description":"Retrieves payout location details for a specific delivery network in a country and delivery mode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves payout location details for a specific delivery network in a country and delivery mode."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of physical locations (branches, agents) where the beneficiary can pick up the remittance, including address, business hours, and geographic subdivision information."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to:"},"children":[]}]}]},{"$$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":"Display available pickup locations to the sender or beneficiary"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get branch addresses, business hours, and requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain the subdivision (state/department) code for a location (ISO 3166-2)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/path-parameters","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/path-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path Parameters"},"children":[]}]}]},{"$$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":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — ISO 3166-1 alpha-3 country code (e.g., COL, MEX)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryMode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Delivery method code (e.g., P for cash pickup, C for bank deposit)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Payout network identifier (e.g., BC0001)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubDivisionCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the ISO 3166-2 subdivision code (e.g., ANT for Antioquia, AMA for Amazonas)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CountryCodeISO2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the ISO 3166-1 alpha-2 country code (e.g., CO)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CountryCodeISO3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns the ISO 3166-1 alpha-3 country code (e.g., COL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response is proxied from Govianex Catalogs API with field transformation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Missing or invalid path parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Partner not authorized for this catalog endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error or upstream service unavailable"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get","summary":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of payout locations for the specified network, country, and delivery mode.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Response fail validations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Response fail authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Response fail authorization - partner not authorized for this endpoint","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/403/content/application~1json/examples/default"]},{"code":"500","description":"Response fail - Internal Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/403/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations"},{"label":"catalogs/countries/{deliveryCountryISO}/identifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/identifications","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/identifications","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/identifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of accepted identification document types for a specific destination country. Used to determine which ID types are valid for sender or recipient verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate identification type dropdowns for sender or beneficiary forms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate the ID type before submitting sender or beneficiary data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display country-specific identification requirements"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are filtered by the destination country provided in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted ID types vary by country (e.g., passport, national ID, driver's license)"},"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":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code is used when creating or updating sender/beneficiary records"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expirationDateRequired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backSideRequired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicate additional document capture requirements"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No identification types found for the given country"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_98","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., USA, MEX, COL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/identifications","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_98"}],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/identifications","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get","summary":"catalogs/countries/{deliveryCountryISO}/identifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of accepted identification document types for the specified country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/identifications"},{"label":"catalogs/countries/{deliveryCountryISO}/states","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/states","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/states","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/states","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of states/provinces for a specific destination country, using ISO 3166-2 codes as identifiers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate a state/province selector after the user selects a destination country"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain the ISO 3166-2 state code required for beneficiary or sender address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a state code before creating a transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/what-happens-next","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What Happens Next"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After selecting a state, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch cities: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/states/{addressState}/cities"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use directly as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in sender or beneficiary data when creating a transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State identifiers use ISO 3166-2 format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{countryISO2}-{stateCode}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MX-JAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Jalisco, Mexico)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For USA, the format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US-CA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"US-TX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are sorted alphabetically by state name"},"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":"addressState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returned here is the same value expected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the sender and beneficiary "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all countries have states/provinces — some may return an empty array"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Partner not authorized for this endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_120","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (e.g., MEX, COL, USA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/states","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_120"}],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_90"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/states","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get","summary":"catalogs/countries/{deliveryCountryISO}/states"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of states/provinces for the specified country with ISO 3166-2 codes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_usa"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_usa"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — invalid path parameter format or value."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"No states found for the given country.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_usa"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_usa"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/states"},{"label":"catalogs/countries/{deliveryCountryISO}/states/{stateISO}/cities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get","metadata":{"seo":{"title":"catalogs/countries/{deliveryCountryISO}/states/{stateISO}/cities","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/countries/{deliveryCountryISO}/states/{stateISO}/cities","isWebhook":false,"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/countries/{deliveryCountryISO}/states/{stateISO}/cities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of cities for a specific state/province within a destination country."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate a city selector after the user selects a state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain the city identifier required for beneficiary address"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a city before creating a transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/what-happens-next","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What Happens Next"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After selecting a city, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in the beneficiary "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressCity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when creating a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City identifiers are internal IDs (not ISO codes — there is no ISO standard for cities)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are sorted alphabetically by city name"},"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":"stateISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter must use the ISO 3166-2 format returned by the states endpoint (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MX-JAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cityName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressCity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value in transaction creation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get#catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Partner not authorized for this endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryCountryISO","in":"path","schemaId":"schema_120","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country ISO 3166-1 alpha-3 code (e.g., MEX, COL, USA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"addressState","in":"path","schemaId":"schema_121","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-2 state/province code as returned by the states endpoint (e.g., MX-JAL, US-CA, CO-ANT)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/countries/{deliveryCountryISO}/states/{addressState}/cities","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"deliveryCountryISO","in":"path","required":true,"example":"string","schemaId":"schema_120"},{"name":"addressState","in":"path","required":true,"example":"string","schemaId":"schema_121"}],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_90"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/catalogs/countries/{deliveryCountryISO}/states/{addressState}/cities","href":"catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get","summary":"catalogs/countries/{deliveryCountryISO}/states/{stateISO}/cities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of cities for the specified state.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_usa"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_usa"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — invalid path parameter format or value."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"No cities found for the given state.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_usa"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/default","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_colombia","paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_usa"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get"}],"panels":[]}]},"httpPath":"/catalogs/countries/{deliveryCountryISO}/states/{addressState}/cities"},{"label":"catalogs/funds-origin","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1funds-origin/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1funds-origin/get","metadata":{"seo":{"title":"catalogs/funds-origin","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/funds-origin","isWebhook":false,"pointer":"/paths/~1catalogs~1funds-origin/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/funds-origin","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1funds-origin/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1funds-origin/get#catalogs/paths/~1catalogs~1funds-origin/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available funds origin/source options for remittance transactions. These describe where the sender's money comes from."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1funds-origin/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1funds-origin/get#catalogs/paths/~1catalogs~1funds-origin/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate funds origin dropdowns or selection fields in the transaction form"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate the source of funds before submitting a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display available options for compliance-related fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1funds-origin/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1funds-origin/get#catalogs/paths/~1catalogs~1funds-origin/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1funds-origin/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1funds-origin/get#catalogs/paths/~1catalogs~1funds-origin/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The funds origin options are global and not country-specific"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field may be required depending on the destination country's compliance rules"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1funds-origin/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1funds-origin/get#catalogs/paths/~1catalogs~1funds-origin/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No funds origin options found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1funds-origin/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1funds-origin/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/funds-origin","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/funds-origin","href":"catalogs/paths/~1catalogs~1funds-origin/get","summary":"catalogs/funds-origin"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of funds origin options with their descriptions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1funds-origin/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1funds-origin/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1funds-origin/get"}],"panels":[]}]},"httpPath":"/catalogs/funds-origin"},{"label":"catalogs/google-maps-api","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1google-maps-api/post","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1google-maps-api/post","metadata":{"seo":{"title":"catalogs/google-maps-api","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/google-maps-api","isWebhook":false,"pointer":"/paths/~1catalogs~1google-maps-api/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/google-maps-api","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1google-maps-api/post/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1google-maps-api/post#catalogs/paths/~1catalogs~1google-maps-api/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides Google Maps API integration for address autocomplete and geocoding. Proxies requests to Google Maps services through ViaBlocks authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1google-maps-api/post/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1google-maps-api/post#catalogs/paths/~1catalogs~1google-maps-api/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autocomplete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Get address suggestions as the user types (type-ahead)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Geocode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Resolve a full address to structured components (street, city, state, zip, country)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1google-maps-api/post/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1google-maps-api/post#catalogs/paths/~1catalogs~1google-maps-api/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1google-maps-api/post/request/request-behavior","deepLinkHash":"/catalogs/paths/~1catalogs~1google-maps-api/post#catalogs/paths/~1catalogs~1google-maps-api/post/request/request-behavior"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request Behavior"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"autocomplete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for address suggestions or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"geocode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for full address resolution"},"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":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the user input (partial or full address)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally restrict results to specific countries using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array (ISO 2 codes)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1google-maps-api/post/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1google-maps-api/post#catalogs/paths/~1catalogs~1google-maps-api/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field accepts ISO 2 letter codes (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autocomplete returns a list of suggested addresses; geocode returns structured address components"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response structure varies by event type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1google-maps-api/post/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1google-maps-api/post#catalogs/paths/~1catalogs~1google-maps-api/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"address is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"event is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"event must be one of: geocode, autocomplete"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1google-maps-api/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1google-maps-api/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST","exampleIds":["paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/autocomplete_request","paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/geocode_request"]}},"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST","exampleIds":["paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/autocomplete_request","paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/geocode_request"],"pointer":"/paths/~1catalogs~1google-maps-api/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/catalogs/google-maps-api","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST","exampleIds":["paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/autocomplete_request","paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/geocode_request"]}},"responseCodes":["200","400","401","500"],"pointer":"/catalogs/google-maps-api","href":"catalogs/paths/~1catalogs~1google-maps-api/post","summary":"catalogs/google-maps-api"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST","exampleIds":["paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/autocomplete_request","paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/geocode_request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST","exampleIds":["paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/autocomplete_request","paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/geocode_request"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response. Structure varies by event type (autocomplete returns suggestions array, geocode returns structured address components).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/401/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1google-maps-api/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/401/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1google-maps-api/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1google-maps-api/post"}],"panels":[]}]},"httpPath":"/catalogs/google-maps-api"},{"label":"catalogs/industry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get","metadata":{"seo":{"title":"catalogs/industry","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/industry","isWebhook":false,"pointer":"/paths/~1catalogs~1industry/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/industry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1industry/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1industry/get#catalogs/paths/~1catalogs~1industry/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of industries and occupations available for sender profile information. Used for compliance and KYC data collection."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1industry/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1industry/get#catalogs/paths/~1catalogs~1industry/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate industry/occupation dropdowns in the sender registration or update forms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate the sender's occupation before submitting a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display available industry categories with their associated job titles"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1industry/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1industry/get#catalogs/paths/~1catalogs~1industry/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1industry/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1industry/get#catalogs/paths/~1catalogs~1industry/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results include industry categories with nested job/occupation lists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The industry and occupation fields may be required depending on compliance rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data is returned in a hierarchical structure: each industry contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array with occupation entries"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1industry/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1industry/get#catalogs/paths/~1catalogs~1industry/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No industries found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1industry/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1industry/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/industry","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/industry","href":"catalogs/paths/~1catalogs~1industry/get","summary":"catalogs/industry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of industry categories, each containing a nested array of job titles/occupations.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1industry/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1industry/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1industry/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1industry/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1industry/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1industry/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1industry/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1industry/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1industry/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1industry/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1industry/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1industry/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1industry/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1industry/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1industry/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1industry/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1industry/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1industry/get"}],"panels":[]}]},"httpPath":"/catalogs/industry"},{"label":"catalogs/master/location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1master~1location/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1master~1location/get","metadata":{"seo":{"title":"catalogs/master/location","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/master/location","isWebhook":false,"pointer":"/paths/~1catalogs~1master~1location/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/master/location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1location/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1location/get#catalogs/paths/~1catalogs~1master~1location/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches master location data (city/state/country) using a partial filter value. Results are normalized to ViaBlocks field naming conventions."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1location/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1location/get#catalogs/paths/~1catalogs~1master~1location/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Support UI search/type-ahead for location entry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normalize and validate user-entered location data before transaction creation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Look up cities, states, or countries by partial name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1location/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1location/get#catalogs/paths/~1catalogs~1master~1location/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1location/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1location/get#catalogs/paths/~1catalogs~1master~1location/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Input is provided via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results may contain multiple matches for the same city name across different states/countries"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1location/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1location/get#catalogs/paths/~1catalogs~1master~1location/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"filterValue is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No matches found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filterValue","in":"query","schemaId":"schema_122","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search filter value for location lookup (city, state, or country name)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1master~1location/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1master~1location/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/master/location","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"filterValue","in":"query","required":true,"example":"string","schemaId":"schema_122"},{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/master/location","href":"catalogs/paths/~1catalogs~1master~1location/get","summary":"catalogs/master/location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of locations matching the filter value.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1location/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1location/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1location/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1location/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1location/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1location/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1location/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1location/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1master~1location/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1location/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1location/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1location/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1location/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1location/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1location/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1location/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1location/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1master~1location/get"}],"panels":[]}]},"httpPath":"/catalogs/master/location"},{"label":"catalogs/master/zipcodes/{addressZipCode}","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get","metadata":{"seo":{"title":"catalogs/master/zipcodes/{addressZipCode}","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/master/zipcodes/{addressZipCode}","isWebhook":false,"pointer":"/paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/master/zipcodes/{addressZipCode}","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get#catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks up location information (city, state) for a given ZIP/postal code. Returns normalized address data associated with the provided zipcode."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get#catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto-fill city and state fields based on a ZIP code entered by the user"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate that a ZIP code exists and retrieve its associated location data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Speed up address entry by resolving location from postal code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get#catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get#catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ZIP code is provided as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressZipCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results include city name, state abbreviation, and full state name"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single ZIP code may map to multiple cities (returned as an array)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get#catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No location data found for the given ZIP code"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"addressZipCode","in":"path","schemaId":"schema_123","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal/ZIP code for location lookup (e.g. '33166', '10001')"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/master/zipcodes/{addressZipCode}","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[{"name":"addressZipCode","in":"path","required":true,"example":"string","schemaId":"schema_123"}],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/master/zipcodes/{addressZipCode}","href":"catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get","summary":"catalogs/master/zipcodes/{addressZipCode}"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of locations matching the ZIP code. Each item contains city name, state abbreviation, and full state name.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get"}],"panels":[]}]},"httpPath":"/catalogs/master/zipcodes/{addressZipCode}"},{"label":"catalogs/recipients/relationships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1recipients~1relationships/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1recipients~1relationships/get","metadata":{"seo":{"title":"catalogs/recipients/relationships","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/recipients/relationships","isWebhook":false,"pointer":"/paths/~1catalogs~1recipients~1relationships/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/recipients/relationships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1recipients~1relationships/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1recipients~1relationships/get#catalogs/paths/~1catalogs~1recipients~1relationships/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available relationship types between sender and recipient. Used for compliance and KYC data collection."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1recipients~1relationships/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1recipients~1relationships/get#catalogs/paths/~1catalogs~1recipients~1relationships/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate relationship type dropdowns in the beneficiary/recipient forms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate the sender-recipient relationship before submitting a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display available relationship options (e.g., parent, spouse, friend, business)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1recipients~1relationships/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1recipients~1relationships/get#catalogs/paths/~1catalogs~1recipients~1relationships/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1recipients~1relationships/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1recipients~1relationships/get#catalogs/paths/~1catalogs~1recipients~1relationships/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relationship types are global and not country-specific"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field may be required depending on the destination country's compliance rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The relationship "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used when creating or updating beneficiary records"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each relationship includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"translations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with English ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and Spanish ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"es"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") names"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1recipients~1relationships/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1recipients~1relationships/get#catalogs/paths/~1catalogs~1recipients~1relationships/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No relationship types found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1recipients~1relationships/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1recipients~1relationships/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/recipients/relationships","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/recipients/relationships","href":"catalogs/paths/~1catalogs~1recipients~1relationships/get","summary":"catalogs/recipients/relationships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of relationship types with multilingual translations.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1recipients~1relationships/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1recipients~1relationships/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1recipients~1relationships/get"}],"panels":[]}]},"httpPath":"/catalogs/recipients/relationships"},{"label":"catalogs/transaction/cancel-reasons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get","metadata":{"seo":{"title":"catalogs/transaction/cancel-reasons","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/transaction/cancel-reasons","isWebhook":false,"pointer":"/paths/~1catalogs~1transaction~1cancel-reasons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/transaction/cancel-reasons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get#catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available cancellation reasons for transactions. These reasons are required when cancelling a transaction via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /transaction/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get#catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate a cancellation reason dropdown when the user wants to cancel a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values required by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /transaction/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/integration-with-transaction-cancel","deepLinkHash":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get#catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/integration-with-transaction-cancel"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration with Transaction Cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response fields map directly to the cancel request body:"},"children":[]}]}]},{"$$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":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /transaction/cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /transaction/cancel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get#catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get#catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns only active cancellation reasons (available for agency-type cancellations)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are ordered alphabetically by description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get#catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No cancellation reasons found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1transaction~1cancel-reasons/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1transaction~1cancel-reasons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/transaction/cancel-reasons","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","500"],"pointer":"/catalogs/transaction/cancel-reasons","href":"catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get","summary":"catalogs/transaction/cancel-reasons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of available cancellation reasons. Each item contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that should be used as-is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /transaction/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Authorization error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1transaction~1cancel-reasons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1transaction~1cancel-reasons/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get"}],"panels":[]}]},"httpPath":"/catalogs/transaction/cancel-reasons"},{"label":"catalogs/wire-purpose","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/catalogs/paths/~1catalogs~1wire-purpose/get","routeSlug":"/apis/outbound/catalogs/paths/~1catalogs~1wire-purpose/get","metadata":{"seo":{"title":"catalogs/wire-purpose","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"catalogs/wire-purpose","isWebhook":false,"pointer":"/paths/~1catalogs~1wire-purpose/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"catalogs/wire-purpose","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1wire-purpose/get/request/purpose","deepLinkHash":"/catalogs/paths/~1catalogs~1wire-purpose/get#catalogs/paths/~1catalogs~1wire-purpose/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available remittance purpose codes. These describe the reason for the money transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1wire-purpose/get/request/when-to-use","deepLinkHash":"/catalogs/paths/~1catalogs~1wire-purpose/get#catalogs/paths/~1catalogs~1wire-purpose/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate wire/remittance purpose dropdowns in the transaction form"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate the transfer purpose before submitting a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display available purpose options for compliance-related fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1wire-purpose/get/request/authentication","deepLinkHash":"/catalogs/paths/~1catalogs~1wire-purpose/get#catalogs/paths/~1catalogs~1wire-purpose/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1wire-purpose/get/request/notes","deepLinkHash":"/catalogs/paths/~1catalogs~1wire-purpose/get#catalogs/paths/~1catalogs~1wire-purpose/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The purpose codes are global and not country-specific"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field may be required depending on the destination country's compliance rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common purposes include family support, education, bills/utility payment, etc."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"catalogs/paths/~1catalogs~1wire-purpose/get/request/common-errors","deepLinkHash":"/catalogs/paths/~1catalogs~1wire-purpose/get#catalogs/paths/~1catalogs~1wire-purpose/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resource not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No remittance purposes found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"validations","in":"query","schemaId":"schema_95","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1catalogs~1wire-purpose/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1catalogs~1wire-purpose/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/catalogs/wire-purpose","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_95"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/catalogs/wire-purpose","href":"catalogs/paths/~1catalogs~1wire-purpose/get","summary":"catalogs/wire-purpose"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of remittance purpose codes with their descriptions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_404"}},"schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_404"},{"code":"500","description":"Internal server error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1catalogs~1wire-purpose/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_404"}}},{"code":"500","schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1catalogs~1wire-purpose/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/paths/~1catalogs~1wire-purpose/get"}],"panels":[]}]},"httpPath":"/catalogs/wire-purpose"}],"content":{"contentType":"group","meta":{"name":"Catalogs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Catalogs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/catalogs/account-types","summary":"catalogs/account-types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1account-types/get","deprecated":false},{"title":"/catalogs/all-endpoints","summary":"/catalogs/all-endpoints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1all-endpoints/get","deprecated":false},{"title":"/catalogs/countries","summary":"catalogs/countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/currencies","summary":"catalogs/countries/{deliveryCountryISO}/currencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1currencies/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/deliver-methods","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payers-rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payers-rules/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","summary":"catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","summary":"/catalogs/countries/{deliveryCountryISO}/deliver-methods/{deliveryMode}/payouts/{deliveryLocationNetwork}/locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1deliver-methods~1{deliverymode}~1payouts~1{deliverylocationnetwork}~1locations/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/identifications","summary":"catalogs/countries/{deliveryCountryISO}/identifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1identifications/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/states","summary":"catalogs/countries/{deliveryCountryISO}/states","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states/get","deprecated":false},{"title":"/catalogs/countries/{deliveryCountryISO}/states/{addressState}/cities","summary":"catalogs/countries/{deliveryCountryISO}/states/{stateISO}/cities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1countries~1{deliverycountryiso}~1states~1{addressstate}~1cities/get","deprecated":false},{"title":"/catalogs/funds-origin","summary":"catalogs/funds-origin","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1funds-origin/get","deprecated":false},{"title":"/catalogs/google-maps-api","summary":"catalogs/google-maps-api","prefix":{"name":"post","color":"post"},"badges":[],"link":"/catalogs/paths/~1catalogs~1google-maps-api/post","deprecated":false},{"title":"/catalogs/industry","summary":"catalogs/industry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1industry/get","deprecated":false},{"title":"/catalogs/master/location","summary":"catalogs/master/location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1master~1location/get","deprecated":false},{"title":"/catalogs/master/zipcodes/{addressZipCode}","summary":"catalogs/master/zipcodes/{addressZipCode}","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1master~1zipcodes~1{addresszipcode}/get","deprecated":false},{"title":"/catalogs/recipients/relationships","summary":"catalogs/recipients/relationships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1recipients~1relationships/get","deprecated":false},{"title":"/catalogs/transaction/cancel-reasons","summary":"catalogs/transaction/cancel-reasons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get","deprecated":false},{"title":"/catalogs/wire-purpose","summary":"catalogs/wire-purpose","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/paths/~1catalogs~1wire-purpose/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Pricing","link":"/apis/outbound/pricing","routeSlug":"/apis/outbound/pricing","items":[{"label":"pricing/payers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/pricing/paths/~1pricing~1payers/get","routeSlug":"/apis/outbound/pricing/paths/~1pricing~1payers/get","metadata":{"seo":{"title":"pricing/payers","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"pricing/payers","isWebhook":false,"pointer":"/paths/~1pricing~1payers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"pricing/payers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1payers/get/request/purpose","deepLinkHash":"/pricing/paths/~1pricing~1payers/get#pricing/paths/~1pricing~1payers/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves available payers with their exchange rates and transaction limits for a given destination country and branch."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1payers/get/request/when-to-use","deepLinkHash":"/pricing/paths/~1pricing~1payers/get#pricing/paths/~1pricing~1payers/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$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":"Display available payout options and pricing to customers before they select a payer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show which payment networks are available in a destination country with their rate ranges"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow customers to compare payers by exchange rate and transaction limits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1payers/get/request/how-it-works","deepLinkHash":"/pricing/paths/~1pricing~1payers/get#pricing/paths/~1pricing~1payers/get/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How It Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive a list of payers with rates and limits for the requested country"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1payers/get/request/authentication","deepLinkHash":"/pricing/paths/~1pricing~1payers/get#pricing/paths/~1pricing~1payers/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers. Partner must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing/payers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their allowed resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1payers/get/request/notes","deepLinkHash":"/pricing/paths/~1pricing~1payers/get#pricing/paths/~1pricing~1payers/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts ISO 3166-1 alpha-3 codes (e.g., MEX, COL, HND)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results include rate ranges and transaction amount limits per payer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1payers/get/request/common-errors","deepLinkHash":"/pricing/paths/~1pricing~1payers/get#pricing/paths/~1pricing~1payers/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing branchId, missing deliveryCountryISO, invalid headers)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access forbidden (endpoint not in partner resources)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pricing data not available for the given parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal server error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Upstream service authentication failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Service temporarily unavailable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"branchId is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"deliveryCountryISO is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The branchId is not valid for this partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing data could not be retrieved"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unable to authenticate with upstream service"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"503001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Service temporarily unavailable"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"branchId","in":"query","schemaId":"schema_124","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch identifier for the partner. Must be a valid branch belonging to the partner's chain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"deliveryCountryISO","in":"query","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country in ISO 3166-1 alpha-3 format (e.g., MEX, COL, HND, GTM)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available countries from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1countries/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Countries"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"validations","in":"query","schemaId":"schema_126","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request. When set to 'true', returns the merged schema (base + partner override) as JSON."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1pricing~1payers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1pricing~1payers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pricing/payers","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"branchId","in":"query","required":true,"example":"string","schemaId":"schema_124"},{"name":"deliveryCountryISO","in":"query","required":true,"example":"string","schemaId":"schema_125"},{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_126"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","422","500","502","503"],"pointer":"/pricing/payers","href":"pricing/paths/~1pricing~1payers/get","summary":"pricing/payers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payer rates and limits returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_single_payer","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_empty"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_single_payer","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_empty"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — missing or invalid required headers or parameters."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_country","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_header"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_country","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_header"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid client credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1payers/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1payers/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1payers/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1payers/get/responses/403/content/application~1json/examples/default"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business rule error — pricing data not available."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1payers/get/responses/422/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1payers/get/responses/422/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1payers/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1payers/get/responses/500/content/application~1json/examples/default"]},{"code":"502","description":"Authentication with upstream pricing service failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1payers/get/responses/502/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1payers/get/responses/502/content/application~1json/examples/default"]},{"code":"503","description":"Pricing service temporarily unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1payers/get/responses/503/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1payers/get/responses/503/content/application~1json/examples/default"]}],"pointer":"/paths/~1pricing~1payers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_single_payer","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_single_payer","paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_empty"]}}},{"code":"400","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_country","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_header"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_country","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_header"]}}},{"code":"401","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1payers/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1payers/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1payers/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1payers/get/responses/403/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1payers/get/responses/422/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1payers/get/responses/422/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1payers/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1payers/get/responses/500/content/application~1json/examples/default"]}}},{"code":"502","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1payers/get/responses/502/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1payers/get/responses/502/content/application~1json/examples/default"]}}},{"code":"503","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1payers/get/responses/503/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1payers/get/responses/503/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing/paths/~1pricing~1payers/get"}],"panels":[]}]},"httpPath":"/pricing/payers"},{"label":"pricing/top-countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/pricing/paths/~1pricing~1top-countries/get","routeSlug":"/apis/outbound/pricing/paths/~1pricing~1top-countries/get","metadata":{"seo":{"title":"pricing/top-countries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"pricing/top-countries","isWebhook":false,"pointer":"/paths/~1pricing~1top-countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"pricing/top-countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1top-countries/get/request/purpose","deepLinkHash":"/pricing/paths/~1pricing~1top-countries/get#pricing/paths/~1pricing~1top-countries/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the top countries with the best exchange rates and the payer that offers them for a given branch."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1top-countries/get/request/when-to-use","deepLinkHash":"/pricing/paths/~1pricing~1top-countries/get#pricing/paths/~1pricing~1top-countries/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$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":"Display optimal sending destinations based on best available rates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show a ranked list of countries with their best payer rates on a partner's interface"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1top-countries/get/request/how-it-works","deepLinkHash":"/pricing/paths/~1pricing~1top-countries/get#pricing/paths/~1pricing~1top-countries/get/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How It Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a query parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive a ranked list of countries with best exchange rates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1top-countries/get/request/authentication","deepLinkHash":"/pricing/paths/~1pricing~1top-countries/get#pricing/paths/~1pricing~1top-countries/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers. Partner must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pricing/top-countries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their allowed resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"pricing/paths/~1pricing~1top-countries/get/request/common-errors","deepLinkHash":"/pricing/paths/~1pricing~1top-countries/get#pricing/paths/~1pricing~1top-countries/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing branchId, invalid headers)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access forbidden (endpoint not in partner resources)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pricing data not available for the given parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal server error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Upstream service authentication failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Service temporarily unavailable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"branchId is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The branchId is not valid for this partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing data could not be retrieved"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unable to authenticate with upstream service"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"503001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Service temporarily unavailable"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"branchId","in":"query","schemaId":"schema_127","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch identifier for the partner. Must be a valid branch belonging to the partner's chain. Used to retrieve top-country rates for the specified branch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"validations","in":"query","schemaId":"schema_128","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to 'true', returns the merged validation schema for this endpoint instead of executing the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"example":"true"}],"pointer":"/paths/~1pricing~1top-countries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1pricing~1top-countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pricing/top-countries","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"branchId","in":"query","required":true,"example":"string","schemaId":"schema_127"},{"name":"validations","in":"query","required":false,"example":"true","schemaId":"schema_128"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","422","500","502","503"],"pointer":"/pricing/top-countries","href":"pricing/paths/~1pricing~1top-countries/get","summary":"pricing/top-countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Top countries with best exchange rates returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_single_country","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_empty"]}},"schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_single_country","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_empty"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — missing or invalid required headers or parameters."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_missing_header"]}},"schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_missing_header"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid client credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1top-countries/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1top-countries/get/responses/401/content/application~1json/examples/default"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1top-countries/get/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1top-countries/get/responses/403/content/application~1json/examples/default"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business rule error — pricing data not available."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1top-countries/get/responses/422/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1top-countries/get/responses/422/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1top-countries/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1top-countries/get/responses/500/content/application~1json/examples/default"]},{"code":"502","description":"Authentication with upstream pricing service failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1top-countries/get/responses/502/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1top-countries/get/responses/502/content/application~1json/examples/default"]},{"code":"503","description":"Pricing service temporarily unavailable.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1top-countries/get/responses/503/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1top-countries/get/responses/503/content/application~1json/examples/default"]}],"pointer":"/paths/~1pricing~1top-countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_single_country","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_single_country","paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_empty"]}}},{"code":"400","schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_missing_header"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/default","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_missing_header"]}}},{"code":"401","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1top-countries/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1pricing~1top-countries/get/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1top-countries/get/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","exampleIds":["paths/~1pricing~1top-countries/get/responses/403/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1top-countries/get/responses/422/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1pricing~1top-countries/get/responses/422/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1top-countries/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1pricing~1top-countries/get/responses/500/content/application~1json/examples/default"]}}},{"code":"502","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1top-countries/get/responses/502/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","exampleIds":["paths/~1pricing~1top-countries/get/responses/502/content/application~1json/examples/default"]}}},{"code":"503","schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1top-countries/get/responses/503/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","exampleIds":["paths/~1pricing~1top-countries/get/responses/503/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing/paths/~1pricing~1top-countries/get"}],"panels":[]}]},"httpPath":"/pricing/top-countries"}],"content":{"contentType":"group","meta":{"name":"Pricing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pricing","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pricing/payers","summary":"pricing/payers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricing/paths/~1pricing~1payers/get","deprecated":false},{"title":"/pricing/top-countries","summary":"pricing/top-countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricing/paths/~1pricing~1top-countries/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Sender","link":"/apis/outbound/sender","routeSlug":"/apis/outbound/sender","items":[{"label":"sender/id-upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/sender/paths/~1sender~1id-upload/post","routeSlug":"/apis/outbound/sender/paths/~1sender~1id-upload/post","metadata":{"seo":{"title":"sender/id-upload","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"sender/id-upload","isWebhook":false,"pointer":"/paths/~1sender~1id-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"sender/id-upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1id-upload/post/request/purpose","deepLinkHash":"/sender/paths/~1sender~1id-upload/post#sender/paths/~1sender~1id-upload/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload sender identification document images (front and optionally back) for KYC processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1id-upload/post/request/when-to-use","deepLinkHash":"/sender/paths/~1sender~1id-upload/post#sender/paths/~1sender~1id-upload/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload the sender's ID document image after creating a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit both front and back images of the identification document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fulfill KYC requirements for sender verification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1id-upload/post/request/authentication","deepLinkHash":"/sender/paths/~1sender~1id-upload/post#sender/paths/~1sender~1id-upload/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1id-upload/post/request/how-it-works","deepLinkHash":"/sender/paths/~1sender~1id-upload/post#sender/paths/~1sender~1id-upload/post/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How It Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field identifies the sender (idSenderGlobal) — the same UUID returned when creating the sender"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sender is validated against the Customer DynamoDB table"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are validated against the KYC identifications catalog to confirm the document is accepted and to determine whether the back image is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images are forwarded to the Viacheck processing Lambda for storage and verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On success, returns a confirmation message"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1id-upload/post/request/notes","deepLinkHash":"/sender/paths/~1sender~1id-upload/post#sender/paths/~1sender~1id-upload/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a code accepted for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., DL, PA, CL)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentCountry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the document's issuing country in ISO 3166-1 alpha-3 format (e.g., USA, MEX)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"frontImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always required; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required only when the document type/country requires the back side (per the identifications catalog)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Images can be sent as raw base64 or data URI format (data:image/png;base64,...)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1id-upload/post/request/common-errors","deepLinkHash":"/sender/paths/~1sender~1id-upload/post#sender/paths/~1sender~1id-upload/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid JSON format or image upload failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Missing required field (uuid, documentType, documentCountry, documentNumber, frontImage, or backImage when required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - documentType is not accepted for the given documentCountry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Partner not authorized for this endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404002"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sender not found for the given UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Internal server error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1sender~1id-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST","exampleIds":["paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_only","paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_and_back"]}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST","exampleIds":["paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_only","paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_and_back"],"pointer":"/paths/~1sender~1id-upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sender/id-upload","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST","exampleIds":["paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_only","paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_and_back"]}},"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/sender/id-upload","href":"sender/paths/~1sender~1id-upload/post","summary":"sender/id-upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST","exampleIds":["paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_only","paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_and_back"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST","exampleIds":["paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_only","paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_and_back"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ID document uploaded successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1sender~1id-upload/post/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1sender~1id-upload/post/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error - missing or invalid required fields, or image upload failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1sender~1id-upload/post/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1sender~1id-upload/post/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication failed - invalid credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1sender~1id-upload/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1sender~1id-upload/post/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Authorization failed - partner not allowed to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_403"}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_403"},{"code":"404","description":"Sender not found for the given UUID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1sender~1id-upload/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1sender~1id-upload/post/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Business rule error - sender does not have required data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_422"}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_422"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1sender~1id-upload/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1sender~1id-upload/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1sender~1id-upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1sender~1id-upload/post/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1sender~1id-upload/post/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1sender~1id-upload/post/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1sender~1id-upload/post/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1sender~1id-upload/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1sender~1id-upload/post/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_403"}}},{"code":"404","schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1sender~1id-upload/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1sender~1id-upload/post/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_422"}}},{"code":"500","schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1sender~1id-upload/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1sender~1id-upload/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender/paths/~1sender~1id-upload/post"}],"panels":[]}]},"httpPath":"/sender/id-upload"},{"label":"/sender","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/sender/paths/~1sender/get","routeSlug":"/apis/outbound/sender/paths/~1sender/get","metadata":{"seo":{"title":"/sender","description":"Retrieves a sender's full profile by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/sender","isWebhook":false,"pointer":"/paths/~1sender/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/sender","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a sender's full profile by UUID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender/get/request/purpose","deepLinkHash":"/sender/paths/~1sender/get#sender/paths/~1sender/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the complete profile of an existing sender, including personal, contact, address, identification, compliance (KYC) information, and all uploaded identity documents with their review status."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender/get/request/how-it-works","deepLinkHash":"/sender/paths/~1sender/get#sender/paths/~1sender/get/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How It Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks up the sender using the provided UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the sender is retrieved directly from that branch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, the system automatically searches across all branches associated with your partner account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the sender profile including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identityDocuments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a list of all uploaded ID documents with metadata, image URLs, and review status (APPROVED, NOT REVIEWED, REJECTED)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender/get/request/authentication","deepLinkHash":"/sender/paths/~1sender/get#sender/paths/~1sender/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers. The partner context is resolved automatically from the authenticated credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender/get/request/common-errors","deepLinkHash":"/sender/paths/~1sender/get#sender/paths/~1sender/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid query parameters)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Sender not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"uuid query parameter is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials. Verify your x-client-id and x-secret-key."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Sender not found for the provided uuid."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"An unexpected error occurred. Please try again later."},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"uuid","in":"query","schemaId":"schema_129","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender global UUID used to look up the profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"branchId","in":"query","schemaId":"schema_130","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific branch to query. If omitted, the branch is resolved automatically across the partner's branches."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1sender/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1sender/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sender","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"uuid","in":"query","required":true,"example":"string","schemaId":"schema_129"},{"name":"branchId","in":"query","required":false,"example":"string","schemaId":"schema_130"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/sender","href":"sender/paths/~1sender/get","summary":"/sender"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender found successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender/get/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Missing or invalid query parameter.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Sender not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1sender/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1sender/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1sender/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender/get/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1sender/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_404","exampleIds":["paths/~1sender/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender/paths/~1sender/get"}],"panels":[]}]},"httpPath":"/sender"},{"label":"/sender/search","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/sender/paths/~1sender~1search/get","routeSlug":"/apis/outbound/sender/paths/~1sender~1search/get","metadata":{"seo":{"title":"/sender/search","description":"Searches for senders by name or phone number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/sender/search","isWebhook":false,"pointer":"/paths/~1sender~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/sender/search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches for senders by name or phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1search/get/request/purpose","deepLinkHash":"/sender/paths/~1sender~1search/get#sender/paths/~1sender~1search/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows searching for existing senders in the system to retrieve their profile information. Useful for finding a sender before creating a transaction or linking a beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1search/get/request/how-it-works","deepLinkHash":"/sender/paths/~1sender~1search/get#sender/paths/~1sender~1search/get/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How It Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches the index by the provided filter (name or phone)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no results are found, performs a secondary lookup in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are deduplicated by first name, last name, and phone"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1search/get/request/search-behavior","deepLinkHash":"/sender/paths/~1sender~1search/get#sender/paths/~1sender~1search/get/request/search-behavior"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Behavior"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is numeric, searches by phone number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is text, searches by name (partial match supported)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are limited to 50 records"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"sender/paths/~1sender~1search/get/request/authentication","deepLinkHash":"/sender/paths/~1sender~1search/get#sender/paths/~1sender~1search/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chainId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is resolved automatically from the authenticated partner."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filterValue","in":"query","schemaId":"schema_131","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search term. Can be a name (partial match) or phone number (exact match)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"countryISO3","in":"query","schemaId":"schema_132","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country filter (ISO 3166-1 alpha-3). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1sender~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1sender~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sender/search","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"filterValue","in":"query","required":true,"example":"string","schemaId":"schema_131"},{"name":"countryISO3","in":"query","required":false,"example":"string","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","500"],"pointer":"/sender/search","href":"sender/paths/~1sender~1search/get","summary":"/sender/search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Search completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender~1search/get/responses/200/content/application~1json/examples/default","paths/~1sender~1search/get/responses/200/content/application~1json/examples/200_empty"]}},"schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender~1search/get/responses/200/content/application~1json/examples/default","paths/~1sender~1search/get/responses/200/content/application~1json/examples/200_empty"]},{"code":"400","description":"Missing or invalid query parameter.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender~1search/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender~1search/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender~1search/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender~1search/get/responses/401/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender~1search/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender~1search/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1sender~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender~1search/get/responses/200/content/application~1json/examples/default","paths/~1sender~1search/get/responses/200/content/application~1json/examples/200_empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1sender~1search/get/responses/200/content/application~1json/examples/default","paths/~1sender~1search/get/responses/200/content/application~1json/examples/200_empty"]}}},{"code":"400","schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender~1search/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1sender~1search/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender~1search/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1sender~1search/get/responses/401/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender~1search/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1sender~1search/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sender/paths/~1sender~1search/get"}],"panels":[]}]},"httpPath":"/sender/search"}],"content":{"contentType":"group","meta":{"name":"Sender"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sender","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sender/id-upload","summary":"sender/id-upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sender/paths/~1sender~1id-upload/post","deprecated":false},{"title":"/sender","summary":"/sender","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sender/paths/~1sender/get","deprecated":false},{"title":"/sender/search","summary":"/sender/search","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sender/paths/~1sender~1search/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Service","link":"/apis/outbound/service","routeSlug":"/apis/outbound/service","items":[{"label":"/service/account/verify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/service/paths/~1service~1account~1verify/post","routeSlug":"/apis/outbound/service/paths/~1service~1account~1verify/post","metadata":{"seo":{"title":"/service/account/verify","description":"Verifies the validity and status of a bank account number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/service/account/verify","isWebhook":false,"pointer":"/paths/~1service~1account~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/service/account/verify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies the validity and status of a bank account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1account~1verify/post/request/purpose","deepLinkHash":"/service/paths/~1service~1account~1verify/post#service/paths/~1service~1account~1verify/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates that a bank account is open, active, and in good standing before initiating a payment or transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1account~1verify/post/request/when-to-use","deepLinkHash":"/service/paths/~1service~1account~1verify/post#service/paths/~1service~1account~1verify/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$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":"Before creating a transaction that involves a direct bank deposit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To confirm the account details provided by a sender or beneficiary"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To reduce payment returns caused by invalid or closed accounts"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1account~1verify/post/request/how-it-works","deepLinkHash":"/service/paths/~1service~1account~1verify/post#service/paths/~1service~1account~1verify/post/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates the routing number structure (ABA checksum)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies the account against the bank verification provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the verification result with risk assessment and bank details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1account~1verify/post/request/authentication","deepLinkHash":"/service/paths/~1service~1account~1verify/post#service/paths/~1service~1account~1verify/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-api-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1account~1verify/post/request/notes","deepLinkHash":"/service/paths/~1service~1account~1verify/post#service/paths/~1service~1account~1verify/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The routing number must pass ABA checksum validation before the account is verified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account types accepted: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Checking), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Savings)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes a risk level (LOW, MEDIUM, HIGH) to help determine next steps."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1account~1verify/post/request/common-errors","deepLinkHash":"/service/paths/~1service~1account~1verify/post#service/paths/~1service~1account~1verify/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Missing required fields or invalid routing number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verification service temporarily unavailable"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-api-key","in":"header","schemaId":"schema_133","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Use this OR x-client-id/x-secret-key pair."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"x-client-id","in":"header","schemaId":"schema_134","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner client identifier. Must be sent together with x-secret-key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_135","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner secret key. Must be sent together with x-client-id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1service~1account~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST","exampleIds":["paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/savings_code","paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/checking_code"]}},"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST","exampleIds":["paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/savings_code","paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/checking_code"],"pointer":"/paths/~1service~1account~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/service/account/verify","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-api-key","in":"header","required":false,"example":"string","schemaId":"schema_133"},{"name":"x-client-id","in":"header","required":false,"example":"string","schemaId":"schema_134"},{"name":"x-secret-key","in":"header","required":false,"example":"string","schemaId":"schema_135"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST","exampleIds":["paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/savings_code","paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/checking_code"]}},"responseCodes":["200","400","401","500"],"pointer":"/service/account/verify","href":"service/paths/~1service~1account~1verify/post","summary":"/service/account/verify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST","exampleIds":["paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/savings_code","paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/checking_code"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST","exampleIds":["paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/savings_code","paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/checking_code"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Account verified successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1account~1verify/post/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1account~1verify/post/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error - missing or invalid fields","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_routing","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_account_type"]}},"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_routing","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_account_type"]},{"code":"401","description":"Authentication failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1account~1verify/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1account~1verify/post/responses/401/content/application~1json/examples/default"]},{"code":"500","description":"Verification service unavailable or internal error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1account~1verify/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1account~1verify/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1service~1account~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1account~1verify/post/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1account~1verify/post/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_routing","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_account_type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_missing_field","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_routing","paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_account_type"]}}},{"code":"401","schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1account~1verify/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1account~1verify/post/responses/401/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1account~1verify/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1account~1verify/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/paths/~1service~1account~1verify/post"}],"panels":[]}]},"httpPath":"/service/account/verify"},{"label":"/service/routing/verify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/service/paths/~1service~1routing~1verify/post","routeSlug":"/apis/outbound/service/paths/~1service~1routing~1verify/post","metadata":{"seo":{"title":"/service/routing/verify","description":"Verifies a bank routing number and optionally verifies an associated account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/service/routing/verify","isWebhook":false,"pointer":"/paths/~1service~1routing~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/service/routing/verify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies a bank routing number and optionally verifies an associated account."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1routing~1verify/post/request/purpose","deepLinkHash":"/service/paths/~1service~1routing~1verify/post#service/paths/~1service~1routing~1verify/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates a routing number structure (ABA checksum), retrieves bank details and supported payment networks (ACH, Wire, RTP, FedNow). Optionally verifies an account number in the same request."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1routing~1verify/post/request/when-to-use","deepLinkHash":"/service/paths/~1service~1routing~1verify/post#service/paths/~1service~1routing~1verify/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$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":"Validate a routing number before creating a bank deposit transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve bank name and payment capabilities for a routing number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify both routing and account in a single call to reduce round trips"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1routing~1verify/post/request/how-it-works","deepLinkHash":"/service/paths/~1service~1routing~1verify/post#service/paths/~1service~1routing~1verify/post/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates the routing number structure via ABA checksum"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If account fields are provided, verifies the account with the bank verification provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks the internal database for cached routing data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not cached, queries external providers (Lyon/Nabco) for routing details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caches the result asynchronously for future lookups"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns routing details with optional account verification results"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1routing~1verify/post/request/authentication","deepLinkHash":"/service/paths/~1service~1routing~1verify/post#service/paths/~1service~1routing~1verify/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-api-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header OR "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1routing~1verify/post/request/notes","deepLinkHash":"/service/paths/~1service~1routing~1verify/post#service/paths/~1service~1routing~1verify/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The routing number must be exactly 9 digits and pass ABA checksum."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account types accepted: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Checking), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Savings)."},"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":"countryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter accepts ISO 3166-1 alpha-3 codes (e.g., USA, CAN)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account verification results are included under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountVerification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key when requested."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"service/paths/~1service~1routing~1verify/post/request/common-errors","deepLinkHash":"/service/paths/~1service~1routing~1verify/post#service/paths/~1service~1routing~1verify/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid routing number checksum or missing required fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Routing number not found in any provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" External service unavailable"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-api-key","in":"header","schemaId":"schema_133","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key for authentication. Use this OR x-client-id/x-secret-key pair."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"x-client-id","in":"header","schemaId":"schema_134","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner client identifier. Must be sent together with x-secret-key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_135","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner secret key. Must be sent together with x-client-id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1service~1routing~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST","exampleIds":["paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/required_fields","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_checking","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_savings_short"]}},"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST","exampleIds":["paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/required_fields","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_checking","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_savings_short"],"pointer":"/paths/~1service~1routing~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/service/routing/verify","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-api-key","in":"header","required":false,"example":"string","schemaId":"schema_133"},{"name":"x-client-id","in":"header","required":false,"example":"string","schemaId":"schema_134"},{"name":"x-secret-key","in":"header","required":false,"example":"string","schemaId":"schema_135"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST","exampleIds":["paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/required_fields","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_checking","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_savings_short"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/service/routing/verify","href":"service/paths/~1service~1routing~1verify/post","summary":"/service/routing/verify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST","exampleIds":["paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/required_fields","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_checking","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_savings_short"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST","exampleIds":["paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/required_fields","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_checking","paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_savings_short"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Routing number verified successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_routing_only","paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_with_account"]}},"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_routing_only","paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_with_account"]},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_checksum","paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_missing_account_type"]}},"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_checksum","paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_missing_account_type"]},{"code":"401","description":"Authentication failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1routing~1verify/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1routing~1verify/post/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Routing number not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1service~1routing~1verify/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1service~1routing~1verify/post/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error or external service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1routing~1verify/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1routing~1verify/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1service~1routing~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_routing_only","paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_with_account"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_routing_only","paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_with_account"]}}},{"code":"400","schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_checksum","paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_missing_account_type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_checksum","paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_missing_account_type"]}}},{"code":"401","schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1routing~1verify/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1service~1routing~1verify/post/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1service~1routing~1verify/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1service~1routing~1verify/post/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1routing~1verify/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1service~1routing~1verify/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/paths/~1service~1routing~1verify/post"}],"panels":[]}]},"httpPath":"/service/routing/verify"}],"content":{"contentType":"group","meta":{"name":"Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/service/account/verify","summary":"/service/account/verify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/service/paths/~1service~1account~1verify/post","deprecated":false},{"title":"/service/routing/verify","summary":"/service/routing/verify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/service/paths/~1service~1routing~1verify/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Transaction","link":"/apis/outbound/transaction","routeSlug":"/apis/outbound/transaction","items":[{"label":"/transaction/cancel","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/transaction/paths/~1transaction~1cancel/delete","routeSlug":"/apis/outbound/transaction/paths/~1transaction~1cancel/delete","metadata":{"seo":{"title":"/transaction/cancel","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/transaction/cancel","isWebhook":false,"pointer":"/paths/~1transaction~1cancel/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/transaction/cancel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/purpose","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a pending transaction. Uses the Strategy pattern to apply different validation rules based on transaction type (Outbound vs Inbound)."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/transaction-types","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/transaction-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1cancel/delete/request/outbound-(branch-starts-with-a-e-etc.)","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/outbound-(branch-starts-with-a-e-etc.)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound (branch starts with A, E, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agency sends money abroad. Supports three flows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Immediate cancellation within time window ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_void = true"},"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":"Cancelation Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Submit request with reason for approval"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orchestrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Route to PayerProxy for DONE/TRANSFERED status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1cancel/delete/request/inbound-(branch-starts-with-i)","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/inbound-(branch-starts-with-i)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound (branch starts with I)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Money arrives from external sources. Additional validation:"},"children":[]}]}]},{"$$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":"Only transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id_flag_receiver"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"I"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in process) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"H"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (on hold) can be cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status RETURNED is also considered terminal (not cancellable)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/when-to-use","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel a transaction that has not been completed yet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void a transaction within the allowed time window"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a cancelation request with a reason for transactions that require approval"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/authentication","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/integration-with-cancel-reasons-catalog","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/integration-with-cancel-reasons-catalog"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration with Cancel Reasons Catalog"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before calling this endpoint, retrieve available cancellation reasons from our catalogs API:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Cancel Reasons"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The catalog returns objects with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use those values directly in this request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/cancel-flows","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/cancel-flows"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel Flows"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system determines the cancellation flow based on the transaction status and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS_VOID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condition"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flow"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelFlow"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_void = true"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"void\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_void = false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", status HOLD/NEW"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelation Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"cancelation-request\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status DONE or TRANSFERED"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orchestrator"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"orchestrator\""},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/business-rules","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/business-rules"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1cancel/delete/request/outbound","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/outbound"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound"},"children":[]}]}]},{"$$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":"Transactions with status CANCEL, PAID, or VOID cannot be cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction that already has a pending cancellation request cannot be cancelled again"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1cancel/delete/request/inbound","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/inbound"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound"},"children":[]}]}]},{"$$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":"Only transactions with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id_flag_receiver"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" I or H can be cancelled (422003 otherwise)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions with status CANCEL, PAID, VOID, or RETURNED cannot be cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction that already has a pending cancellation request cannot be cancelled again"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1cancel/delete/request/common","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/common"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common"},"children":[]}]}]},{"$$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":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are required for cancelation request flow. You can check the available reasons in our catalogs API: "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Cancel Reasons"},"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":"transactionContext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object is required (contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cashierId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within it is optional because the branch is always derived from the stored transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you do send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionContext.branchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it must match the branch that owns the transaction, otherwise the request is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400417"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use it as a safety check when the caller already knows the branch"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1cancel/delete/request/common-errors","deepLinkHash":"/transaction/paths/~1transaction~1cancel/delete#transaction/paths/~1transaction~1cancel/delete/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors, malformed JSON, or transaction belonging to another partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Access forbidden for this client"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Transaction not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Business-rule rejection (terminal status, duplicate request, inbound flag)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" External service error (ViaOne / orchestrator)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The body of the request is required, or the JSON format is invalid. Also returned when the x-client-id or x-secret-key header is missing, and when the branch of the transaction does not belong to the authenticated partner (details contains the offending branchId)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field is required. Applies to uuid, transactionContext and transactionContext.cashierId. transactionContext.branchId is optional: the endpoint derives the branch from the stored transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field must be of the correct type: string for uuid, reasonName, reasonId, reasonNotes and the transactionContext members; object for transactionContext."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field does not meet the minimum length. Only uuid can trigger it (minimum 32 characters)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field exceeds the maximum length: uuid (60), transactionContext.branchId (10), transactionContext.cashierId (40), reasonName (255), reasonId (10) or reasonNotes (500)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400417"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The transactionContext.branchId sent in the request does not match the branch that owns the transaction. Only raised when the caller sends that field, since it is optional; the comparison ignores case and padding."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"External API error during cancellation: the ViaOne service or the PayerProxy orchestrator failed. When ViaOne rejects the request with HTTP 400, 404 or 422 that status is propagated, but the payload keeps code 502001."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials (x-client-id / x-secret-key). Also returned when authentication against the ViaOne service fails."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client: the partner does not have transaction/cancel in its allowed resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Transaction not found in SQL Server (the status query returned no rows)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Transaction not found in DynamoDB for the given uuid."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Transaction cannot be cancelled because of its current status. Outbound: CANCEL, PAID or VOID. Inbound: CANCEL, PAID, VOID or RETURNED. The message includes the current status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Transaction already has a pending cancellation request (has_cancellation_req = 1); it cannot be requested twice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Inbound only: the transaction can be cancelled only while id_flag_receiver is I (in process) or H (on hold). The message includes the current flag."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error (unhandled exception)."},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1transaction~1cancel/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST","exampleIds":["paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_void_flow","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_cancelation_request","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_orchestrator","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_cancel","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_on_hold","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/cancelation_no_notes"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST","exampleIds":["paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_void_flow","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_cancelation_request","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_orchestrator","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_cancel","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_on_hold","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/cancelation_no_notes"],"pointer":"/paths/~1transaction~1cancel/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/transaction/cancel","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST","exampleIds":["paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_void_flow","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_cancelation_request","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_orchestrator","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_cancel","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_on_hold","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/cancelation_no_notes"]}},"responseCodes":["200","400","401","403","404","422","500","502"],"pointer":"/transaction/cancel","href":"transaction/paths/~1transaction~1cancel/delete","summary":"/transaction/cancel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST","exampleIds":["paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_void_flow","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_cancelation_request","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_orchestrator","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_cancel","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_on_hold","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/cancelation_no_notes"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST","exampleIds":["paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_void_flow","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_cancelation_request","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_orchestrator","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_cancel","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_on_hold","paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/cancelation_no_notes"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction cancelled successfully. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelFlow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates which cancellation path was used."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_cancelation_request","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_orchestrator","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_inbound_cancel"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_cancelation_request","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_orchestrator","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_inbound_cancel"]},{"code":"400","description":"Validation error, malformed JSON body, or transaction belonging to another partner. Also returned when ViaOne rejects the cancellation with HTTP 400 (payload keeps code 502001).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_branch_mismatch","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_other_partner"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_branch_mismatch","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_other_partner"]},{"code":"401","description":"Authentication error - invalid credentials or ViaOne authentication failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_401","exampleIds":["paths/~1transaction~1cancel/delete/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_401","exampleIds":["paths/~1transaction~1cancel/delete/responses/401/content/application~1json/examples/default"]},{"code":"403","description":"Authorization error - the partner is not allowed to access this resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_403","exampleIds":["paths/~1transaction~1cancel/delete/responses/403/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_403","exampleIds":["paths/~1transaction~1cancel/delete/responses/403/content/application~1json/examples/default"]},{"code":"404","description":"Transaction not found in DynamoDB or SQL Server. Also returned when ViaOne responds HTTP 404 (payload keeps code 502001).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1transaction~1cancel/delete/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1transaction~1cancel/delete/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Business rule rejection - terminal status, duplicate cancellation request, or inbound receiver flag not cancellable. Also returned when ViaOne responds HTTP 422 (payload keeps code 502001).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_422","exampleIds":["paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_duplicate_request","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_inbound_flag"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_422","exampleIds":["paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_duplicate_request","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_inbound_flag"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_500","exampleIds":["paths/~1transaction~1cancel/delete/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_500","exampleIds":["paths/~1transaction~1cancel/delete/responses/500/content/application~1json/examples/default"]},{"code":"502","description":"External service error - ViaOne or PayerProxy orchestrator failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_502","exampleIds":["paths/~1transaction~1cancel/delete/responses/502/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_502","exampleIds":["paths/~1transaction~1cancel/delete/responses/502/content/application~1json/examples/default"]}],"pointer":"/paths/~1transaction~1cancel/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_cancelation_request","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_orchestrator","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_inbound_cancel"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_cancelation_request","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_orchestrator","paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_inbound_cancel"]}}},{"code":"400","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_branch_mismatch","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_other_partner"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_branch_mismatch","paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_other_partner"]}}},{"code":"401","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_401","exampleIds":["paths/~1transaction~1cancel/delete/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_401","exampleIds":["paths/~1transaction~1cancel/delete/responses/401/content/application~1json/examples/default"]}}},{"code":"403","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_403","exampleIds":["paths/~1transaction~1cancel/delete/responses/403/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_403","exampleIds":["paths/~1transaction~1cancel/delete/responses/403/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1transaction~1cancel/delete/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1transaction~1cancel/delete/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_422","exampleIds":["paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_duplicate_request","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_inbound_flag"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_422","exampleIds":["paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/default","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_duplicate_request","paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_inbound_flag"]}}},{"code":"500","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_500","exampleIds":["paths/~1transaction~1cancel/delete/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_500","exampleIds":["paths/~1transaction~1cancel/delete/responses/500/content/application~1json/examples/default"]}}},{"code":"502","schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_502","exampleIds":["paths/~1transaction~1cancel/delete/responses/502/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_502","exampleIds":["paths/~1transaction~1cancel/delete/responses/502/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/paths/~1transaction~1cancel/delete"}],"panels":[]}]},"httpPath":"/transaction/cancel"},{"label":"/transaction/confirm","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/transaction/paths/~1transaction~1confirm/post","routeSlug":"/apis/outbound/transaction/paths/~1transaction~1confirm/post","metadata":{"seo":{"title":"/transaction/confirm","description":"Confirms a previously created transaction and finalizes it for processing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/transaction/confirm","isWebhook":false,"pointer":"/paths/~1transaction~1confirm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/transaction/confirm","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms a previously created transaction and finalizes it for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1confirm/post/request/purpose","deepLinkHash":"/transaction/paths/~1transaction~1confirm/post#transaction/paths/~1transaction~1confirm/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms a transaction that was created with a funding type that requires explicit confirmation (e.g., cash, debit card)."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1confirm/post/request/when-to-use","deepLinkHash":"/transaction/paths/~1transaction~1confirm/post#transaction/paths/~1transaction~1confirm/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint after a transaction has been created and the payment has been collected or authorized:"},"children":[]}]}]},{"$$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":"Cash transactions: after the cash has been received at the branch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debit card transactions: after the card payment has been approved (requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last4CardNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1confirm/post/request/what-happens-next","deepLinkHash":"/transaction/paths/~1transaction~1confirm/post#transaction/paths/~1transaction~1confirm/post/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates the transaction exists and belongs to the branch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases any compliance holds (Hold 87)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For debit card funding, registers the card payment details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates transaction status to CONFIRMED in DynamoDB"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates and returns the transaction receipt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1confirm/post/request/authentication","deepLinkHash":"/transaction/paths/~1transaction~1confirm/post#transaction/paths/~1transaction~1confirm/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1confirm/post/request/notes","deepLinkHash":"/transaction/paths/~1transaction~1confirm/post#transaction/paths/~1transaction~1confirm/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the transaction was already confirmed, returns the existing receipt without re-processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transactions with funding type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (undefined) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"H"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (hold/remote) cannot be confirmed through this endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1confirm/post/request/common-errors","deepLinkHash":"/transaction/paths/~1transaction~1confirm/post#transaction/paths/~1transaction~1confirm/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors, invalid branchId, missing debit card fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Transaction not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Transaction not eligible for confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1transaction~1confirm/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST","exampleIds":["paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/cash_funding","paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/debit_card_funding"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST","exampleIds":["paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/cash_funding","paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/debit_card_funding"],"pointer":"/paths/~1transaction~1confirm/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transaction/confirm","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST","exampleIds":["paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/cash_funding","paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/debit_card_funding"]}},"responseCodes":["200","400","401","404","422","500"],"pointer":"/transaction/confirm","href":"transaction/paths/~1transaction~1confirm/post","summary":"/transaction/confirm"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST","exampleIds":["paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/cash_funding","paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/debit_card_funding"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST","exampleIds":["paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/cash_funding","paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/debit_card_funding"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/200_already_confirmed"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/200_already_confirmed"]},{"code":"400","description":"Response fail validations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_no_permission"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_no_permission"]},{"code":"401","description":"Response fail authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1confirm/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1confirm/post/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Response fail not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1confirm/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1confirm/post/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Response fail - The server understands the request, but cannot process it due to business rules.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1confirm/post/responses/422/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1confirm/post/responses/422/content/application~1json/examples/default"]},{"code":"500","description":"Response fail - Internal Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1confirm/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1confirm/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1transaction~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/200_already_confirmed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/200_already_confirmed"]}}},{"code":"400","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_no_permission"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_invalid_branch","paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_no_permission"]}}},{"code":"401","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1confirm/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1confirm/post/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1confirm/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1confirm/post/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1confirm/post/responses/422/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1confirm/post/responses/422/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1confirm/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1confirm/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/paths/~1transaction~1confirm/post"}],"panels":[]}]},"httpPath":"/transaction/confirm"},{"label":"/transaction/create","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/transaction/paths/~1transaction~1create/post","routeSlug":"/apis/outbound/transaction/paths/~1transaction~1create/post","metadata":{"seo":{"title":"/transaction/create","description":"Creates a new money transfer and registers it in the ViaBlocks platform. Supports both cross-border (international) and domestic (USA to USA) corridors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/transaction/create","isWebhook":false,"pointer":"/paths/~1transaction~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/transaction/create","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new money transfer and registers it in the ViaBlocks platform. Supports both "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cross-border"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (international) and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domestic"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (USA to USA) corridors."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/purpose","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates a new remittance transaction with sender, beneficiary, and financial details."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/when-to-use","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you are ready to submit:"},"children":[]}]}]},{"$$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":"Sender onboarding details (KYC/AML fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary details and payout configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origination and delivery amounts/currencies"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding configuration (cash or remote payment)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/what-happens-next","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next steps depend on the funding method:"},"children":[]}]}]},{"$$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":"Cash funding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction may proceed directly into processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remote payment funding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transaction is created in a pending funding state. The sender must complete payment remotely."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/domestic-transfers-(usa-to-usa)","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/domestic-transfers-(usa-to-usa)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domestic Transfers (USA to USA)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint also supports "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domestic transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the United States. For domestic transfers, both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", both currencies are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the exchange rate is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1create/post/request/available-delivery-modes-for-domestic-usa","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/available-delivery-modes-for-domestic-usa"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available delivery modes for domestic USA"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery Mode"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATM Network"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary withdraws cash at an ATM using a reference code."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash Pickup (Viamericas agencies)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary picks up cash at an authorized Viamericas agent location."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Deposit (any U.S. bank)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Direct deposit to any U.S. bank account. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"routingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryModeDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"O"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile Wallet"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1create/post/request/key-differences-from-cross-border","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/key-differences-from-cross-border"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key differences from cross-border"},"children":[]}]}]},{"$$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":"Exchange rate is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (USD ΓåÆ USD)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both origin and delivery country are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryModeDetails.routingNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for bank deposits (mode "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system validates routing numbers via ABA checksum and provider verification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/quote-coherence-validation-(outbound-gco-usa-origin)","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/quote-coherence-validation-(outbound-gco-usa-origin)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quote Coherence Validation (Outbound ΓÇö USA origin)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For outbound transactions originating from the United States, the system validates that the financial parameters match the most recent quote. This ensures pricing integrity between the quote and the actual transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1create/post/request/validated-fields","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/validated-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validated fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation Rule"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must match the current rate from the pricing engine, or fall within the allowed rate range if ViaTasa is active for the partner."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must exactly match the fee returned by the quote ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeBreakdown.fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fundingFee"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when > 0 in quote."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must match "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeBreakdown.fundingFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the quote returned a non-zero funding fee, this field is mandatory."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"taxes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when > 0 in quote."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must match "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeBreakdown.taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the quote returned a non-zero tax, this field is mandatory."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minimumAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maximumAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by the quote."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAmount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be coherent with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originationAmount ├ù exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If a payer delivery limit exists, the delivery amount must not exceed it."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1create/post/request/how-it-works","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How it works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request a quote via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /transaction/quote"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the desired parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the values from the quote response ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeBreakdown.fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeBreakdown.fundingFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeBreakdown.taxes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in your create request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the partner has ViaTasa active, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be modified within the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rateRange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bounds returned by the quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit the create request with all validated fields populated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1create/post/request/important-notes","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/important-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, if provided, is validated before pricing checks. An invalid promo code will reject the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/routing-number-and-account-verification-(usa-only)","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/routing-number-and-account-verification-(usa-only)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing Number and Account Verification (USA only)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the transaction includes a routing number for a USA-based bank account (either in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryModeDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the system performs additional validations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ABA Checksum:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The routing number must pass ABA checksum validation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provider Verification:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The routing number is verified against external banking providers to confirm it is valid and active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Risk Assessment:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If an account number is provided alongside a valid routing, the system verifies the account. If the verification returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HIGH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" risk or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Declined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, the transaction is rejected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These validations apply exclusively to USA routing numbers. For other countries, routing numbers are not validated against external providers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/authentication","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/notes","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request validation is enforced for formats, allowed values, corridor rules, and compliance requirements."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1create/post/request/common-errors","deepLinkHash":"/transaction/paths/~1transaction~1create/post#transaction/paths/~1transaction~1create/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields, quote coherence mismatch)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Sender/beneficiary linkage issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Business-rule rejection (e.g., credit limit, amount limits, compliance block)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1transaction~1create/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST","exampleIds":["paths/~1transaction~1create/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_with_viatasa","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_cash_pickup","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_bank_deposit_ach","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_remote_payment","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_debit_card","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_mobile_wallet","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_pix_brazil","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_upi_india","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_home_delivery","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_atm_mexico","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_atm","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_cash_pickup_viamericas","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_bank_deposit"]}},"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST","exampleIds":["paths/~1transaction~1create/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_with_viatasa","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_cash_pickup","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_bank_deposit_ach","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_remote_payment","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_debit_card","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_mobile_wallet","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_pix_brazil","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_upi_india","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_home_delivery","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_atm_mexico","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_atm","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_cash_pickup_viamericas","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_bank_deposit"],"pointer":"/paths/~1transaction~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transaction/create","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST","exampleIds":["paths/~1transaction~1create/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_with_viatasa","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_cash_pickup","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_bank_deposit_ach","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_remote_payment","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_debit_card","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_mobile_wallet","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_pix_brazil","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_upi_india","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_home_delivery","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_atm_mexico","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_atm","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_cash_pickup_viamericas","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_bank_deposit"]}},"responseCodes":["200","400","401","404","422","500"],"pointer":"/transaction/create","href":"transaction/paths/~1transaction~1create/post","summary":"/transaction/create"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST","exampleIds":["paths/~1transaction~1create/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_with_viatasa","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_cash_pickup","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_bank_deposit_ach","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_remote_payment","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_debit_card","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_mobile_wallet","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_pix_brazil","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_upi_india","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_home_delivery","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_atm_mexico","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_atm","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_cash_pickup_viamericas","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_bank_deposit"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST","exampleIds":["paths/~1transaction~1create/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_with_viatasa","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_cash_pickup","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_bank_deposit_ach","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_remote_payment","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_debit_card","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_mobile_wallet","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_pix_brazil","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_upi_india","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_home_delivery","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_atm_mexico","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_atm","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_cash_pickup_viamericas","paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_bank_deposit"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1create/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_no_compliance","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_all_fulfilled_at_creation","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_remote_payment"]}},"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1create/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_no_compliance","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_all_fulfilled_at_creation","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_remote_payment"]},{"code":"400","description":"Response fail validations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1create/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_out_of_range","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_delivery_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_funding_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_taxes_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_promo_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_routing_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_account_high_risk"]}},"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1create/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_out_of_range","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_delivery_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_funding_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_taxes_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_promo_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_routing_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_account_high_risk"]},{"code":"401","description":"Response fail authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1create/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1create/post/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Response fail not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1create/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1create/post/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Response fail - The server understands the request, but cannot process it due to business rules.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1create/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_exceeds_max","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_below_min","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_compliance_block","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_duplicate_external_id","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_pricing_not_available"]}},"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1create/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_exceeds_max","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_below_min","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_compliance_block","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_duplicate_external_id","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_pricing_not_available"]},{"code":"500","description":"Response fail - Internal Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1create/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1create/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1transaction~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1create/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_no_compliance","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_all_fulfilled_at_creation","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_remote_payment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1create/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_no_compliance","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_all_fulfilled_at_creation","paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_remote_payment"]}}},{"code":"400","schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1create/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_out_of_range","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_delivery_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_funding_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_taxes_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_promo_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_routing_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_account_high_risk"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1create/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_out_of_range","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_delivery_mismatch","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_funding_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_taxes_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_required","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_promo_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_routing_invalid","paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_account_high_risk"]}}},{"code":"401","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1create/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1create/post/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1create/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1create/post/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1create/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_exceeds_max","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_below_min","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_compliance_block","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_duplicate_external_id","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_pricing_not_available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1create/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_exceeds_max","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_below_min","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_compliance_block","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_duplicate_external_id","paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_pricing_not_available"]}}},{"code":"500","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1create/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1create/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/paths/~1transaction~1create/post"}],"panels":[]}]},"httpPath":"/transaction/create"},{"label":"transaction/quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/transaction/paths/~1transaction~1quote/post","routeSlug":"/apis/outbound/transaction/paths/~1transaction~1quote/post","metadata":{"seo":{"title":"transaction/quote","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"transaction/quote","isWebhook":false,"pointer":"/paths/~1transaction~1quote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"transaction/quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1quote/post/request/purpose","deepLinkHash":"/transaction/paths/~1transaction~1quote/post#transaction/paths/~1transaction~1quote/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a real-time pricing quote for a remittance transaction before committing to the actual transfer. This endpoint calculates exchange rates, fees, and total amounts based on the requested transaction parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1quote/post/request/when-to-use","deepLinkHash":"/transaction/paths/~1transaction~1quote/post#transaction/paths/~1transaction~1quote/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to Use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint when you need to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display pricing information to customers before they commit to a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculate the exact amount the beneficiary will receive"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show exchange rates and fee breakdowns"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate transaction parameters and limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compare pricing across different delivery methods or payout networks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1quote/post/request/authentication","deepLinkHash":"/transaction/paths/~1transaction~1quote/post#transaction/paths/~1transaction~1quote/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers for partner authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1quote/post/request/notes","deepLinkHash":"/transaction/paths/~1transaction~1quote/post#transaction/paths/~1transaction~1quote/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quotes are valid for 15 minutes from the timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rates are subject to market fluctuations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fees may vary based on delivery method, destination country, and payout network"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction limits (minimum/maximum amounts) are returned in the response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All amounts are calculated in real-time based on current rates and partner configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiptFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field controls the pre-receipt output format ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). When omitted, the receipt is generated in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default. It only applies when receipt generation is enabled for the partner."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1quote/post/request/common-errors","deepLinkHash":"/transaction/paths/~1transaction~1quote/post#transaction/paths/~1transaction~1quote/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Validation errors (missing/invalid fields)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Business-rule rejection (e.g., pricing not available)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error codes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The body of the request is required. Invalid JSON format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field is required (applies to any required field)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field must be of the correct type (string, number, object, array)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field does not meet minimum length requirement"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field exceeds maximum length"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field does not match required format (e.g., email, date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field value is below minimum allowed value"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400007"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field value exceeds maximum allowed value"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400008"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field has too many decimal places"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field does not match required pattern (regex)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Field value is not in the list of allowed values"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Amount below minimum transaction limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Amount exceeds maximum transaction limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Destination country not supported (also when deliveryLocationNetwork is missing or empty)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery mode not available for destination country"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Currency pair not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing not available for requested parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422007"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Partner not configured for quote endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Database error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing service unavailable"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx123456789"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"xxxx987654321xxs"}],"pointer":"/paths/~1transaction~1quote/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST","exampleIds":["paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/basic_quote_origination","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_by_delivery_amount","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_bank_deposit_colombia","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_promo_code","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_receipt_pdf","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_branch_context","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_paybyphone_funding","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_mobile_wallet","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_atm_mexico","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_pix_brazil","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_upi_india","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_home_delivery"]}},"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST","exampleIds":["paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/basic_quote_origination","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_by_delivery_amount","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_bank_deposit_colombia","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_promo_code","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_receipt_pdf","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_branch_context","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_paybyphone_funding","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_mobile_wallet","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_atm_mexico","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_pix_brazil","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_upi_india","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_home_delivery"],"pointer":"/paths/~1transaction~1quote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transaction/quote","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"xxxx123456789","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"xxxx987654321xxs","schemaId":"schema_97"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST","exampleIds":["paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/basic_quote_origination","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_by_delivery_amount","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_bank_deposit_colombia","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_promo_code","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_receipt_pdf","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_branch_context","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_paybyphone_funding","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_mobile_wallet","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_atm_mexico","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_pix_brazil","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_upi_india","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_home_delivery"]}},"responseCodes":["200","400","401","422","500"],"pointer":"/transaction/quote","href":"transaction/paths/~1transaction~1quote/post","summary":"transaction/quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST","exampleIds":["paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/basic_quote_origination","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_by_delivery_amount","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_bank_deposit_colombia","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_promo_code","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_receipt_pdf","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_branch_context","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_paybyphone_funding","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_mobile_wallet","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_atm_mexico","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_pix_brazil","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_upi_india","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_home_delivery"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST","exampleIds":["paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/required_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/all_fields","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/basic_quote_origination","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_by_delivery_amount","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_bank_deposit_colombia","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_promo_code","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_receipt_pdf","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_branch_context","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_paybyphone_funding","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_mobile_wallet","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_atm_mexico","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_pix_brazil","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_upi_india","paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_home_delivery"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful quote response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_payer_limits","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_valid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_invalid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_viatasa","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_warnings"]}},"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_payer_limits","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_valid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_invalid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_viatasa","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_warnings"]},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_invalid_format","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_not_allowed"]}},"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_invalid_format","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_not_allowed"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1quote/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1quote/post/responses/401/content/application~1json/examples/default"]},{"code":"422","description":"Business rule validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_payer_limit_blocking","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_pricing_unavailable"]}},"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_payer_limit_blocking","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_pricing_unavailable"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1quote/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1quote/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1transaction~1quote/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_payer_limits","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_valid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_invalid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_viatasa","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_warnings"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_payer_limits","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_valid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_invalid","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_viatasa","paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_warnings"]}}},{"code":"400","schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_invalid_format","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_not_allowed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_invalid_format","paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_not_allowed"]}}},{"code":"401","schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1quote/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1quote/post/responses/401/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_payer_limit_blocking","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_pricing_unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_422","exampleIds":["paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/default","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_payer_limit_blocking","paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_pricing_unavailable"]}}},{"code":"500","schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1quote/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1transaction~1quote/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/paths/~1transaction~1quote/post"}],"panels":[]}]},"httpPath":"/transaction/quote"},{"label":"/transaction/receipt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/transaction/paths/~1transaction~1receipt/get","routeSlug":"/apis/outbound/transaction/paths/~1transaction~1receipt/get","metadata":{"seo":{"title":"/transaction/receipt","description":"Generates and retrieves the receipt for a completed transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/transaction/receipt","isWebhook":false,"pointer":"/paths/~1transaction~1receipt/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/transaction/receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates and retrieves the receipt for a completed transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1receipt/get/request/purpose","deepLinkHash":"/transaction/paths/~1transaction~1receipt/get#transaction/paths/~1transaction~1receipt/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the transaction receipt in HTML or PDF format, including all transaction details, sender/beneficiary information, and fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1receipt/get/request/when-to-use","deepLinkHash":"/transaction/paths/~1transaction~1receipt/get#transaction/paths/~1transaction~1receipt/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint after a transaction has been confirmed to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the receipt for display or printing at the branch"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a PDF version for email or download"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain the hosted receipt URL for sharing with the sender"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1receipt/get/request/what-happens-next","deepLinkHash":"/transaction/paths/~1transaction~1receipt/get#transaction/paths/~1transaction~1receipt/get/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates the transaction exists and has been confirmed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates the receipt file (PDF or HTML) via the receipt template engine"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetches the POS HTML receipt from ViaOne for printing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caches both results in DynamoDB for subsequent requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the receipt URL and HTML content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1receipt/get/request/authentication","deepLinkHash":"/transaction/paths/~1transaction~1receipt/get#transaction/paths/~1transaction~1receipt/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1receipt/get/request/notes","deepLinkHash":"/transaction/paths/~1transaction~1receipt/get#transaction/paths/~1transaction~1receipt/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter controls the output format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is deprecated but still supported for backward compatibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receipt templates are partner-specific and configured per chain_id."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The receipt URL is a publicly accessible S3 link."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subsequent calls return cached results without regeneration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1receipt/get/request/common-errors","deepLinkHash":"/transaction/paths/~1transaction~1receipt/get#transaction/paths/~1transaction~1receipt/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Missing or invalid UUID, invalid format value"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Transaction not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Transaction has not been confirmed yet"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error (template not found, S3 upload failure)"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"uuid","in":"query","schemaId":"schema_136","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier (UUID) of the transaction for which to generate the receipt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"type","in":"query","schemaId":"schema_137","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"example":"string"},{"name":"format","in":"query","schemaId":"schema_138","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output format for the receipt. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"example":"pdf"}],"pointer":"/paths/~1transaction~1receipt/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1transaction~1receipt/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transaction/receipt","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"uuid","in":"query","required":true,"example":"string","schemaId":"schema_136"},{"name":"type","in":"query","required":false,"example":"string","schemaId":"schema_137"},{"name":"format","in":"query","required":false,"example":"pdf","schemaId":"schema_138"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","422","500"],"pointer":"/transaction/receipt","href":"transaction/paths/~1transaction~1receipt/get","summary":"/transaction/receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/200_pdf"]}},"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/200_pdf"]},{"code":"400","description":"Response fail validations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/400_missing_uuid"]}},"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/400_missing_uuid"]},{"code":"401","description":"Response fail authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1receipt/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1receipt/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Response fail not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1receipt/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1receipt/get/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"Response fail - Transaction has not been confirmed yet","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1transaction~1receipt/get/responses/422/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1transaction~1receipt/get/responses/422/content/application~1json/examples/default"]},{"code":"500","description":"Response fail - Internal Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1receipt/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1receipt/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1transaction~1receipt/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/200_pdf"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/200_pdf"]}}},{"code":"400","schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/400_missing_uuid"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/default","paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/400_missing_uuid"]}}},{"code":"401","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1receipt/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1receipt/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1receipt/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1receipt/get/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1transaction~1receipt/get/responses/422/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_422","exampleIds":["paths/~1transaction~1receipt/get/responses/422/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1receipt/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1receipt/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/paths/~1transaction~1receipt/get"}],"panels":[]}]},"httpPath":"/transaction/receipt"},{"label":"/transaction/status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/transaction/paths/~1transaction~1status/get","routeSlug":"/apis/outbound/transaction/paths/~1transaction~1status/get","metadata":{"seo":{"title":"/transaction/status","description":"Retrieves the current status and details of a transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/transaction/status","isWebhook":false,"pointer":"/paths/~1transaction~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/transaction/status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current status and details of a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1status/get/request/purpose","deepLinkHash":"/transaction/paths/~1transaction~1status/get#transaction/paths/~1transaction~1status/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the real-time status, financial details, compliance information, and tracking data for a specific transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1status/get/request/when-to-use","deepLinkHash":"/transaction/paths/~1transaction~1status/get#transaction/paths/~1transaction~1status/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to:"},"children":[]}]}]},{"$$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":"Check the current processing status of a transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve hold information and compliance requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the transaction tracking URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor transaction lifecycle (creation, confirmation, payment, cancellation)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check which required documents have been fulfilled or are still pending"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1status/get/request/what-happens-next","deepLinkHash":"/transaction/paths/~1transaction~1status/get#transaction/paths/~1transaction~1status/get/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates the transaction exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves real-time transaction status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks fulfillment status of each required document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns status, holds, compliance requirements with fulfillment status, and financial details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1status/get/request/authentication","deepLinkHash":"/transaction/paths/~1transaction~1status/get#transaction/paths/~1transaction~1status/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1status/get/request/notes","deepLinkHash":"/transaction/paths/~1transaction~1status/get#transaction/paths/~1transaction~1status/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates what compliance documents are needed (e.g., KYC, ID, SSN)."},"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":"document_requirements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field provides the detailed fulfillment status for each required document, showing whether it has been completed or is still pending."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold information includes active holds that may be blocking the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1status/get/request/common-errors","deepLinkHash":"/transaction/paths/~1transaction~1status/get#transaction/paths/~1transaction~1status/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Missing or invalid UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Transaction not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"uuid","in":"query","schemaId":"schema_139","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1transaction~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1transaction~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transaction/status","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"uuid","in":"query","required":true,"example":"string","schemaId":"schema_139"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/transaction/status","href":"transaction/paths/~1transaction~1status/get","summary":"/transaction/status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1status/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_rejected","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_all_documents_fulfilled","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_sendtobank","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_transfered","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_paid","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_in_review","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_expired","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_pending_all","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_cancel","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_void","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_expired"]}},"schemaId":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1status/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_rejected","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_all_documents_fulfilled","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_sendtobank","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_transfered","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_paid","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_in_review","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_expired","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_pending_all","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_cancel","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_void","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_expired"]},{"code":"400","description":"Response fail validations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1status/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1status/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Response fail authentication","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1status/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1status/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Response fail not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1status/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1status/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Response fail - Internal Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1status/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1status/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1transaction~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1status/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_rejected","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_all_documents_fulfilled","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_sendtobank","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_transfered","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_paid","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_in_review","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_expired","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_pending_all","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_cancel","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_void","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_expired"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1transaction~1status/get/responses/200/content/application~1json/examples/default","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_rejected","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_all_documents_fulfilled","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_sendtobank","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_transfered","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_paid","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_in_review","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_expired","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_pending_all","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_cancel","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_void","paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_expired"]}}},{"code":"400","schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1status/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1transaction~1status/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1status/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1transaction~1status/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1status/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1transaction~1status/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1status/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1transaction~1status/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/paths/~1transaction~1status/get"}],"panels":[]}]},"httpPath":"/transaction/status"},{"label":"/transaction/update","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/transaction/paths/~1transaction~1update/put","routeSlug":"/apis/outbound/transaction/paths/~1transaction~1update/put","metadata":{"seo":{"title":"/transaction/update","description":"Updates an existing cross-border money transfer transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/transaction/update","isWebhook":false,"pointer":"/paths/~1transaction~1update/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/transaction/update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing cross-border money transfer transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1update/put/request/purpose","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit compliance information (KYC, DOB, SSN, Source of Funds) when required to complete the transaction"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload identification document images (Copy1ID) for compliance review"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide identification document information (ID) for verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request modifications to beneficiary details and delivery account information"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1update/put/request/use-cases","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1update/put/request/1.-compliance-information-(kyc)","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/1.-compliance-information-(kyc)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1. Compliance Information (KYC)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the compliance area requires additional sender information, all fields corresponding to the specific KYC variant must be submitted. The system supports multiple KYC levels:"},"children":[]}]}]},{"$$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":"KYC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Full form: identity, employment, SSN, and document fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC-Short"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Basic: identity and document fields only (no employer, no SSN)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KYC-Long"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Extended: identity, document, and employment fields (no SSN)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can determine which KYC variant is required by checking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction/status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1update/put/request/2.-identification-document-information-(id)","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/2.-identification-document-information-(id)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Identification Document Information (ID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must provide the document type, number, expiration date, and issuing country. This is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" about the document, not the image."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1update/put/request/3.-identification-document-image-upload-(copy1id)","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/3.-identification-document-image-upload-(copy1id)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. Identification Document Image Upload (Copy1ID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Copy1ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must upload the document image(s):"},"children":[]}]}]},{"$$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":"Front image"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentFrontImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is always required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back image"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentBackImage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is required for double-sided documents (Driver's License, State ID, Green Card)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single-sided documents (Passport) only need the front image"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the back image is required but not provided, a 400 error will indicate this"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The uploaded document goes through an external review process. You can check the review status via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction/status"},"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":"in_review"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Document uploaded, awaiting approval (no action needed)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Document accepted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Document rejected, must re-upload with a corrected document"},"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":" — Document has expired, must re-upload with a current document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1update/put/request/4.-other-individual-requirements","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/4.-other-individual-requirements"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4. Other Individual 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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DOB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Date of birth only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Social Security Number only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SFunds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Source of funds declaration only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These can be submitted individually or combined with other fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"transaction/paths/~1transaction~1update/put/request/5.-beneficiary-and-delivery-modification","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/5.-beneficiary-and-delivery-modification"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5. Beneficiary & Delivery Modification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can request changes to the beneficiary's personal information and delivery account details. Modification requests are subject to eligibility — the transaction must not have a pending or completed modification."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1update/put/request/how-it-works","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/how-it-works"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How It Works"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system validates the transaction exists and is not cancelled/paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checks which compliance requirements are already satisfied (won't re-request fulfilled items)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates that all pending required fields are present in the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processes KYC data if required and not already submitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processes ID image upload if required and not already approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits beneficiary/delivery modification if eligible"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a response indicating which operations were performed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1update/put/request/important-notes","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/important-notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only fields with values are processed; empty or missing fields retain their current values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance submissions are always allowed as long as the transaction is not cancelled/paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a requirement was already fulfilled (e.g., DOB was sent at creation), it won't be re-requested"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a document was rejected or expired, the system will require re-upload and include the reason in the error message"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modification requests require the transaction to be eligible (not already modified or pending modification)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All operations can be combined in a single request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"transaction/paths/~1transaction~1update/put/request/authentication","deepLinkHash":"/transaction/paths/~1transaction~1update/put#transaction/paths/~1transaction~1update/put/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_97","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1transaction~1update/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST","exampleIds":["paths/~1transaction~1update/put/requestBody/content/application~1json/examples/full_update","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/compliance_kyc","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_drivers_license","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_passport","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/modification","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/dob_only","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/ssn_and_sfunds","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/reupload_rejected_id"]}},"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST","exampleIds":["paths/~1transaction~1update/put/requestBody/content/application~1json/examples/full_update","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/compliance_kyc","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_drivers_license","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_passport","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/modification","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/dob_only","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/ssn_and_sfunds","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/reupload_rejected_id"],"pointer":"/paths/~1transaction~1update/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transaction/update","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_96"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_97"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST","exampleIds":["paths/~1transaction~1update/put/requestBody/content/application~1json/examples/full_update","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/compliance_kyc","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_drivers_license","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_passport","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/modification","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/dob_only","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/ssn_and_sfunds","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/reupload_rejected_id"]}},"responseCodes":["200","400","401","404","422","500"],"pointer":"/transaction/update","href":"transaction/paths/~1transaction~1update/put","summary":"/transaction/update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST","exampleIds":["paths/~1transaction~1update/put/requestBody/content/application~1json/examples/full_update","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/compliance_kyc","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_drivers_license","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_passport","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/modification","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/dob_only","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/ssn_and_sfunds","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/reupload_rejected_id"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST","exampleIds":["paths/~1transaction~1update/put/requestBody/content/application~1json/examples/full_update","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/compliance_kyc","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_drivers_license","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_passport","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/modification","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/dob_only","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/ssn_and_sfunds","paths/~1transaction~1update/put/requestBody/content/application~1json/examples/reupload_rejected_id"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The update was processed successfully. The response indicates which operations were performed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_all_operations","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_compliance_only","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_uploaded","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_retry_needed","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_modification_sent"]}},"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_all_operations","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_compliance_only","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_uploaded","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_retry_needed","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_modification_sent"]},{"code":"400","description":"The request contains invalid or missing data. Review the error details and correct the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_no_fields","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_compliance_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_back_image_required","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_rejected_reupload","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_expired_reupload"]}},"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_no_fields","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_compliance_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_back_image_required","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_rejected_reupload","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_expired_reupload"]},{"code":"401","description":"Authentication failed. Verify your credentials.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_401","exampleIds":["paths/~1transaction~1update/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_401","exampleIds":["paths/~1transaction~1update/put/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"The transaction was not found. Verify the UUID is correct.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1transaction~1update/put/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1transaction~1update/put/responses/404/content/application~1json/examples/default"]},{"code":"422","description":"The request was understood but cannot be processed due to the transaction's current state.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_422","exampleIds":["paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_cancelled","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_not_eligible","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_already_modified"]}},"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_422","exampleIds":["paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_cancelled","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_not_eligible","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_already_modified"]},{"code":"500","description":"An unexpected error occurred. Please try again later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1transaction~1update/put/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1transaction~1update/put/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1transaction~1update/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_all_operations","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_compliance_only","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_uploaded","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_retry_needed","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_modification_sent"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_all_operations","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_compliance_only","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_uploaded","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_retry_needed","paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_modification_sent"]}}},{"code":"400","schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_no_fields","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_compliance_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_back_image_required","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_rejected_reupload","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_expired_reupload"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_no_fields","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_compliance_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_fields_missing","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_back_image_required","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_rejected_reupload","paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_expired_reupload"]}}},{"code":"401","schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_401","exampleIds":["paths/~1transaction~1update/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_401","exampleIds":["paths/~1transaction~1update/put/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1transaction~1update/put/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1transaction~1update/put/responses/404/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_422","exampleIds":["paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_cancelled","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_not_eligible","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_already_modified"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_422","exampleIds":["paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_cancelled","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_not_eligible","paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_already_modified"]}}},{"code":"500","schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1transaction~1update/put/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1transaction~1update/put/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction/paths/~1transaction~1update/put"}],"panels":[]}]},"httpPath":"/transaction/update"}],"content":{"contentType":"group","meta":{"name":"Transaction"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transaction/cancel","summary":"/transaction/cancel","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/transaction/paths/~1transaction~1cancel/delete","deprecated":false},{"title":"/transaction/confirm","summary":"/transaction/confirm","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction/paths/~1transaction~1confirm/post","deprecated":false},{"title":"/transaction/create","summary":"/transaction/create","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction/paths/~1transaction~1create/post","deprecated":false},{"title":"/transaction/quote","summary":"transaction/quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction/paths/~1transaction~1quote/post","deprecated":false},{"title":"/transaction/receipt","summary":"/transaction/receipt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/paths/~1transaction~1receipt/get","deprecated":false},{"title":"/transaction/status","summary":"/transaction/status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transaction/paths/~1transaction~1status/get","deprecated":false},{"title":"/transaction/update","summary":"/transaction/update","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transaction/paths/~1transaction~1update/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook","link":"/apis/outbound/webhook","routeSlug":"/apis/outbound/webhook","items":[{"label":"/webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/webhook/paths/~1webhook/post","routeSlug":"/apis/outbound/webhook/paths/~1webhook/post","metadata":{"seo":{"title":"/webhook","description":"Registers a new webhook URL for receiving transaction status change notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/webhook","isWebhook":false,"pointer":"/paths/~1webhook/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers a new webhook URL for receiving transaction status change notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/post/request/integration-guide","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/integration-guide"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration Guide"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks allow you to receive real-time HTTP POST notifications when your transactions change status (e.g., from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onHold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Instead of polling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/transaction/status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you configure a URL and ViaBlocks pushes updates to you."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/step-by-step-setup","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/step-by-step-setup"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step-by-Step Setup"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register your webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your HTTPS URL and desired events. Save the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" securely."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implement your endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Your server must accept HTTP POST, return 2xx within 10 seconds, and verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Compute "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HMAC-SHA256(webhook_secret, raw_body_bytes)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and compare with the hex value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (after removing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sha256="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix). Use constant-time comparison."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage your config"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with webhook_id in body) to update, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /webhook?webhook_id=xxx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /webhook?webhook_id=xxx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to deactivate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rotate secrets"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /webhook/rotate-secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with webhook_id in body) periodically. Old secret remains valid for 24 hours."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test connectivity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /webhook/test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with webhook_id in body) to send a test delivery and verify your endpoint is working."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor deliveries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /webhook/deliveries?webhook_id=xxx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check delivery history and troubleshoot failures."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/available-endpoints","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/available-endpoints"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register webhook URL and get signing secret"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update webhook configuration (webhook_id in body)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all webhooks or get one (optional ?webhook_id=xxx)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/webhook"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivate webhook (?webhook_id=xxx required)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/webhook/rotate-secret"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rotate signing secret (webhook_id in body)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/webhook/test"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send test delivery (webhook_id in body)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/webhook/deliveries"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query delivery history (?webhook_id=xxx required)"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/supported-events","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/supported-events"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Events"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.onHold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction placed on hold (compliance/operational review)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.inProcess"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction completed internal processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.readyToSend"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction sent to bank for processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.transferred"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds transferred to payout network"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds paid to beneficiary"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction cancelled before completion"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.void"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction voided (within first minutes, before reaching central system)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction expired (not completed in allowed time window)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.all"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscribe to all events above"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/webhook-payload-format","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/webhook-payload-format"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Payload Format"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"event_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"event_type\": \"transaction.status.paid\",\n  \"transaction_uuid\": \"4ed19e29-5a6a-433d-908d-23377fabb617\",\n  \"new_status\": \"PAID\",\n  \"timestamp\": \"2025-01-15 19:55:24\",\n  \"id_branch\": \"A00765\",\n  \"id_receiver\": \"12345\",\n  \"external_id\": \"partner-ref-123\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"event_id\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"event_type\": \"transaction.status.paid\",\n  \"transaction_uuid\": \"4ed19e29-5a6a-433d-908d-23377fabb617\",\n  \"new_status\": \"PAID\",\n  \"timestamp\": \"2025-01-15 19:55:24\",\n  \"id_branch\": \"A00765\",\n  \"id_receiver\": \"12345\",\n  \"external_id\": \"partner-ref-123\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/http-headers-sent-with-each-notification","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/http-headers-sent-with-each-notification"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Headers Sent With Each Notification"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User-Agent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ViaBlocks-Webhook/1.0"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Signature"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sha256=<64-char-hex>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — HMAC-SHA256 of the body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Event"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction.status.paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique event ID (UUID v4) for deduplication"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/signature-verification-(python-example)","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/signature-verification-(python-example)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Verification (Python Example)"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"import hmac\nimport hashlib\n\ndef verify_signature(payload_body: bytes, secret: str, signature_header: str) -> bool:\n    expected = hmac.new(\n        key=secret.encode('utf-8'),\n        msg=payload_body,\n        digestmod=hashlib.sha256\n    ).hexdigest()\n    received = signature_header.removeprefix('sha256=')\n    return hmac.compare_digest(expected, received)\n","language":"python"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"import hmac\nimport hashlib\n\ndef verify_signature(payload_body: bytes, secret: str, signature_header: str) -> bool:\n    expected = hmac.new(\n        key=secret.encode('utf-8'),\n        msg=payload_body,\n        digestmod=hashlib.sha256\n    ).hexdigest()\n    received = signature_header.removeprefix('sha256=')\n    return hmac.compare_digest(expected, received)\n"},"children":[]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/retry-behavior","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/retry-behavior"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry Behavior"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your endpoint returns a non-2xx response or times out, ViaBlocks retries with exponential backoff: 30s, 2m, 10m, 30m, 2h (5 retries max). After 10 consecutive permanently failed events, the webhook is automatically deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook/paths/~1webhook/post/request/best-practices","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best Practices"},"children":[]}]}]},{"$$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":"Return HTTP 200 quickly (within 10 seconds) — process the payload asynchronously"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Webhook-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header to deduplicate notifications on your side"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" securely; it is only returned at registration time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rotate secrets periodically using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/webhook/rotate-secret"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/webhook/deliveries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to catch failures early"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/post/request/authentication","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/post/request/common-errors","deepLinkHash":"/webhook/paths/~1webhook/post#webhook/paths/~1webhook/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid URL format, unsupported event types, or empty events list"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error during registration"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/post/requestBody/content/application~1json/examples/all_branches_all_events","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_events_all_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/single_branch_specific_events"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/post/requestBody/content/application~1json/examples/all_branches_all_events","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_events_all_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/single_branch_specific_events"],"pointer":"/paths/~1webhook/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhook","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/post/requestBody/content/application~1json/examples/all_branches_all_events","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_events_all_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/single_branch_specific_events"]}},"responseCodes":["200","400","401","500"],"pointer":"/webhook","href":"webhook/paths/~1webhook/post","summary":"/webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/post/requestBody/content/application~1json/examples/all_branches_all_events","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_events_all_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/single_branch_specific_events"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/post/requestBody/content/application~1json/examples/all_branches_all_events","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/specific_events_all_branches","paths/~1webhook/post/requestBody/content/application~1json/examples/single_branch_specific_events"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook registered successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook/post/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook/post/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook/post/responses/400/content/application~1json/examples/default","paths/~1webhook/post/responses/400/content/application~1json/examples/400_invalid_branches"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook/post/responses/400/content/application~1json/examples/default","paths/~1webhook/post/responses/400/content/application~1json/examples/400_invalid_branches"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/post/responses/401/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1webhook/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook/post/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook/post/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook/post/responses/400/content/application~1json/examples/default","paths/~1webhook/post/responses/400/content/application~1json/examples/400_invalid_branches"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook/post/responses/400/content/application~1json/examples/default","paths/~1webhook/post/responses/400/content/application~1json/examples/400_invalid_branches"]}}},{"code":"401","schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/post/responses/401/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/paths/~1webhook/post"}],"panels":[]}]},"httpPath":"/webhook"},{"label":"/webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/webhook/paths/~1webhook/delete","routeSlug":"/apis/outbound/webhook/paths/~1webhook/delete","metadata":{"seo":{"title":"/webhook","description":"Deactivates a webhook registration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/webhook","isWebhook":false,"pointer":"/paths/~1webhook/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates a webhook registration."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/delete/request/purpose","deepLinkHash":"/webhook/paths/~1webhook/delete#webhook/paths/~1webhook/delete/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets active=false for the specified webhook. The configuration is preserved and can be re-activated via PUT /webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/delete/request/authentication","deepLinkHash":"/webhook/paths/~1webhook/delete#webhook/paths/~1webhook/delete/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/delete/request/notes","deepLinkHash":"/webhook/paths/~1webhook/delete#webhook/paths/~1webhook/delete/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires webhook_id as query parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Does NOT permanently delete — sets active=false"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-activate with PUT /webhook and {\"webhook_id\": \"xxx\", \"active\": true}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/delete/request/common-errors","deepLinkHash":"/webhook/paths/~1webhook/delete#webhook/paths/~1webhook/delete/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Missing webhook_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Webhook not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"webhook_id","in":"query","schemaId":"schema_140","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4 identifier of the webhook to deactivate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhook","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"webhook_id","in":"query","required":true,"example":"string","schemaId":"schema_140"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/webhook","href":"webhook/paths/~1webhook/delete","summary":"/webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook deactivated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1webhook/delete/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1webhook/delete/responses/200/content/application~1json/examples/default"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing webhook_id"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1webhook/delete/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1webhook/delete/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401"}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401"},{"code":"404","description":"Webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/delete/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/delete/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500"}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500"}],"pointer":"/paths/~1webhook/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1webhook/delete/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_200","exampleIds":["paths/~1webhook/delete/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1webhook/delete/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_400","exampleIds":["paths/~1webhook/delete/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401"}}},{"code":"404","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/delete/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/delete/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/paths/~1webhook/delete"}],"panels":[]}]},"httpPath":"/webhook"},{"label":"/webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/webhook/paths/~1webhook/get","routeSlug":"/apis/outbound/webhook/paths/~1webhook/get","metadata":{"seo":{"title":"/webhook","description":"Retrieves webhook configurations for the authenticated partner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/webhook","isWebhook":false,"pointer":"/paths/~1webhook/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves webhook configurations for the authenticated partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/get/request/behavior","deepLinkHash":"/webhook/paths/~1webhook/get#webhook/paths/~1webhook/get/request/behavior"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior"},"children":[]}]}]},{"$$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":"Without webhook_id: Returns ALL webhooks for the partner (array)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With webhook_id: Returns a specific webhook configuration (object)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/get/request/authentication","deepLinkHash":"/webhook/paths/~1webhook/get#webhook/paths/~1webhook/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/get/request/notes","deepLinkHash":"/webhook/paths/~1webhook/get#webhook/paths/~1webhook/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Does NOT return the webhook_secret (only available at registration time or after rotation)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns empty array if partner has no webhooks registered"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 404 if specified webhook_id not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/get/request/common-errors","deepLinkHash":"/webhook/paths/~1webhook/get#webhook/paths/~1webhook/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Webhook not found (when webhook_id specified)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"webhook_id","in":"query","schemaId":"schema_141","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4 identifier of a specific webhook to retrieve. If omitted, all webhooks for the partner are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1webhook/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhook","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"webhook_id","in":"query","required":false,"example":"string","schemaId":"schema_141"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"responseCodes":["200","401","404","500"],"pointer":"/webhook","href":"webhook/paths/~1webhook/get","summary":"/webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook configuration(s) retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook/get/responses/200/content/application~1json/examples/default","paths/~1webhook/get/responses/200/content/application~1json/examples/200_single","paths/~1webhook/get/responses/200/content/application~1json/examples/200_empty"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook/get/responses/200/content/application~1json/examples/default","paths/~1webhook/get/responses/200/content/application~1json/examples/200_single","paths/~1webhook/get/responses/200/content/application~1json/examples/200_empty"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401"}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401"},{"code":"404","description":"Webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/get/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500"}},"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500"}],"pointer":"/paths/~1webhook/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook/get/responses/200/content/application~1json/examples/default","paths/~1webhook/get/responses/200/content/application~1json/examples/200_single","paths/~1webhook/get/responses/200/content/application~1json/examples/200_empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook/get/responses/200/content/application~1json/examples/default","paths/~1webhook/get/responses/200/content/application~1json/examples/200_single","paths/~1webhook/get/responses/200/content/application~1json/examples/200_empty"]}}},{"code":"401","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401"}}},{"code":"404","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","exampleIds":["paths/~1webhook/get/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/paths/~1webhook/get"}],"panels":[]}]},"httpPath":"/webhook"},{"label":"/webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/webhook/paths/~1webhook/put","routeSlug":"/apis/outbound/webhook/paths/~1webhook/put","metadata":{"seo":{"title":"/webhook","description":"Updates the webhook configuration for the authenticated partner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/webhook","isWebhook":false,"pointer":"/paths/~1webhook/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the webhook configuration for the authenticated partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/put/request/purpose","deepLinkHash":"/webhook/paths/~1webhook/put#webhook/paths/~1webhook/put/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows a partner to partially update their webhook configuration including the URL, subscribed events, and active status."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/put/request/when-to-use","deepLinkHash":"/webhook/paths/~1webhook/put#webhook/paths/~1webhook/put/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to:"},"children":[]}]}]},{"$$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":"Change the webhook endpoint URL (triggers secret regeneration)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the list of subscribed event types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activate or deactivate the webhook without deleting it"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/put/request/what-happens-next","deepLinkHash":"/webhook/paths/~1webhook/put#webhook/paths/~1webhook/put/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is validated (webhook_id is required, at least one updatable field must be provided)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a new URL is provided, it is validated (HTTPS, max 2048 chars) and a new secret is generated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the specified fields are updated; unspecified fields remain unchanged"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full updated configuration is returned in the response"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/put/request/authentication","deepLinkHash":"/webhook/paths/~1webhook/put#webhook/paths/~1webhook/put/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/put/request/notes","deepLinkHash":"/webhook/paths/~1webhook/put#webhook/paths/~1webhook/put/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUT requires webhook_id in the request body to identify which webhook to update"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /webhook?webhook_id=xxx and DELETE /webhook?webhook_id=xxx use query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a partial update — only provided fields are modified"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changing the URL triggers webhook_secret regeneration (new secret returned in response)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If events are provided, the array must not be empty"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no webhook registration exists for the given webhook_id, returns 404"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook/put/request/common-errors","deepLinkHash":"/webhook/paths/~1webhook/put#webhook/paths/~1webhook/put/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid URL format, unsupported event types, empty events list, or missing webhook_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No webhook configuration exists for this webhook_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error during update"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/put/requestBody/content/application~1json/examples/update_events","paths/~1webhook/put/requestBody/content/application~1json/examples/update_url","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_specific","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_all","paths/~1webhook/put/requestBody/content/application~1json/examples/deactivate"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/put/requestBody/content/application~1json/examples/update_events","paths/~1webhook/put/requestBody/content/application~1json/examples/update_url","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_specific","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_all","paths/~1webhook/put/requestBody/content/application~1json/examples/deactivate"],"pointer":"/paths/~1webhook/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/webhook","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/put/requestBody/content/application~1json/examples/update_events","paths/~1webhook/put/requestBody/content/application~1json/examples/update_url","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_specific","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_all","paths/~1webhook/put/requestBody/content/application~1json/examples/deactivate"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/webhook","href":"webhook/paths/~1webhook/put","summary":"/webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/put/requestBody/content/application~1json/examples/update_events","paths/~1webhook/put/requestBody/content/application~1json/examples/update_url","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_specific","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_all","paths/~1webhook/put/requestBody/content/application~1json/examples/deactivate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST","exampleIds":["paths/~1webhook/put/requestBody/content/application~1json/examples/update_events","paths/~1webhook/put/requestBody/content/application~1json/examples/update_url","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_specific","paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_all","paths/~1webhook/put/requestBody/content/application~1json/examples/deactivate"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook configuration updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1webhook/put/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1webhook/put/responses/200/content/application~1json/examples/default"]},{"code":"400","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1webhook/put/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1webhook/put/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/put/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/put/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Webhook configuration not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1webhook/put/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1webhook/put/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1webhook/put/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1webhook/put/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1webhook/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1webhook/put/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_200","exampleIds":["paths/~1webhook/put/responses/200/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1webhook/put/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_400","exampleIds":["paths/~1webhook/put/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/put/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","exampleIds":["paths/~1webhook/put/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1webhook/put/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_404","exampleIds":["paths/~1webhook/put/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1webhook/put/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_500","exampleIds":["paths/~1webhook/put/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/paths/~1webhook/put"}],"panels":[]}]},"httpPath":"/webhook"},{"label":"/webhook/deliveries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/webhook/paths/~1webhook~1deliveries/get","routeSlug":"/apis/outbound/webhook/paths/~1webhook~1deliveries/get","metadata":{"seo":{"title":"/webhook/deliveries","description":"Returns the delivery history for a specific webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/webhook/deliveries","isWebhook":false,"pointer":"/paths/~1webhook~1deliveries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/webhook/deliveries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the delivery history for a specific webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1deliveries/get/request/purpose","deepLinkHash":"/webhook/paths/~1webhook~1deliveries/get#webhook/paths/~1webhook~1deliveries/get/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows a partner to query the delivery log to troubleshoot missed notifications, verify integration, and audit delivery attempts."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1deliveries/get/request/when-to-use","deepLinkHash":"/webhook/paths/~1webhook~1deliveries/get#webhook/paths/~1webhook~1deliveries/get/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to:"},"children":[]}]}]},{"$$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":"View the last 50 webhook delivery attempts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter deliveries by a specific transaction UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debug failed deliveries (check HTTP status codes, response times, failure reasons)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify that notifications are being received successfully"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1deliveries/get/request/what-happens-next","deepLinkHash":"/webhook/paths/~1webhook~1deliveries/get#webhook/paths/~1webhook~1deliveries/get/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partner's delivery log is queried (sorted by timestamp descending)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Up to 50 records are returned"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a transaction_uuid filter is provided, only matching records are returned"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1deliveries/get/request/authentication","deepLinkHash":"/webhook/paths/~1webhook~1deliveries/get#webhook/paths/~1webhook~1deliveries/get/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1deliveries/get/request/notes","deepLinkHash":"/webhook/paths/~1webhook~1deliveries/get#webhook/paths/~1webhook~1deliveries/get/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns at most 50 records per request, ordered by most recent first"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery log records are retained for 30 days and automatically expire"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An empty array is returned (HTTP 200) if no delivery records exist"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction_uuid filter must be a valid lowercase UUID v4 format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1deliveries/get/request/common-errors","deepLinkHash":"/webhook/paths/~1webhook~1deliveries/get#webhook/paths/~1webhook~1deliveries/get/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid transaction_uuid format"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Webhook not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error querying delivery log"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"webhook_id","in":"query","schemaId":"schema_142","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4 identifier of the webhook to query deliveries for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, pattern=400009"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"transaction_uuid","in":"query","schemaId":"schema_143","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter delivery records by a specific transaction UUID. Must be lowercase UUID v4 format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, pattern=400009"},"children":[]}]}]}],"example":"string"}],"pointer":"/paths/~1webhook~1deliveries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook~1deliveries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhook/deliveries","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[{"name":"webhook_id","in":"query","required":true,"example":"string","schemaId":"schema_142"},{"name":"transaction_uuid","in":"query","required":false,"example":"string","schemaId":"schema_143"}],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","500"],"pointer":"/webhook/deliveries","href":"webhook/paths/~1webhook~1deliveries/get","summary":"/webhook/deliveries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delivery history retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/default","paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/200_empty"]}},"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/default","paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/200_empty"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error (invalid transaction_uuid format)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1webhook~1deliveries/get/responses/400/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1webhook~1deliveries/get/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1deliveries/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1deliveries/get/responses/401/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1webhook~1deliveries/get/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1webhook~1deliveries/get/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1webhook~1deliveries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/default","paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/200_empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_200","exampleIds":["paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/default","paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/200_empty"]}}},{"code":"400","schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1webhook~1deliveries/get/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_400","exampleIds":["paths/~1webhook~1deliveries/get/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1deliveries/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1deliveries/get/responses/401/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1webhook~1deliveries/get/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_500","exampleIds":["paths/~1webhook~1deliveries/get/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/paths/~1webhook~1deliveries/get"}],"panels":[]}]},"httpPath":"/webhook/deliveries"},{"label":"/webhook/rotate-secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/webhook/paths/~1webhook~1rotate-secret/post","routeSlug":"/apis/outbound/webhook/paths/~1webhook~1rotate-secret/post","metadata":{"seo":{"title":"/webhook/rotate-secret","description":"Rotates the webhook signing secret for a specific webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/webhook/rotate-secret","isWebhook":false,"pointer":"/paths/~1webhook~1rotate-secret/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/webhook/rotate-secret","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rotates the webhook signing secret for a specific webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1rotate-secret/post/request/purpose","deepLinkHash":"/webhook/paths/~1webhook~1rotate-secret/post#webhook/paths/~1webhook~1rotate-secret/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows a partner to rotate their webhook_secret for security purposes. The old secret remains valid for a 24-hour grace period so the partner can update their verification logic without missing notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1rotate-secret/post/request/when-to-use","deepLinkHash":"/webhook/paths/~1webhook~1rotate-secret/post#webhook/paths/~1webhook~1rotate-secret/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to:"},"children":[]}]}]},{"$$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":"Rotate the signing secret if it may have been compromised"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Periodically rotate secrets as a security best practice"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-issue a secret if the partner lost the original"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1rotate-secret/post/request/what-happens-next","deepLinkHash":"/webhook/paths/~1webhook~1rotate-secret/post#webhook/paths/~1webhook~1rotate-secret/post/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new webhook_secret is generated (256-bit, 64-char hex)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current secret is moved to a grace period (24 hours)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both old and new secrets are valid during the grace period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After 24 hours, only the new secret is valid for outbound signatures"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1rotate-secret/post/request/authentication","deepLinkHash":"/webhook/paths/~1webhook~1rotate-secret/post#webhook/paths/~1webhook~1rotate-secret/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1rotate-secret/post/request/notes","deepLinkHash":"/webhook/paths/~1webhook~1rotate-secret/post#webhook/paths/~1webhook~1rotate-secret/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The old secret remains valid for signature verification for 24 hours after rotation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If rotated again during an active grace period (double rotation), the oldest secret is immediately invalidated"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The new secret is used for signing outbound payloads immediately"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 404 if no webhook registration exists for the partner"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1rotate-secret/post/request/common-errors","deepLinkHash":"/webhook/paths/~1webhook~1rotate-secret/post#webhook/paths/~1webhook~1rotate-secret/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No webhook configuration exists for this partner"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error during rotation"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook~1rotate-secret/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST","exampleIds":["paths/~1webhook~1rotate-secret/post/requestBody/content/application~1json/examples/rotate_secret"]}},"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST","exampleIds":["paths/~1webhook~1rotate-secret/post/requestBody/content/application~1json/examples/rotate_secret"],"pointer":"/paths/~1webhook~1rotate-secret/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhook/rotate-secret","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST","exampleIds":["paths/~1webhook~1rotate-secret/post/requestBody/content/application~1json/examples/rotate_secret"]}},"responseCodes":["200","401","404","500"],"pointer":"/webhook/rotate-secret","href":"webhook/paths/~1webhook~1rotate-secret/post","summary":"/webhook/rotate-secret"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST","exampleIds":["paths/~1webhook~1rotate-secret/post/requestBody/content/application~1json/examples/rotate_secret"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST","exampleIds":["paths/~1webhook~1rotate-secret/post/requestBody/content/application~1json/examples/rotate_secret"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Secret rotated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/200/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"No webhook registration found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1webhook~1rotate-secret/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1rotate-secret/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/paths/~1webhook~1rotate-secret/post"}],"panels":[]}]},"httpPath":"/webhook/rotate-secret"},{"label":"/webhook/test","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/outbound/webhook/paths/~1webhook~1test/post","routeSlug":"/apis/outbound/webhook/paths/~1webhook~1test/post","metadata":{"seo":{"title":"/webhook/test","description":"Sends a test webhook delivery to verify connectivity and signature verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/webhook/test","isWebhook":false,"pointer":"/paths/~1webhook~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/webhook/test","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a test webhook delivery to verify connectivity and signature verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1test/post/request/purpose","deepLinkHash":"/webhook/paths/~1webhook~1test/post#webhook/paths/~1webhook~1test/post/request/purpose"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows a partner to trigger a test delivery to their configured webhook endpoint. This verifies that the endpoint is reachable, responds within the timeout, and can process the webhook payload correctly."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1test/post/request/when-to-use","deepLinkHash":"/webhook/paths/~1webhook~1test/post#webhook/paths/~1webhook~1test/post/request/when-to-use"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to:"},"children":[]}]}]},{"$$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":"Verify initial webhook integration before going live"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test connectivity after changing the webhook URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debug delivery issues by triggering a controlled delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify signature verification logic is working correctly"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1test/post/request/what-happens-next","deepLinkHash":"/webhook/paths/~1webhook~1test/post#webhook/paths/~1webhook~1test/post/request/what-happens-next"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What happens next"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook configuration is validated (must be active with a signing secret)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A test event payload is constructed and signed with the current webhook_secret"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payload is delivered via HTTP POST to the configured webhook_url"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delivery result (status code, response time, any failure) is returned immediately"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1test/post/request/authentication","deepLinkHash":"/webhook/paths/~1webhook~1test/post#webhook/paths/~1webhook~1test/post/request/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-client-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-secret-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" headers."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1test/post/request/notes","deepLinkHash":"/webhook/paths/~1webhook~1test/post#webhook/paths/~1webhook~1test/post/request/notes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The test delivery uses event_type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook.test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which is not a real event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The test delivery is NOT logged in the delivery history"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook must be active and have a signing secret configured"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection timeout: 5 seconds, read timeout: 10 seconds"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the full delivery result synchronously (no retries for test deliveries)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"webhook/paths/~1webhook~1test/post/request/common-errors","deepLinkHash":"/webhook/paths/~1webhook~1test/post#webhook/paths/~1webhook~1test/post/request/common-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common errors"},"children":[]}]}]},{"$$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":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Webhook is inactive or missing signing secret"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Invalid credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Webhook not found for the given webhook_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Internal error during test delivery"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-client-id","in":"header","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier assigned to the integrating client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"},{"name":"x-secret-key","in":"header","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secret authentication key associated with the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"required":true,"example":"string"}],"pointer":"/paths/~1webhook~1test/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST","exampleIds":["paths/~1webhook~1test/post/requestBody/content/application~1json/examples/send_test"]}},"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST","exampleIds":["paths/~1webhook~1test/post/requestBody/content/application~1json/examples/send_test"],"pointer":"/paths/~1webhook~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhook/test","servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-client-id","in":"header","required":true,"example":"string","schemaId":"schema_89"},{"name":"x-secret-key","in":"header","required":true,"example":"string","schemaId":"schema_90"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST","exampleIds":["paths/~1webhook~1test/post/requestBody/content/application~1json/examples/send_test"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/webhook/test","href":"webhook/paths/~1webhook~1test/post","summary":"/webhook/test"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}],"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST","exampleIds":["paths/~1webhook~1test/post/requestBody/content/application~1json/examples/send_test"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST","exampleIds":["paths/~1webhook~1test/post/requestBody/content/application~1json/examples/send_test"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test delivery completed (check delivery_status for result)"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_success","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_failed","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_timeout"]}},"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_success","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_failed","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_timeout"]},{"code":"400","description":"Webhook is inactive or missing signing secret","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook~1test/post/responses/400/content/application~1json/examples/default","paths/~1webhook~1test/post/responses/400/content/application~1json/examples/400_no_secret"]}},"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook~1test/post/responses/400/content/application~1json/examples/default","paths/~1webhook~1test/post/responses/400/content/application~1json/examples/400_no_secret"]},{"code":"401","description":"Authentication error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1test/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1test/post/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1test/post/responses/404/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1test/post/responses/404/content/application~1json/examples/default"]},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1test/post/responses/500/content/application~1json/examples/default"]}},"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1test/post/responses/500/content/application~1json/examples/default"]}],"pointer":"/paths/~1webhook~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_success","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_failed","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_200","exampleIds":["paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_success","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_failed","paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_timeout"]}}},{"code":"400","schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook~1test/post/responses/400/content/application~1json/examples/default","paths/~1webhook~1test/post/responses/400/content/application~1json/examples/400_no_secret"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_400","exampleIds":["paths/~1webhook~1test/post/responses/400/content/application~1json/examples/default","paths/~1webhook~1test/post/responses/400/content/application~1json/examples/400_no_secret"]}}},{"code":"401","schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1test/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","exampleIds":["paths/~1webhook~1test/post/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1test/post/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_404","exampleIds":["paths/~1webhook~1test/post/responses/404/content/application~1json/examples/default"]}}},{"code":"500","schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1test/post/responses/500/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_500","exampleIds":["paths/~1webhook~1test/post/responses/500/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/paths/~1webhook~1test/post"}],"panels":[]}]},"httpPath":"/webhook/test"}],"content":{"contentType":"group","meta":{"name":"Webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints required to manage and operate the full lifecycle of resources within the ViaBlocks platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These endpoints are designed for secure, auditable, and scalable server-to-server integrations, and support core business operations and compliance workflows."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhook","summary":"/webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/paths/~1webhook/post","deprecated":false},{"title":"/webhook","summary":"/webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhook/paths/~1webhook/delete","deprecated":false},{"title":"/webhook","summary":"/webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/paths/~1webhook/get","deprecated":false},{"title":"/webhook","summary":"/webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhook/paths/~1webhook/put","deprecated":false},{"title":"/webhook/deliveries","summary":"/webhook/deliveries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhook/paths/~1webhook~1deliveries/get","deprecated":false},{"title":"/webhook/rotate-secret","summary":"/webhook/rotate-secret","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/paths/~1webhook~1rotate-secret/post","deprecated":false},{"title":"/webhook/test","summary":"/webhook/test","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/paths/~1webhook~1test/post","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ValidationRuleErrorCodes":{"id":"components/schemas/ValidationRuleErrorCodes","kind":"json-schema","title":"ValidationRuleErrorCodes","data":{"type":"object","description":"Standardized mapping of validation rule keywords to error codes.","additionalProperties":{"type":"integer"},"example":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"format":400005,"minimum":400006,"maximum":400007,"decimal":400008,"pattern":400009,"allowedValues":400010}}},"components/schemas/BENEFICIARY_REQUEST":{"id":"components/schemas/BENEFICIARY_REQUEST","kind":"json-schema","title":"BENEFICIARY_REQUEST","data":{"type":"object","properties":{"uuid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of the beneficiary to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":10,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's given name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's middle name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's primary family name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"secondLastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's second family name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's phone number without country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":10,"maxLength":15,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"phoneCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International dialing code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":4,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, format=400005"},"children":[]}]}]}],"minLength":5,"maxLength":60,"format":"email","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"format":400005}},"addressStreet":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressStreet2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Secondary address line."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City of residence."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country (ISO 3)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressZipCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZIP code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"relationShip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relationship between sender and beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1recipients~1relationships/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint RelationShips"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification document of the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the types of documents available according to the beneficiary's country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Identifications: GET /catalogs/countries/{deliveryCountryISO}/identifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document number of the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable description of the identification document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentExpirationDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the beneficiary's identification document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, format=400005"},"children":[]}]}]}],"minLength":8,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"format":400005}},"documentCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country that issued the beneficiary's identification document (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"required":["uuid"]}},"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_200":{"id":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"BENEFICIARY_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"message":{"type":"string","description":"Confirmation message."},"uuid":{"type":"string","description":"Unique identifier (UUID) of the created beneficiary."}},"description":"Beneficiary created successfully."}},"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_400":{"id":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"BENEFICIARY_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid JSON format in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A required field is missing (senderUuid, firstName, lastName, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field does not meet minimum length requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field exceeds maximum length."},"children":[]}]}]}]}]}]}]}]}]}},"description":"The request contains invalid or missing data."}},"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401":{"id":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"BENEFICIARY_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Authentication failed."}},"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_404":{"id":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_404","kind":"json-schema","title":"BENEFICIARY_REQUEST_post_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender not found. The senderUuid does not match any existing sender."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Sender not found."}},"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_422":{"id":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_422","kind":"json-schema","title":"BENEFICIARY_REQUEST_post_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"},"uuid":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422015"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A beneficiary with the same name already exists for this sender. The existing UUID is returned in the response."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Business rule violation."}},"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_500":{"id":"components/schemas/BENEFICIARY_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"BENEFICIARY_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal server error."}},"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_200":{"id":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"BENEFICIARY_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"message":{"type":"string","description":"Confirmation message."},"data":{"type":"object","description":"Beneficiary object with personal, contact, and address information."}},"description":"Beneficiary retrieved successfully."}},"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_400":{"id":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"BENEFICIARY_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uuid query parameter is required."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Missing required query parameter."}},"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_401":{"id":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"BENEFICIARY_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Authentication failed."}},"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_404":{"id":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"BENEFICIARY_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary not found, or does not belong to the specified sender."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Beneficiary not found or does not belong to the sender."}},"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_500":{"id":"components/schemas/BENEFICIARY_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"BENEFICIARY_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal error."}},"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_200":{"id":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_200","kind":"json-schema","title":"BENEFICIARY_REQUEST_put_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"uuid":{"type":"string","description":"UUID of the updated beneficiary."}},"description":"Beneficiary updated."}},"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_400":{"id":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_400","kind":"json-schema","title":"BENEFICIARY_REQUEST_put_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uuid is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field does not meet minimum length requirement."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field exceeds maximum length."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid email format."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Validation error."}},"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_401":{"id":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_401","kind":"json-schema","title":"BENEFICIARY_REQUEST_put_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Authentication failed."}},"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_500":{"id":"components/schemas/BENEFICIARY_REQUEST_put_RESPONSE_500","kind":"json-schema","title":"BENEFICIARY_REQUEST_put_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error or DynamoDB operation failed."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal error."}},"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of available bank account types.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the account type"},"type":{"type":"string","description":"Account type name (e.g. 'Checking', 'Savings')"}}}}},"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No account types found"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_ACCOUNT_TYPES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of available destination countries.","items":{"type":"object","properties":{"deliveryCountryISO":{"type":"string","description":"ISO 3166-1 alpha-3 country code (e.g., MEX, COL, GTM)"},"countryName":{"type":"string","description":"Country name in English"}}}}},"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials — x-client-id or x-secret-key are incorrect or missing."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner is not authorized to access this catalog endpoint."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected internal error. Retry the request."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal server error."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of available currencies for the specified country.","items":{"type":"object","properties":{"id":{"type":"number","description":"Internal currency identifier"},"name":{"type":"string","description":"Currency name (e.g. 'PESO MEXICANO', 'DOLAR AMERICANO')"},"code":{"type":"string","description":"ISO 4217 currency code (e.g. 'MXN', 'USD', 'COP')"}}}}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No currencies found for the given country"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_CURRENCIES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of available delivery methods for the specified country.","items":{"type":"object","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":"Delivery method code (e.g. 'C' = bank deposit, 'P' = cash pickup, 'E' = mobile wallet, 'H' = home delivery)"},"children":[]}]}]}]},"name":{"type":"string","description":"Delivery method display name (e.g. 'Deposit to Account', 'Cash Pick Up')"}}}}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No delivery methods found for the given country"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request status. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a 200 response."},"children":[]}]}]}]},"data":{"type":"array","description":"List of payer entries. Empty when no payers are available.","items":{"type":"object","properties":{"paymentLocationCode":{"type":"string","description":"Internal code identifying the payout location."},"paymentLocationName":{"type":"string","description":"Display name of the payout location."},"payerName":{"type":"string","description":"Name of the payer / paying institution."},"processedByCode":{"type":"string","description":"Code of the entity that processes the payout."},"whatToBring":{"type":"string","description":"What the beneficiary must present to collect the funds. Empty string when unset."},"businessHours":{"type":"string","description":"Business hours of the payout location. Empty string when unset."},"addressBranch":{"type":"string","description":"Address of the payout branch/location. Empty string when unset."},"currencyName":{"type":"string","description":"Human-readable name of the payout currency as returned by the pricing source."},"sortOrder":{"type":"number","description":"Ordering hint for presenting payers in a list."},"dolarLimit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dollar payout limit. Computed where a dollar limit is configured and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where none is. Semantics diverge by environment; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceLimit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the reliable ceiling."},"children":[]}]}]}]},"nationalLimit":{"type":"number","description":"Payout limit expressed in the destination local currency."},"sourceLimit":{"type":"number","description":"Effective payout ceiling for this payer. The reliable limit to enforce, consistent across environments."},"networkPayment":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the payer operates in-network (a single generic location) rather than through named physical branches. Boolean ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"rates":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange-rate tiers ordered ascending by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with consecutive equal rates merged keeping the higher ceiling. An empty array is a real payer with no published tier, not a zero rate."},"children":[]}]}]}],"items":{"type":"object","properties":{"maxAmount":{"type":"number","description":"Upper bound of the send amount for which this rate applies."},"rate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate applied up to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout locations (payers) with their rate tiers and limits for the specified country, delivery method, branch, and currency. An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array is a valid response (no payers for the corridor/currency, or the ATM gate blocked a USA delivery mode "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request)."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A required field is missing (branchId or deliveryAmountCurrencyISO)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field does not match the required pattern (e.g. deliveryCountryISO is not 3 uppercase letters)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value is not in the allowed list, or a supplied addressState/deliveryAmountCurrencyISO does not resolve."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The branchId does not belong to the authenticated partner's chain."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error - missing or invalid headers, path parameters, or query parameters (including an unresolved subdivision/currency or a branchId that does not belong to the partner's chain)."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authentication failed - invalid credentials"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authorization errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to this resource is forbidden for this client."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authorization failed - partner not allowed to access this resource"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error (unexpected exception)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database error while fetching payout pricing."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Internal server error, including a database error while fetching payout pricing."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status ('success')"},"data":{"type":"array","description":"Array of field rules for the specified payer.","items":{"type":"object","properties":{"mappedField":{"type":"string","description":"The exact field path in POST /transaction/create where this value must be sent (e.g., 'beneficiary.documentType'). If absent, send via additionalFields."},"required":{"type":"boolean","description":"Whether the field is mandatory for this payer"},"type":{"type":"string","description":"Schema-standard type: 'string' or 'number'"},"minLength":{"type":"integer","description":"Minimum character length"},"maxLength":{"type":"integer","description":"Maximum character length"},"pattern":{"type":"string","description":"Regular expression pattern for validation"},"allowedValues":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Predefined list of allowed values (array of {id, value} objects or null)"},"children":[]}]}]}],"items":{"type":"object"}},"description":{"type":"string","description":"Localized field label based on the language query parameter"},"errorMessage":{"type":"string","description":"Localized validation error message based on the language query parameter"},"order":{"type":"integer","description":"Display order for form rendering"},"isHidden":{"type":"boolean","description":"Whether the field should be hidden from the UI"},"defaultValue":{"type":"string","description":"Default/pre-filled value"}}}}},"description":"Object containing payer field rules. Each item in the data array represents a dynamic field rule with validation constraints, localized labels, and the mappedField path indicating where to send the value in POST /transaction/create."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Required field missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."},"details":{"type":"string","description":"Field name or additional context."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error ΓÇö missing or invalid parameters."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed ΓÇö invalid credentials."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authorization errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed ΓÇö resource not allowed for this partner."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not-found errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No payer rules found"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}}}},"description":"No payer rules found for the given parameters."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYERS_RULES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}}}},"description":"Internal server error."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of available payout networks for the specified country and delivery method.","items":{"type":"object","properties":{"deliveryLocationNetwork":{"type":"string","description":"Payout network code used in quote and transaction requests (e.g. 'ELEKTRA', 'BANCOPPEL')"},"deliveryLocationName":{"type":"string","description":"Display name of the payout network"},"deliveryCountryISO":{"type":"string","description":"Country ISO3 code for this payout network"},"nameCountry":{"type":"string","description":"Country name"},"deliveryLocationCode":{"type":"string","description":"Internal payer code (ProcessedByCode)"},"accNumberRegex":{"type":"string","description":"Regex pattern for validating account numbers (applicable for bank deposit delivery mode)"},"accTypeRequired":{"type":"boolean","description":"Whether an account type must be supplied for this payout network (typically bank deposit modes)"},"networkPayment":{"type":"boolean","description":"Whether the payout network operates in-network (a single generic location) rather than through named physical branches"},"accountDescription":{"type":"string","description":"Human-readable description of the account/identifier required by this payout network"},"accountLabel":{"type":"string","description":"Display label for the account/identifier field shown to the user"}}}}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error - missing or invalid required headers or path parameters"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authentication failed - invalid credentials"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authorization errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authorization failed - partner not allowed to access this resource"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not-found errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No payout networks found for the given country and delivery method"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"No payout networks found for the given country and delivery method combination"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Internal server error"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"List of payout locations for the specified network, country, and delivery mode.","items":{"type":"object","properties":{"deliveryLocationNetwork":{"type":"string","description":"Internal code of the payout location/branch."},"deliveryLocationName":{"type":"string","description":"Human-readable name of the payout location or institution."},"deliveryLocationCity":{"type":"string","description":"City where the payout location is situated."},"SubDivisionCode":{"type":"string","description":"ISO 3166-2 subdivision code for the state/department/province where the location resides (e.g., ANT for Antioquia, AMA for Amazonas)."},"SubDivisionName":{"type":"string","description":"Full name of the state, department, or province where the location resides."},"CountryName":{"type":"string","description":"Full country name (e.g., COLOMBIA, MEXICO)."},"CountryCodeISO2":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g., CO, MX)."},"CountryCodeISO3":{"type":"string","description":"ISO 3166-1 alpha-3 country code (e.g., COL, MEX)."},"AddressBranch":{"type":"string","description":"Physical address of the payout branch or agent location."},"WhatToBring":{"type":"string","description":"Instructions for the beneficiary about what documents or information to bring when collecting the funds. May be null if not specified."},"BusinessHours":{"type":"string","description":"Operating hours of the payout location (e.g., 'L-D:9:00AM-5:00PM', 'L-J 8:00AM-4:30PM;V:8:00AM-5:00PM')."}}}}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid path parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail validations"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail authentication"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of error objects"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No locations found for the given country, delivery method, or payout network"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"No locations found for the given combination of country, delivery method, and payout network"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error or upstream catalog service unavailable."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail - Internal Error"}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of accepted identification document types for the specified country.","items":{"type":"object","properties":{"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document type code (e.g. 'PP' = Passport, 'DL' = Driver's License, 'NI' = National ID)"},"children":[]}]}]}]},"documentDescription":{"type":"string","description":"Human-readable description of the document type (e.g. 'Passport', 'Driver License')"},"expirationDateRequired":{"type":"boolean","description":"Whether the document expiration date is required during capture"},"backSideRequired":{"type":"boolean","description":"Whether the back side of the document must be captured"}}}}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No identification types found for the given country"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_IDENTIFICATIONS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of states/provinces for the specified country with ISO 3166-2 codes.","items":{"type":"object","properties":{"addressState":{"type":"string","description":"ISO 3166-2 state/province code (e.g., MX-JAL, US-CA, CO-ANT)"},"stateName":{"type":"string","description":"State/province name"}}}}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request — malformed path parameter or query string."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameter does not match required pattern (regex)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameter value is not in the list of allowed values."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — invalid path parameter format or value."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials — x-client-id or x-secret-key are incorrect or missing."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner is not authorized to access this catalog endpoint."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No states/provinces found for the specified country ISO code."},"children":[]}]}]}]}]}]}]}]}]}},"description":"No states found for the given country."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected internal error. Retry the request."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal server error."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of cities for the specified state.","items":{"type":"object","properties":{"cityId":{"type":"string","description":"Internal city identifier"},"cityName":{"type":"string","description":"City name"}}}}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request — malformed path parameter or query string."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameter does not match required pattern (regex)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameter value is not in the list of allowed values."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — invalid path parameter format or value."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials — x-client-id or x-secret-key are incorrect or missing."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid or missing credentials."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner is not authorized to access this catalog endpoint."},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}]}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No cities found for the specified state ISO code."},"children":[]}]}]}]}]}]}]}]}]}},"description":"No cities found for the given state."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_STATES_{ADDRESSSTATE}_CITIES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"integer"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unexpected internal error. Retry the request."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal server error."}},"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of funds origin options with their descriptions.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the funds origin option"},"fundsOrigin":{"type":"string","description":"Description of the funds source (e.g. 'EMPLOYMENT INCOME', 'SAVINGS')"},"order":{"type":"integer","description":"Display order for sorting"}}}}},"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No funds origin options found"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_FUNDS_ORIGIN_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST":{"id":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST","kind":"json-schema","title":"CATALOGS_GOOGLE_MAPS_API_REQUEST","data":{"type":"object","properties":{"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address to geocode or autocomplete"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":200,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"event":{"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 operation: geocode for full address details, autocomplete for address suggestions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, allowedValues=400010"},"children":[]}]}]}],"enum":["geocode","autocomplete"],"x-viablocks-error-codes":{"required":400001,"type":400002,"allowedValues":400010}},"countries":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of country codes to restrict search (ISO 2 letter codes, e.g., ['us', 'mx'])"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"items":{"type":"object"},"x-viablocks-error-codes":{"type":400002}}},"required":["address","event"]}},"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_200":{"id":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"predictions":{"type":"array","description":"Address suggestions (autocomplete event only)","items":{"type":"object","properties":{"description":{"type":"string","description":"Full suggested address text"},"place_id":{"type":"string","description":"Google Maps place identifier"}}}},"results":{"type":"array","description":"Geocoded address results (geocode event only)","items":{"type":"object","properties":{"formatted_address":{"type":"string","description":"Full formatted address"},"address_components":{"type":"array","description":"Structured address components (street, city, state, zip, country)","items":{"type":"object"}}}}}},"description":"Successful response. Structure varies by event type (autocomplete returns suggestions array, geocode returns structured address components)."}},"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_400":{"id":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"event must be one of: geocode, autocomplete"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_401":{"id":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_500":{"id":"components/schemas/CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"CATALOGS_GOOGLE_MAPS_API_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of industry categories, each containing a nested array of job titles/occupations.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the industry category"},"industry":{"type":"string","description":"Industry name or category (e.g. 'AGRICULTURE/FARMING', 'CONSTRUCTION')"},"order":{"type":"integer","description":"Display order for sorting"},"jobs":{"type":"array","description":"List of job titles within this industry","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the job title"},"name":{"type":"string","description":"Job title or occupation name (e.g. 'FARMER', 'ASSISTANT')"}}}}}}}},"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No industries found"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_INDUSTRY_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_COUNTRIES_{DELIVERYCOUNTRYISO}_DELIVER_METHODS_{DELIVERYMODE}_PAYOUTS_{DELIVERYLOCATIONNETWORK}_LOCATIONS_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to this resource is forbidden for this client."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail authorization - partner not authorized for this endpoint"}},"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of locations matching the filter value.","items":{"type":"object","properties":{"deliveryCountryISO":{"type":"string","description":"Country ISO3 code"},"stateName":{"type":"string","description":"Full state/province name"},"addressState":{"type":"string","description":"State/province ISO 3166-2 code (e.g., MX-JAL, US-FL)"},"addressCity":{"type":"string","description":"City name"},"addressZipCode":{"type":"string","description":"Postal/ZIP code"}}}}},"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filterValue is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No matches found"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_MASTER_LOCATION_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of locations matching the ZIP code. Each item contains city name, state abbreviation, and full state name.","items":{"type":"object","properties":{"cityName":{"type":"string","description":"City or locality name associated with the ZIP code"},"addressState":{"type":"string","description":"State ISO 3166-2 code with country prefix (e.g. 'US-FL', 'US-NY', 'US-CA')"},"stateName":{"type":"string","description":"Full state name (e.g. 'Florida', 'New York', 'California')"}}}}},"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No location data found for the given ZIP code"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_MASTER_ZIPCODES_{ADDRESSZIPCODE}_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of relationship types with multilingual translations.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the relationship type (e.g. 'AUNT', 'SPOUSE', 'FRIEND')"},"translations":{"type":"object","description":"Relationship name translations","properties":{"en":{"type":"string","properties":{},"description":"Relationship name in English"},"es":{"type":"string","properties":{},"description":"Relationship name in Spanish"}}}}}}},"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No relationship types found"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_RECIPIENTS_RELATIONSHIPS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_200","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of available cancellation reasons. Each item contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that should be used as-is in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /transaction/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request body."},"children":[]}]}]}],"items":{"type":"object","properties":{"reasonId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the cancellation reason. Use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in DELETE /transaction/cancel."},"children":[]}]}]}]},"reasonName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the cancellation reason. Use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasonName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in DELETE /transaction/cancel."},"children":[]}]}]}]}}}}},"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_403":{"id":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authorization errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authorization error response."}},"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No cancellation reasons found"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_TRANSACTION_CANCEL_REASONS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_200":{"id":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_200","data":{"type":"array","description":"Array of remittance purpose codes with their descriptions.","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier code for the remittance purpose (e.g. 'F', 'E', 'B')"},"remittancePurpose":{"type":"string","description":"Description of the wire transfer purpose (e.g. 'FAMILY SUPPORT', 'EDUCATION')"}}}}},"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_400":{"id":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request format"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-client-id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"x-secret-key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error response."}},"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_401":{"id":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error response."}},"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_404":{"id":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No remittance purposes found"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Not found error response."}},"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_500":{"id":"components/schemas/CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"CATALOGS_WIRE_PURPOSE_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error response."}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status indicator."},"data":{"type":"array","description":"Array of payer objects with rates and limits for the requested country.","items":{"type":"object","properties":{"deliveryLocationName":{"type":"string","description":"Name of the payer/network (e.g., Elektra, Bancolombia, Banrural)."},"deliveryModeName":{"type":"string","description":"Human-readable name of the delivery mode (e.g., CASH PICKUP, BANK DEPOSIT)."},"deliveryAmountCurrencyName":{"type":"string","description":"Name of the delivery currency (e.g., Peso Mexicano, Colombian Peso)."},"exchangeRate":{"type":"number","description":"Exchange rate offered by this payer."},"originationAmountFrom":{"type":"number","description":"Minimum origination amount (USD) accepted for this payer."},"originationAmountTo":{"type":"number","description":"Maximum origination amount (USD) accepted for this payer."},"fundingType":{"type":"string","description":"Funding type applicable (e.g., CASH, ACH, CARD)."},"sort":{"type":"integer","description":"Sort order priority for display purposes."},"dolarAmountLimit":{"type":"number","description":"Maximum dollar amount limit for this payer."}}}}},"description":"Payer rates and limits returned successfully."}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"branchId is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"deliveryCountryISO is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The branchId is not valid for this partner"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."},"details":{"type":"string","description":"Field name or additional context."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — missing or invalid required headers or parameters."},"children":[]}]}]}]}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid client credentials."},"children":[]}]}]}]}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authorization errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."},"details":{"type":"string","description":"Additional context."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}]}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_422","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of business rule errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing data could not be retrieved"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business rule error — pricing data not available."},"children":[]}]}]}]}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of internal errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error or partner configuration error"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":"Internal server error."}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_502","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_502","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of upstream errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 502 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unable to authenticate with pricing service"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":"Authentication with upstream pricing service failed."}},"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503":{"id":"components/schemas/PRICING_PAYERS_REQUEST_get_RESPONSE_503","kind":"json-schema","title":"PRICING_PAYERS_REQUEST_get_RESPONSE_503","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of service availability errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 503 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"503001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing service temporarily unavailable"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":"Pricing service temporarily unavailable."}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status indicator."},"data":{"type":"array","description":"Array of top country objects sorted by best exchange rate.","items":{"type":"object","properties":{"deliveryCountryISO":{"type":"string","description":"ISO 3166-1 alpha-3 country code of the destination (e.g., MEX, COL, GTM)."},"countryName":{"type":"string","description":"Human-readable name of the destination country."},"deliveryLocationName":{"type":"string","description":"Name of the payer/network offering the best rate for this country."},"deliveryMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode code (e.g., P = Cash Pickup, T = Bank Deposit)."},"children":[]}]}]}]},"exchangeRate":{"type":"number","description":"Best available exchange rate for this country."},"deliveryAmountCurrencyISO":{"type":"string","description":"ISO 4217 currency code of the delivery amount (e.g., MXN, COP)."}}}}},"description":"Top countries with best exchange rates returned successfully."}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_400":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"branchId is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"x-secret-key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The branchId is not valid for this partner"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."},"details":{"type":"string","description":"Field name or additional context."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — missing or invalid required headers or parameters."},"children":[]}]}]}]}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed — invalid client credentials."},"children":[]}]}]}]}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_403":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_403","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authorization errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Access to this resource is forbidden for this client"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."},"details":{"type":"string","description":"Additional context."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization failed — partner not allowed to access this resource."},"children":[]}]}]}]}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_422":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_422","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of business rule errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"422006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing data could not be retrieved"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business rule error — pricing data not available."},"children":[]}]}]}]}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of internal errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal server error or partner configuration error"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":"Internal server error."}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_502":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_502","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_502","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of upstream errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 502 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unable to authenticate with pricing service"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":"Authentication with upstream pricing service failed."}},"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_503":{"id":"components/schemas/PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_503","kind":"json-schema","title":"PRICING_TOP_COUNTRIES_REQUEST_get_RESPONSE_503","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of service availability errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error catalog for 503 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"503001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Pricing service temporarily unavailable"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Always 'failed'."},"code":{"type":"integer","description":"Internal error code."},"message":{"type":"string","description":"Human-readable error description."}}}}},"description":"Pricing service temporarily unavailable."}},"components/schemas/SENDER_ID_UPLOAD_REQUEST":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST","data":{"type":"object","properties":{"uuid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's unique identifier (idSenderGlobal). This is the same UUID returned when the sender was created via transaction/create. The sender is validated against the Customer table before processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":32,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document type code (e.g., DL, PA, CL). Must be a document type accepted for the given documentCountry according to the KYC identifications catalog. Determines whether the back image is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":1,"maxLength":4,"pattern":"^[A-Za-z]{1,4}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"documentCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document country in ISO 3166-1 alpha-3 format (e.g., USA, MEX, COL). Used together with documentType to validate the document and resolve image requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":3,"maxLength":3,"pattern":"^[A-Za-z]{3}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"documentNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's identification document number (e.g., driver's license, passport, national ID). Must match the documentNumber used in transaction/create."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":1,"maxLength":30,"pattern":"^[A-Za-z0-9\\-]+$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"frontImage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Front image of the identification document encoded in base64. Accepts raw base64 or data URI (data:image/png;base64,...)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, pattern=400009"},"children":[]}]}]}],"minLength":100,"pattern":"^(?:data:image\\/[a-zA-Z+]+;base64,)?[A-Za-z0-9+/]+=*$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"pattern":400009}},"backImage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back image of the identification document encoded in base64. Optional — required only for document types that need back side capture (e.g., driver's license). Accepts raw base64 or data URI (data:image/png;base64,...)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, pattern=400009"},"children":[]}]}]}],"minLength":100,"pattern":"^(?:data:image\\/[a-zA-Z+]+;base64,)?[A-Za-z0-9+/]+=*$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"pattern":400009}}},"required":["uuid","documentType","documentCountry","documentNumber","frontImage"]}},"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_200":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Request status (success)"},"message":{"type":"string","description":"Descriptive message about the operation result"}},"description":"ID document uploaded successfully."}},"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_400":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid JSON format or image upload failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required field is missing (uuid, documentType, documentCountry, documentNumber, frontImage, or backImage when required by the document type/country)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentType is not accepted for the given documentCountry."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error - missing or invalid required fields, or image upload failed"}},"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_401":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication failed - invalid credentials"}},"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_403":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_403","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to this resource is forbidden for this client."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authorization failed - partner not allowed to access this resource"}},"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_404":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_404","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender not found for the given UUID."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Sender not found for the given UUID"}},"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_422":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_422","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422007"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender does not have required associated data."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Business rule error - sender does not have required data"}},"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_500":{"id":"components/schemas/SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"SENDER_ID_UPLOAD_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error retrieving sender data from DynamoDB."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error invoking document processing Lambda."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error retrieving the KYC identifications catalog."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error"}},"components/schemas/SENDER_REQUEST_get_RESPONSE_200":{"id":"components/schemas/SENDER_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"SENDER_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"message":{"type":"string","description":"Descriptive message about the operation result."},"data":{"type":"object","description":"Sender profile.","properties":{"uuid":{"type":"string","properties":{},"description":"Sender global UUID (alphanumeric)."},"idSenderGlobal":{"type":"number","properties":{},"description":"Numeric global sender identifier."},"idSender":{"type":"number","properties":{},"description":"Numeric branch-scoped sender identifier."},"firstName":{"type":"string","properties":{},"description":"Sender's first name."},"middleName":{"type":"string","properties":{},"description":"Sender's middle name."},"lastName":{"type":"string","properties":{},"description":"Sender's last name."},"secondLastName":{"type":"string","properties":{},"description":"Sender's second last name."},"phone":{"type":"string","properties":{},"description":"Sender's phone number without country code."},"phoneCountryCode":{"type":"string","properties":{},"description":"International dialing code of the sender's phone."},"email":{"type":"string","properties":{},"description":"Sender's email address."},"dateOfBirth":{"type":"string","properties":{},"description":"Sender's date of birth."},"addressStreet":{"type":"string","properties":{},"description":"Sender's street address."},"addressCity":{"type":"string","properties":{},"description":"Sender's city."},"addressState":{"type":"string","properties":{},"description":"Sender's state (ISO 2)."},"addressCountry":{"type":"string","properties":{},"description":"Sender's country (ISO 3166-1 alpha-3)."},"addressZipCode":{"type":"string","properties":{},"description":"Sender's ZIP code."},"documentType":{"type":"string","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document type code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Catalogs Endpoint Identifications: GET /catalogs/countries/{deliveryCountryISO}/identifications"},"children":[]}]}]}]},"documentDescription":{"type":"string","properties":{},"description":"Human-readable identification document description."},"documentNumber":{"type":"string","properties":{},"description":"Identification document number."},"documentExpirationDate":{"type":"string","properties":{},"description":"Identification document expiration date (format: YYYY-MM-DD)."},"documentState":{"type":"string","properties":{},"description":"State that issued the identification document (ISO 3166-2)."},"documentCountry":{"type":"string","properties":{},"description":"Country that issued the identification document (ISO 3166-1 alpha-3)."},"occupation":{"type":"string","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's occupation. Refers to the job name from the selected industry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]}]},"employer":{"type":"string","properties":{},"description":"Sender's employer name."},"employerPhone":{"type":"string","properties":{},"description":"Sender's employer phone number."},"proofOfIncome":{"type":"string","properties":{},"description":"Sender's source of income or supporting documentation."},"ssnNumber":{"type":"string","properties":{},"description":"Sender's Social Security Number (U.S.). 9-digit number."},"industry":{"type":"number","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industry classification identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]}]},"job":{"type":"number","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job/occupation identifier within the selected industry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]}]},"nationality":{"type":"string","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's nationality country (ISO 3166-1 alpha-3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]}]},"currentBranch":{"type":"string","properties":{},"description":"Branch associated with the sender."},"identityDocuments":{"type":"array","description":"List of identity documents uploaded and associated with the sender. Each item contains document metadata, image references, and review status.","items":{"type":"object","properties":{"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document type code (e.g., DL, CC, PP)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Catalogs Endpoint Identifications: GET /catalogs/countries/{deliveryCountryISO}/identifications"},"children":[]}]}]}]},"documentTypeName":{"type":"string","description":"Human-readable name of the identification document type (e.g., DRIVER'S LICENSE, CEDULA CIUDADANIA)."},"documentNumber":{"type":"string","description":"Identification document number."},"documentState":{"type":"string","description":"State or province that issued the document (ISO 3166-2). Empty string if not applicable."},"documentCountry":{"type":"string","description":"Country that issued the document (ISO 3166-1 alpha-3)."},"expirationDate":{"type":"string","description":"Document expiration date (format: YYYY-MM-DD HH:MM:SS). Value '1900-01-01 00:00:00' indicates no expiration set."},"dateInserted":{"type":"string","description":"Timestamp when the document was uploaded/registered (format: YYYY-MM-DD HH:MM:SS)."},"frontImageName":{"type":"string","description":"Filename of the front-side document image stored in S3."},"frontImagePath":{"type":"string","description":"Full S3 URL to the front-side document image."},"backImageName":{"type":"string","description":"Filename of the back-side document image stored in S3. May be empty if back image was not uploaded."},"backImagePath":{"type":"string","description":"Full S3 URL to the back-side document image. May be empty if back image was not uploaded."},"reviewStatus":{"type":"string","description":"Human-readable review status of the document (e.g., NOT REVIEWED, APPROVED, REJECTED)."},"reviewStatusId":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Numeric identifier of the review status (0 = NOT REVIEWED, 1 = APPROVED, 2 = REJECTED)."},"children":[]}]}]}]},"rejectionCode":{"type":["string","null"],"description":"Code indicating the reason for rejection. Null if not rejected."},"rejectionReason":{"type":"string","description":"Descriptive reason for document rejection. Empty string if not rejected."}}}}}}},"description":"Sender found successfully."}},"components/schemas/SENDER_REQUEST_get_RESPONSE_400":{"id":"components/schemas/SENDER_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"SENDER_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uuid query parameter is required."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Missing or invalid query parameter."}},"components/schemas/SENDER_REQUEST_get_RESPONSE_401":{"id":"components/schemas/SENDER_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"SENDER_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials. Verify your x-client-id and x-secret-key."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication failed."}},"components/schemas/SENDER_REQUEST_get_RESPONSE_404":{"id":"components/schemas/SENDER_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"SENDER_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not-found errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender not found for the provided uuid."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Sender not found."}},"components/schemas/SENDER_REQUEST_get_RESPONSE_500":{"id":"components/schemas/SENDER_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"SENDER_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of internal errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred. Please try again later."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error."}},"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_200":{"id":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"SENDER_SEARCH_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"count":{"type":"number","description":"Number of senders found matching the search criteria."},"data":{"type":"array","description":"List of sender objects matching the search criteria.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier (UUID) of the sender."},"firstName":{"type":"string","description":"Sender's first name."},"middleName":{"type":"string","description":"Sender's middle name."},"lastName":{"type":"string","description":"Sender's last name."},"secondLastName":{"type":"string","description":"Sender's second last name."},"fullName":{"type":"string","description":"Sender's full name."},"phone":{"type":"string","description":"Sender's phone number."},"addressStreet":{"type":"string","description":"Sender's street address."},"addressCountry":{"type":"string","description":"Sender's country (ISO 3166-1 alpha-3)."},"currentBranch":{"type":"string","description":"Branch associated with the sender."},"chainId":{"type":"string","description":"Partner chain ID."}}}}},"description":"Search completed successfully."}},"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_400":{"id":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"SENDER_SEARCH_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filterValue query parameter is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filterValue must have a minimum length of 2 characters."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Missing or invalid query parameter."}},"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_401":{"id":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"SENDER_SEARCH_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials. Verify your x-client-id and x-secret-key."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication failed."}},"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_500":{"id":"components/schemas/SENDER_SEARCH_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"SENDER_SEARCH_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of internal errors."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred. Please try again later."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error."}},"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST":{"id":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST","kind":"json-schema","title":"SERVICE_ACCOUNT_VERIFY_REQUEST","data":{"type":"object","properties":{"accountNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bank account number to verify."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":4,"maxLength":17,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 9-digit ABA routing number of the financial institution."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":9,"maxLength":9,"pattern":"^[0-9]{9}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"accountType":{"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 bank account. C = Checking, S = Savings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["C","S"],"minLength":1,"maxLength":1,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}}},"required":["accountNumber","routingNumber","accountType"]}},"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_200":{"id":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status indicator."},"message":{"type":"string","description":"Human-readable description of the result."},"data":{"type":"object","description":"Account verification result data.","properties":{"verificationValue":{"type":"string","properties":{},"description":"Human-readable name of the verification result (e.g., Pass, Declined, NoData)."},"verificationRisk":{"type":"string","properties":{},"description":"Risk level associated with the verification result: LOW, MEDIUM, or HIGH."},"verificationDescription":{"type":"string","properties":{},"description":"Detailed explanation of the verification result and suggested action."},"bankName":{"type":"string","properties":{},"description":"Name of the financial institution associated with the routing number."}}}},"description":"Account verified successfully"}},"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_400":{"id":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required field is missing (accountNumber, routingNumber, or accountType)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing number failed ABA checksum validation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type value is not in the allowed list."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error - missing or invalid fields"}},"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_401":{"id":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid API key."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication failed"}},"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_500":{"id":"components/schemas/SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"SERVICE_ACCOUNT_VERIFY_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account verification service unavailable."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Verification service unavailable or internal error"}},"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST":{"id":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST","kind":"json-schema","title":"SERVICE_ROUTING_VERIFY_REQUEST","data":{"type":"object","properties":{"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 9-digit ABA routing number to verify."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":9,"maxLength":9,"pattern":"^[0-9]{9}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"countryISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-3 country code (e.g., USA, CAN)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"accountNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank account number to verify alongside the routing number. When provided, accountType is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":4,"maxLength":17,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"accountType":{"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 bank account. Required when accountNumber is provided. C = Checking, S = Savings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["C","S"],"minLength":1,"maxLength":1,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}}},"required":["routingNumber","countryISO"]}},"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_200":{"id":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status indicator."},"message":{"type":"string","description":"Human-readable description of the result."},"data":{"type":"object","description":"Routing verification result data.","properties":{"routingNumber":{"type":"string","properties":{},"description":"The verified 9-digit routing number."},"bank":{"type":"string","properties":{},"description":"Official name of the financial institution."},"rtp":{"type":"boolean","properties":{},"description":"Whether the bank supports RTP (Real-Time Payments)."},"fednow":{"type":"boolean","properties":{},"description":"Whether the bank supports FedNow instant payments."},"aba":{"type":"boolean","properties":{},"description":"Whether the routing number is valid in the ABA system."},"wire":{"type":"boolean","properties":{},"description":"Whether the routing number supports wire transfers."},"ach":{"type":"boolean","properties":{},"description":"Whether the routing number supports ACH transactions."},"active":{"type":"boolean","properties":{},"description":"Whether the routing number is currently active."},"accountVerification":{"type":"object","properties":{"verificationValue":{"type":"string","description":"Human-readable verification result name (e.g., Pass, Declined, NoData)."},"verificationRisk":{"type":"string","description":"Risk level: LOW, MEDIUM, or HIGH."},"verificationDescription":{"type":"string","description":"Detailed explanation of the verification result."},"bankName":{"type":"string","description":"Bank name from the verification provider."}},"description":"Account verification result (only present when accountNumber was provided)."}}}},"description":"Routing number verified successfully"}},"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_400":{"id":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required field is missing or accountType missing when accountNumber provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing number failed ABA checksum validation."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account type value is not in the allowed list."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Validation error"}},"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_401":{"id":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid API key."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Authentication failed"}},"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_404":{"id":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_404","kind":"json-schema","title":"SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing number not found in database or external providers."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Routing number not found"}},"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_500":{"id":"components/schemas/SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"SERVICE_ROUTING_VERIFY_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account verification service unavailable."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal server error or external service unavailable"}},"components/schemas/TRANSACTION_CANCEL_REQUEST":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST","data":{"type":"object","properties":{"uuid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the transaction to cancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":32,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"transactionContext":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction context. The branchId is derived internally from DynamoDB; cashierId identifies who requested the cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"properties":{"branchId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch ID. Optional: the endpoint always derives the branch from the stored transaction, so it is not needed to identify it. When you do send it, it must match the branch that owns the transaction, otherwise the request is rejected with 400417. The comparison ignores case and padding."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":1,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"cashierId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashier or user requesting the cancellation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, maxLength=400004"},"children":[]}]}]}],"maxLength":40,"x-viablocks-error-codes":{"required":400001,"type":400002,"maxLength":400004}}},"required":["cashierId"],"x-viablocks-error-codes":{"required":400001,"type":400002}},"reasonName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancellation reason text. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the available cancellation reasons in our catalogs API "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Cancel Reasons"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, maxLength=400004"},"children":[]}]}]}],"maxLength":255,"x-viablocks-error-codes":{"type":400002,"maxLength":400004}},"reasonId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancellation reason ID. "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the available cancellation reasons in our catalogs API "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1transaction~1cancel-reasons/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Cancel Reasons"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, maxLength=400004"},"children":[]}]}]}],"maxLength":10,"x-viablocks-error-codes":{"type":400002,"maxLength":400004}},"reasonNotes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional notes or comments about the cancellation reason"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, maxLength=400004"},"children":[]}]}]}],"maxLength":500,"x-viablocks-error-codes":{"type":400002,"maxLength":400004}}},"required":["uuid","transactionContext"]}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_200":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_200","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Request status (always 'success')"},"cancelFlow":{"type":"string","description":"Cancellation flow used: 'void', 'cancelation-request', or 'orchestrator'"},"message":{"type":"string","description":"Descriptive message about the operation result"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction cancelled successfully. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancelFlow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates which cancellation path was used."},"children":[]}]}]}]}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_400":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_400","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of errors returned for HTTP 400"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the request is required, or the JSON format is invalid. Also returned when the x-client-id or x-secret-key header is missing, and when the branch of the transaction does not belong to the authenticated partner (details contains the offending branchId)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field is required. Applies to uuid, transactionContext and transactionContext.cashierId. transactionContext.branchId is optional: the endpoint derives the branch from the stored transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field must be of the correct type: string for uuid, reasonName, reasonId, reasonNotes and the transactionContext members; object for transactionContext."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field does not meet the minimum length. Only uuid can trigger it (minimum 32 characters)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field exceeds the maximum length: uuid (60), transactionContext.branchId (10), transactionContext.cashierId (40), reasonName (255), reasonId (10) or reasonNotes (500)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400417"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transactionContext.branchId sent in the request does not match the branch that owns the transaction. Only raised when the caller sends that field, since it is optional; the comparison ignores case and padding."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ViaOne service rejected the cancellation with HTTP 400. The HTTP status is propagated as 400 but the payload keeps code 502001."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Numeric error code identifying the specific failure: 400000 (missing authentication header, missing/invalid body, or branch not belonging to the partner), 400001 (required field), 400002 (wrong type), 400003 (below minimum length), 400004 (above maximum length), 400417 (branch without permission to cancel), 502001 (rejected by ViaOne with HTTP 400)"},"message":{"type":"string","description":"Human-readable message describing the failure"},"details":{"type":"string","description":"Additional context about the failure: the name of the field that failed validation, or the offending field/value when the rejection is branch related"}}}}},"description":"Validation error, malformed JSON body, or transaction belonging to another partner. Also returned when ViaOne rejects the cancellation with HTTP 400 (payload keeps code 502001)."}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_401":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_401","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of errors returned for HTTP 401"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials (x-client-id / x-secret-key). Also returned when authentication against the ViaOne service fails."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Authentication error code (401000)"},"message":{"type":"string","description":"Human-readable message describing the failure"},"details":{"type":"string","description":"Additional context about the failure: the name of the field that failed validation, or the offending field/value when the rejection is branch related"}}}}},"description":"Authentication error - invalid credentials or ViaOne authentication failure"}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_403":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_403","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_403","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of errors returned for HTTP 403"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 403 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to this resource is forbidden for this client: the partner does not have transaction/cancel in its allowed resources."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Authorization error code (403001)"},"message":{"type":"string","description":"Human-readable message describing the failure"},"details":{"type":"string","description":"Additional context about the failure: the name of the field that failed validation, or the offending field/value when the rejection is branch related"}}}}},"description":"Authorization error - the partner is not allowed to access this resource"}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_404":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_404","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of errors returned for HTTP 404"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not found in SQL Server (the status query returned no rows)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not found in DynamoDB for the given uuid."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ViaOne service responded HTTP 404. The HTTP status is propagated as 404 but the payload keeps code 502001."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Not found error code: 404000 (not found in SQL Server), 404001 (not found in DynamoDB), 502001 (ViaOne responded HTTP 404)"},"message":{"type":"string","description":"Human-readable message describing the failure"},"details":{"type":"string","description":"Additional context about the failure: the name of the field that failed validation, or the offending field/value when the rejection is branch related"}}}}},"description":"Transaction not found in DynamoDB or SQL Server. Also returned when ViaOne responds HTTP 404 (payload keeps code 502001)."}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_422":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_422","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of errors returned for HTTP 422"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction cannot be cancelled because of its current status. Outbound: CANCEL, PAID or VOID. Inbound: CANCEL, PAID, VOID or RETURNED. The message includes the current status."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction already has a pending cancellation request (has_cancellation_req = 1); it cannot be requested twice."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound only: the transaction can be cancelled only while id_flag_receiver is I (in process) or H (on hold). The message includes the current flag."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ViaOne service rejected the cancellation with HTTP 422. The HTTP status is propagated as 422 but the payload keeps code 502001."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Business rule error code: 422001 (non-cancellable status), 422002 (cancellation request already pending), 422003 (inbound receiver flag is not I or H), 502001 (rejected by ViaOne with HTTP 422)"},"message":{"type":"string","description":"Human-readable message describing the failure"},"details":{"type":"string","description":"Additional context about the failure: the name of the field that failed validation, or the offending field/value when the rejection is branch related"}}}}},"description":"Business rule rejection - terminal status, duplicate cancellation request, or inbound receiver flag not cancellable. Also returned when ViaOne responds HTTP 422 (payload keeps code 502001)."}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_502":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_502","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_502","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of errors returned for HTTP 502"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 502 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"502001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External API error during cancellation: the ViaOne service or the PayerProxy orchestrator failed or returned an unexpected status."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"External service error code (502001)"},"message":{"type":"string","description":"Human-readable message describing the failure"},"details":{"type":"string","description":"Additional context about the failure: the name of the field that failed validation, or the offending field/value when the rejection is branch related"}}}}},"description":"External service error - ViaOne or PayerProxy orchestrator failure"}},"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_500":{"id":"components/schemas/TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_500","kind":"json-schema","title":"TRANSACTION_CANCEL_REQUEST_delete_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of errors returned for HTTP 500"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error (unhandled exception)."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Server error code (500000)"},"message":{"type":"string","description":"Human-readable message describing the failure"},"details":{"type":"string","description":"Additional context about the failure: the name of the field that failed validation, or the offending field/value when the rejection is branch related"}}}}},"description":"Internal server error"}},"components/schemas/TRANSACTION_CONFIRM_REQUEST":{"id":"components/schemas/TRANSACTION_CONFIRM_REQUEST","kind":"json-schema","title":"TRANSACTION_CONFIRM_REQUEST","data":{"type":"object","properties":{"uuid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":32,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"transactionContext":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Context of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"branchId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"cashierId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashier ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":4,"maxLength":20,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}},"receiptFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output format for the receipt generated after confirmation. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["html","pdf"],"minLength":3,"maxLength":4,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"transactionInformation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the financial, operational, and processing configuration of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains all parameters required to calculate, validate, route, and execute the transfer, including amounts, currencies, delivery method, funding source, fees, and payout instructions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields are validated against business rules, compliance policies, and operational constraints before the transaction is accepted for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"funding":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the source of funds and funding method used to initiate the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the payment instrument and funding configuration (e.g., cash, debit card, bank account, wallet), and is used to validate, authorize, and register the financial charge before the transaction is processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"last4CardNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last 4 digits of the card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":4,"maxLength":4,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"approvalCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approval code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":4,"maxLength":12,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"referenceNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":10,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"binCardNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BIN card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":6,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}}},"x-viablocks-error-codes":{"type":400002}}},"required":["uuid"]}},"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_200":{"id":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Request status (success, error, etc.)."},"message":{"type":"string","description":"Descriptive message about the operation result."},"folio":{"type":"string","description":"Money transfer tracking number (optional)"},"transaction_id":{"type":"string","description":"Unique identifier of the generated transaction."},"receipt_url":{"type":"string","description":"Publicly accessible URL where the generated receipt file (HTML or PDF) is hosted."},"receipt_html":{"type":"string","description":"Full POS-formatted HTML content of the receipt, ready for rendering or thermal printing."}},"description":"Response success"}},"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_400":{"id":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the request is required. Invalid JSON format."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The branchId is not valid for the given partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400417"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The branchId does not have permission to confirm this transaction."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail validations"}},"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401":{"id":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail authentication"}},"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404":{"id":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","kind":"json-schema","title":"TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not found."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail not found"}},"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_422":{"id":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_422","kind":"json-schema","title":"TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422011"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction funding type does not allow confirmation."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail - The server understands the request, but cannot process it due to business rules."}},"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500":{"id":"components/schemas/TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"TRANSACTION_CONFIRM_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance engine validation failed"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail - Internal Error"}},"components/schemas/TRANSACTION_CREATE_REQUEST":{"id":"components/schemas/TRANSACTION_CREATE_REQUEST","kind":"json-schema","title":"TRANSACTION_CREATE_REQUEST","data":{"type":"object","properties":{"transactionContext":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Context of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"branchId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"cashierId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashier ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":4,"maxLength":20,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}},"sender":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the personal and identification information of the transaction sender."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields are subject to AML, KYC, and compliance validation rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This information is used to verify the identity of the person initiating the transaction and to evaluate regulatory and risk requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"properties":{"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SenderΓÇÖs given (first) name as it appears on their official identification document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SenderΓÇÖs middle name, if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SenderΓÇÖs primary family name (surname)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"secondLastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SenderΓÇÖs second family name, used in some countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SenderΓÇÖs phone number without country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":10,"maxLength":15,"pattern":"^[0-9]+$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"phoneCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International dialing code of the senderΓÇÖs phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":4,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SenderΓÇÖs email address used for notifications and transaction updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, format=400005"},"children":[]}]}]}],"minLength":5,"maxLength":60,"format":"email","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"format":400005}},"addressStreet":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender address. Structure: [Description, city name, State ISO2 zipCode, Country ISO3]. Example:'54545 Salo Rd, Hancock, MI 49930, USA' Regular expression: ^[0-9]+\\s[\\w\\s.,-]+$"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender state (ISO 2).  https://en.wikipedia.org/wiki/ISO_3166-2."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City name of the senderΓÇÖs residence."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressZipCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal or ZIP code of the senderΓÇÖs address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification document provided by the sender (e.g., Passport, National ID)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the types of documents available according to your document country in our catalogs API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Identifications: GET /catalogs/countries/{deliveryCountryISO}/identifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Document Type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BORDER CROSSING CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Border crossing card used to enter certain countries without a passport."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BF"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CPF/CNPJ"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Brazilian tax registry for individuals (CPF) and legal entities (CNPJ)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CARTEIRA DE IDENTIDADE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document issued in Brazil."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA CIUDADAN├ìA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identification document in Colombia."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE IDENTIDAD Y ELECTORAL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document used in the Dominican Republic."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE IDENTIDAD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document issued in various Latin American countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CREDENCIAL DE ELECTOR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Voter identification document used in Mexico."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CERTIFICATE OF NATURALIZATION"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Naturalization certificate that grants citizenship in the U.S. or other countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CADASTRO DE PESSOAS F├ìSICAS (CPF)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Tax registry for individuals in Brazil."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CREW LANDING PERMIT "},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":" BADGE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Landing permit for aircraft crew members."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CV"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE VECINDAD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document in Guatemala."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CZ"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CERTIFICATE OF CITIZENSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Citizenship certificate issued by national governments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DOCUMENTO NACIONAL DE IDENTIDAD (DNI)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document in Argentina, Spain, and other countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DRIVER"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"S LICENSE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Driver"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s license."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DOCUMENTO NACIONAL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"National identity document."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DU"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DOCUMENTO ├ÜNICO DE IDENTIDAD (DUI)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document in El Salvador."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EMPLOYMENT AUTHORIZATION"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Employment authorization document in the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GREEN CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Permanent residence card in the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GOVERNMENT IDENTIFICATION"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identification issued by the government for its citizens."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE IDENTIDAD CIVIL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Civil identity document in several countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IDENTIFICATION CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"General identification card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DRIVER"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"S LICENSE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Driver"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s license."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LIBRETA ELECTORAL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Electoral document in Peru."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LEARNER PERMIT"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Learner"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s permit for driving."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MATR├ìCULA CONSULAR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document issued by consulates to citizens abroad."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MILITARY ID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Military identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NONE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No identity document required."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICIAL ID (POLICE, FIRE, ETC)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Official identification for police, firefighters, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OT"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OTHER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Other type of identity document."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PASSPORT"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passport issued by a government."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PASSPORT CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passport card used in the U.S. for certain international travel."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PASAPORTE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passport."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PERMANENT RESIDENT CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Permanent residence card in some countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RESIDENT ALIEN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Document for a foreign resident."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"STATE ISSUED ID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identification issued by a state or province."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7ub","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SSN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Social Security Number (U.S.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TARJETA DE IDENTIDAD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity card in some Latin American countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TARJETA DE REGISTRO CONSULAR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Consular registration card for citizens abroad."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"VI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"VISA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Entry visa for a country."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable description of the identification document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":0,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentExpirationDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the identification document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, format=400005"},"children":[]}]}]}],"minLength":8,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"format":400005}},"documentState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender state (ISO 2).  https://en.wikipedia.org/wiki/ISO_3166-2."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SenderΓÇÖs date of birth, used for identity verification and compliance checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, format=400005"},"children":[]}]}]}],"minLength":8,"maxLength":10,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"format":400005}},"occupation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's occupation or professional activity. This refers to the name from the list of available jobs based on the selected industry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"employer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the senderΓÇÖs employer or business activity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"proofOfIncome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the senderΓÇÖs source of income or supporting documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"ssnNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9-digit personal identification number issued by the U.S. government for tax, employment, and Social Security purposes.."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":8,"maxLength":9,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"employerPhone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number of the company or organization where a person works."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":10,"maxLength":15,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"industry":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier referencing the industry classification. Property or key \"id\" in our catalogs API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"job":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier representing the specific job or position. Property or key \"jobs\" with \"id\" in our catalogs API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"nationality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender nationality country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"smsOptIn":{"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 sender has consented to receive SMS notifications (transactional and promotional messages). Must not be marked as true by default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}},"preferredOptLanguage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred language for notifications (SMS and email). Accepted values: 'en' (English), 'es' (Spanish). If not provided, defaults to the language header or 'en'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["en","es"],"minLength":2,"maxLength":2,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"emailOptIn":{"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 sender has consented to receive email notifications related to transactions and promotional communications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}},"governmentEmployee":{"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 sender currently works for a government or state-owned company. Required for certain destination countries (e.g., Venezuela) for OFAC compliance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}}},"required":["firstName","lastName","phone","phoneCountryCode","email","addressStreet","addressState","addressCity","addressCountry","addressZipCode","dateOfBirth"],"x-viablocks-error-codes":{"required":400001,"type":400002}},"beneficiary":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the final recipient of the funds in a cross-border transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the personal, identification, and location information required to validate the recipient against AML, sanctions, and regulatory screening rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object is used to ensure the payout can be legally and operationally executed in the destination country."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"properties":{"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BeneficiaryΓÇÖs given name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BeneficiaryΓÇÖs middle name, if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BeneficiaryΓÇÖs primary family name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"secondLastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BeneficiaryΓÇÖs second family name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":2,"maxLength":60,"pattern":"^[A-Za-z├Ç-├û├ÿ-├╢├╕-├┐├æ├▒' -]+$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BeneficiaryΓÇÖs phone number without country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":10,"maxLength":15,"pattern":"^[0-9]+$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"phoneCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International dialing code of the beneficiaryΓÇÖs phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":4,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressStreet":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary address. Structure: [Description, city name, State ISO2 zipCode, Country ISO3]. Example:'54545 Salo Rd, Hancock, MI 49930, USA' Regular expression: ^[0-9]+\\s[\\w\\s.,-]+$"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City name  of residence of the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"addressZipCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal or ZIP code of the beneficiaryΓÇÖs address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification document of the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Document types (documentType) ΓÇö click to expand"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Document Type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BORDER CROSSING CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Border crossing card used to enter certain countries without a passport."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BF"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CPF/CNPJ"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Brazilian tax registry for individuals (CPF) and legal entities (CNPJ)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CARTEIRA DE IDENTIDADE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document issued in Brazil."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA CIUDADAN├ìA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identification document in Colombia."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE IDENTIDAD Y ELECTORAL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document used in the Dominican Republic."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE IDENTIDAD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document issued in various Latin American countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CREDENCIAL DE ELECTOR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Voter identification document used in Mexico."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CERTIFICATE OF NATURALIZATION"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Naturalization certificate that grants citizenship in the U.S. or other countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CADASTRO DE PESSOAS F├ìSICAS (CPF)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Tax registry for individuals in Brazil."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CREW LANDING PERMIT "},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"&"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":" BADGE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Landing permit for aircraft crew members."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CV"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE VECINDAD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document in Guatemala."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CZ"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CERTIFICATE OF CITIZENSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Citizenship certificate issued by national governments."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DOCUMENTO NACIONAL DE IDENTIDAD (DNI)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document in Argentina, Spain, and other countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DRIVER"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"S LICENSE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Driver"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s license."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DOCUMENTO NACIONAL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"National identity document."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DU"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DOCUMENTO ├ÜNICO DE IDENTIDAD (DUI)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document in El Salvador."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EMPLOYMENT AUTHORIZATION"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Employment authorization document in the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GREEN CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Permanent residence card in the U.S."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GOVERNMENT IDENTIFICATION"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identification issued by the government for its citizens."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C├ëDULA DE IDENTIDAD CIVIL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Civil identity document in several countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IDENTIFICATION CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"General identification card."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DRIVER"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"S LICENSE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Driver"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s license."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LIBRETA ELECTORAL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Electoral document in Peru."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"LEARNER PERMIT"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Learner"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s permit for driving."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MATR├ìCULA CONSULAR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity document issued by consulates to citizens abroad."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MILITARY ID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Military identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NONE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"No identity document required."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICIAL ID (POLICE, FIRE, ETC)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Official identification for police, firefighters, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OT"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OTHER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Other type of identity document."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PASSPORT"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passport issued by a government."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PASSPORT CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passport card used in the U.S. for certain international travel."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PP"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PASAPORTE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Passport."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PERMANENT RESIDENT CARD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Permanent residence card in some countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"RESIDENT ALIEN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Document for a foreign resident."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"STATE ISSUED ID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identification issued by a state or province."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SSN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Social Security Number (U.S.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TARJETA DE IDENTIDAD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity card in some Latin American countries."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TARJETA DE REGISTRO CONSULAR"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Consular registration card for citizens abroad."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"VI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"VISA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Entry visa for a country."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document number of the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentDescription":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document number of the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender state (ISO 2).  https://en.wikipedia.org/wiki/ISO_3166-2."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country that issued the beneficiaryΓÇÖs identification document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"relationShip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the relationship between the sender and the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of available relationship options can be retrieved from our API Catalogs:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1recipients~1relationships/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint RelationShips"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint returns a structured list of supported relationship types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"smsOptIn":{"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 beneficiary has consented to receive SMS notifications related to the transaction status and promotional messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}},"preferredOptLanguage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferred language for notifications (SMS and email) for the beneficiary. Accepted values: 'en' (English), 'es' (Spanish). If not provided, defaults to 'en'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["en","es"],"minLength":2,"maxLength":2,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"emailOptIn":{"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 beneficiary has consented to receive email notifications related to the transaction status and promotional communications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}},"governmentEmployee":{"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 beneficiary currently works for a government or state-owned company. Required for certain destination countries (e.g., Venezuela) for OFAC compliance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}}},"required":["firstName","lastName","phone","phoneCountryCode","addressStreet","addressState","addressCity","addressCountry","addressZipCode"],"x-viablocks-error-codes":{"required":400001,"type":400002}},"transactionInformation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the financial, operational, and processing configuration of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains all parameters required to calculate, validate, route, and execute the transfer, including amounts, currencies, delivery method, funding source, fees, and payout instructions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields are validated against business rules, compliance policies, and operational constraints before the transaction is accepted for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"properties":{"deliveryMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the payout execution method for the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how and where the funds will be delivered to the beneficiary (e.g., cash pickup, bank deposit, mobile wallet, or home delivery), including all routing and operational parameters required to complete the payout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the delivery methods available according to your delivery country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Delivery Methods: GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery modes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery Mode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CAJERO ELEC."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an ATM (electronic cashier)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"B"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK (DEPOSIT)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Direct deposit to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"D"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash delivered to the recipient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s address with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRODUCTOS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product-based delivery (specialized)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Home delivery with super/premium configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"G"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Super home delivery (premium, alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Priority delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B with super configuration (alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"L"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unified Payments Interface (India)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"N"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"O"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"P"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE (CASH)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an authorized location (office)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NOT USED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reserved code (not currently in use)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"T"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"V"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX instant payment (Brazil)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The availability of delivery methods may vary by destination country, partner configuration, and Viamericas internal operational settings. Always consult the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to obtain the methods currently available for your integration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["A","B","C","D","E","F","G","H","I","J","L","M","N","O","P","R","S","T","U","V","X"],"minLength":1,"maxLength":1,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"deliveryModeDetails":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the bank account and routing information required to execute the payout to the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object defines the destination financial institution and account where the funds will be deposited, including account number, account type, routing number, and bank details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields are validated against country-specific banking rules and payout network requirements before the transaction is released for payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"accountNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":6,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"accountAuxiliaryField":{"type":"string","minLength":6,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}]},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of bank account associated with the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available account types from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1account-types/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Account Types"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Account types"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Account Type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Saving"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Savings account"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Checking"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Checking account"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Undefined"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Undefined"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["S","C","U"],"minLength":1,"maxLength":1,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank routing or clearing number"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":9,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"bank":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the receiving bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":6,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}},"funding":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the source of funds and funding method used to initiate the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the payment instrument and funding configuration (e.g., cash, debit card, bank account, wallet), and is used to validate, authorize, and register the financial charge before the transaction is processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding source type (e.g., bank account, cash, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"h3","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding Type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account bank"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the transaction is funded directly from a bank account. The funds will be debited from the specified bank account using the configured banking or payment network before the transaction is processed."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the transaction is funded using cash. The sender provides the funds in cash at an authorized agent location or branch before the transaction is processed."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["D","A","C","H","U"],"minLength":1,"maxLength":1,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"accountNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":6,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Routing number bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":9,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"required":["type"],"x-viablocks-error-codes":{"required":400001,"type":400002}},"originationCountryISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origin country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"originationStateISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origin state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"originationLocationCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City where the transaction is initiated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"originationAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of money sent in the origination currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"required":400001,"type":400002,"minimum":400006,"decimal":400008}},"originationCurrencyISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Origin currency (ISO). https://en.wikipedia.org/wiki/ISO_4217"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"exchangeRate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount of money sent in the origination currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"fee":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction service fee charged for processing the remittance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"deliveryCountryISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"deliveryStateISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"deliveryAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to be delivered in the destination currency."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"deliveryAmountCurrencyISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery currency (ISO). https://en.wikipedia.org/wiki/ISO_4217"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"deliveryLocationCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal or partner code of the payout location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":30,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"deliveryLocationNetwork":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network or partner identifier used for payout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":30,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"deliveryLocationName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable name of the payout location or method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":30,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"deliveryLocationCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City where the funds will be delivered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"sourceOfFounds":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that identifies where the funds come from (e.g., salary, savings, investments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available fund sources from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1funds-origin/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Funds Origin"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This information may be required for compliance (KYC/AML) depending on the client configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"remittancePurpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code for the declared purpose of the remittance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available purposes from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1wire-purpose/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Wire Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can be used for compliance classification, reporting, and corridor-specific regulatory requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":1,"maxLength":2,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"couponCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotional or discount coupon code to apply to the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, the system validates the coupon against business rules (expiration, usage limits, corridor eligibility, funding type, etc.). If valid, the applicable discount is calculated and applied to the transaction fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the coupon is valid, the discount is applied to the fee and reflected in the total amount charged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the coupon is invalid, the transaction is "},"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":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error indicating the reason."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation criteria include:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coupon existence and active status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage limits (per sender, per branch, global)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Corridor eligibility (country, delivery mode, payer)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding type compatibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum origination amount threshold"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":30,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"fundingFee":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional fee charged based on the funding method used (e.g., debit card, ACH, cash)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This fee is determined by the pricing engine during the quote and varies depending on the funding type selected by the sender. It is added on top of the base transaction fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: A debit card funding may incur a $2.00 funding fee while cash has $0.00."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"fixFee":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed fee component of the transaction cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the base flat fee charged for the transaction regardless of the amount sent. It is determined by the pricing engine based on the corridor, delivery mode, and partner configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"otherFees":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any additional fees not covered by the standard fee categories (fix, funding, percentage, taxes)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may include regulatory surcharges, compliance fees, or partner-specific charges that apply to certain corridors or transaction types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"percentageFee":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee component applied to the origination amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expressed as a decimal (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.0250"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 2.5% of the origination amount). This fee is calculated by the pricing engine and varies by corridor, amount tier, and partner configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"taxes":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tax amount applied to the transaction fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calculated based on applicable tax rules for the origination state/country. Taxes are applied on top of the base fee and funding fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"viaTasa":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal exchange rate markup or spread applied by the platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value represents the rate differential between the wholesale exchange rate and the rate offered to the client. It is used for internal pricing calculations and reconciliation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"termsAndConditions":{"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 sender has accepted the terms and conditions for this transaction. When true, confirms the sender acknowledged and agreed to the service terms before submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}}},"required":["deliveryMode","funding","originationCountryISO","originationStateISO","originationLocationCity","originationAmount","originationCurrencyISO","deliveryCountryISO","deliveryStateISO","deliveryAmountCurrencyISO","deliveryLocationCode","deliveryLocationNetwork","deliveryLocationName","deliveryLocationCity"],"x-viablocks-error-codes":{"required":400001,"type":400002}},"channel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the integration channel used to create the transaction (API, Web, Messaging, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["API","WHATSAPP"],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"channelMetadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic / Data considered relevant by the client for informational purposes for internal tracking"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}},"externalTransactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier assigned to a transaction by an external system. This field is used to track, correlate, and reconcile transactions across different systems."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"required":["sender","beneficiary","transactionInformation"]}},"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_200":{"id":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"TRANSACTION_CREATE_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Request status (success, error, etc.)."},"message":{"type":"string","description":"Descriptive message about the operation result."},"transaction_id":{"type":"string","description":"Unique identifier of the generated transaction."},"transaction_uuid":{"type":"string","description":"Unique identifier of the generated transaction."},"status_track_url":{"type":"string","description":"URL where the user can track the transaction."},"folio":{"type":"string","description":"Money transfer tracking number (optional)"},"total_receiver":{"type":"string","description":"Amount in destin currency that the customer is sending plus fees (optional)"},"total_pay_receiver":{"type":"string","description":"Amount in destination currency that the beneficiary is receiving (optional)"},"rate":{"type":"string","description":"Exchange rate (optional)."},"source_currency_amount":{"type":"string","description":"Amount in source currency that the customer is sending (optional)."},"payment_url":{"type":"string","description":"URL where the user can complete the payment (optional)"},"required_document_list":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of compliance document types required for this transaction to be fully processed. Each item is a code from the compliance engine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Full Know Your Customer form (identity, employment, document info)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC-Short"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Reduced KYC (document info only, no employer/SSN)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC-Long"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Extended KYC (document + employer, no SSN)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC-Gto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö GTO-specific KYC form"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Identification document information (type, number, expiration, country)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Copy1ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Front image of the identification document"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Date of birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Social Security Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SFunds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Source of funds declaration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DPA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ΓÇö Beneficiary address proof"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this array is empty, no additional documentation is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To fulfill these requirements, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /transaction/update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint with the corresponding fields."},"children":[]}]}]}],"items":{"type":"object"}},"document_requirements":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed fulfillment status for each compliance requirement. Shows whether each item from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was already satisfied with the data provided in this create request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each object contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The compliance document code (matches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"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":"fulfilled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Boolean indicating if all required fields for this type were provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Human-readable status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"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":"missing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": (Only when pending) Array of field paths that were not provided"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to determine which fields need to be submitted via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /transaction/update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object"}},"idSenderGlobal":{"type":"string","description":"UUID of the sender created/linked for this transaction."},"branch_id":{"type":"string","description":"Branch ID where the transaction was created."}},"description":"Response success"}},"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_400":{"id":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"TRANSACTION_CREATE_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the request is required. Invalid JSON format of the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A required field is missing. The error message indicates which field and its expected value."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret_key is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400050"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The promo code provided is invalid or cannot be applied to this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400415"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The routing number is not valid (checksum or provider verification failed)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The branchId is not valid for the given partner, or account verification failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400417"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exchangeRate is invalid. It must be a positive number."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400418"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exchangeRate provided does not match the current rate. Please request a new quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400419"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deliveryAmount does not match the expected calculation (originationAmount ├ù exchangeRate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400420"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee provided does not match the expected fee from pricing. Please request a new quote."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400421"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The taxes or fundingFee provided does not match the expected value from pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400422"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exchangeRate provided is outside the allowed rate range. Please request a new quote."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail validations"}},"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_401":{"id":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"TRANSACTION_CREATE_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail authentication"}},"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_404":{"id":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_404","kind":"json-schema","title":"TRANSACTION_CREATE_REQUEST_post_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender not found"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary does not belong to this sender"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail not found"}},"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_422":{"id":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_422","kind":"json-schema","title":"TRANSACTION_CREATE_REQUEST_post_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The agency credit limit has been exceeded or is insufficient to process this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service is temporarily unable to process transactions with the origination currency (rate not found)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Viamericas is unable to process a transaction for this customer/beneficiary (compliance block)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The externalTransactionId has already been used for another transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The deliveryAmount exceeds the payer delivery limit for this corridor."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing not available for the requested transaction parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination or delivery amount exceeds the maximum allowed for this corridor."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422011"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The origination or delivery amount is below the minimum allowed for this corridor."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail - The server understands the request, but cannot process it due to business rules."}},"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_500":{"id":"components/schemas/TRANSACTION_CREATE_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"TRANSACTION_CREATE_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment link creation failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance engine validation failed"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail - Internal Error"}},"components/schemas/TRANSACTION_QUOTE_REQUEST":{"id":"components/schemas/TRANSACTION_QUOTE_REQUEST","kind":"json-schema","title":"TRANSACTION_QUOTE_REQUEST","data":{"type":"object","properties":{"originationAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to send in the source currency. Either originationAmount or deliveryAmount must be provided (not both). If originationAmount is provided, the system calculates the delivery amount. Must be a positive number with up to 2 decimal places."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0.01,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"deliveryAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Desired delivery amount in destination currency. Either originationAmount or deliveryAmount must be provided (not both). If deliveryAmount is provided, the system calculates the origination amount (reverse calculation). The delivery amount may be adjusted to the nearest factor multiple if the payer requires it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0.01,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"originationCurrencyISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source currency ISO 4217 code (e.g., 'USD', 'EUR'). Must be exactly 3 uppercase letters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"deliveryAmountCurrencyISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery amount currency ISO 4217 code (e.g., 'MXN', 'COP'). Must be exactly 3 uppercase letters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"deliveryCountryISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery country ISO 3166-1 alpha-3 code (e.g., 'MEX', 'COL'). Must be exactly 3 uppercase letters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"deliveryMode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the payout execution method for the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how and where the funds will be delivered to the beneficiary (e.g., cash pickup, bank deposit, mobile wallet, or home delivery), including all routing and operational parameters required to complete the payout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the delivery methods available according to your delivery country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Delivery Methods: GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery modes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery Mode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CAJERO ELEC."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an ATM (electronic cashier)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"B"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK (DEPOSIT)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Direct deposit to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"D"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash delivered to the recipient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s address with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRODUCTOS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product-based delivery (specialized)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Home delivery with super/premium configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"G"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Super home delivery (premium, alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Priority delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B with super configuration (alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"L"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unified Payments Interface (India)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"N"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"O"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"P"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE (CASH)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an authorized location (office)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NOT USED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reserved code (not currently in use)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"T"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"V"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX instant payment (Brazil)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The availability of delivery methods may vary by destination country, partner configuration, and Viamericas internal operational settings. Always consult the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to obtain the methods currently available for your integration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, allowedValues=400010"},"children":[]}]}]}],"enum":["A","B","C","D","E","F","G","H","I","J","L","M","N","O","P","R","S","T","U","V","X"],"x-viablocks-error-codes":{"required":400001,"type":400002,"allowedValues":400010}},"deliveryLocationNetwork":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout network or provider code (e.g., '059568AA', '000010AA'). This field is required for accurate pricing. The pricing engine needs a specific payout network identifier to determine exchange rates and fees. Without it, the request will fail with error 422003 (destination country not supported)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":1,"maxLength":50,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"fundingType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funding method used by the sender. Affects tax calculation ΓÇö Cash (C) may include additional federal/state taxes. Values: C (Cash), D (Debit Card), U (ACH/Bank Transfer), A (Credit Card), H (PayByPhone)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, allowedValues=400010"},"children":[]}]}]}],"enum":["C","D","U","A","H"],"x-viablocks-error-codes":{"required":400001,"type":400002,"allowedValues":400010}},"transactionContext":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction context with branch information. When provided, branchId is used directly for pricing lookup instead of deriving it from the partner chain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"branchId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch ID to use for pricing. If not provided, the system derives the branch from the partner's chain_id."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":1,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}},"promoCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional promotional/coupon code to validate and apply. If valid, the discount is applied to the fee breakdown. Invalid codes do not block the quote ΓÇö the quote is returned without discount and includes the validation result in the promoCode response object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":1,"maxLength":50,"pattern":"^\\S.*$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"receiptFormat":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional output format for the pre-transaction receipt (receiptUrl). Allowed values: 'html', 'pdf'. When omitted, the receipt is generated in 'html' format by default. Only applies when receipt generation is enabled for the partner; sending an unsupported value returns error 400010."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, allowedValues=400010"},"children":[]}]}]}],"enum":["html","pdf"],"x-viablocks-error-codes":{"type":400002,"allowedValues":400010}}},"required":["originationCurrencyISO","deliveryAmountCurrencyISO","deliveryCountryISO","deliveryMode","deliveryLocationNetwork","fundingType"]}},"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_200":{"id":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"TRANSACTION_QUOTE_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status (success)"},"quote":{"type":"object","description":"Quote details","properties":{"quoteTimestamp":{"type":"string","properties":{},"description":"ISO 8601 timestamp when the quote was generated (UTC timezone). Format: YYYY-MM-DDTHH:MM:SSZ. Example: '2026-02-05T10:30:00Z'. Quotes are typically valid for 15 minutes from this timestamp."},"originationAmount":{"type":"number","properties":{},"description":"Amount to send in the source currency. This is the amount the sender wants to transfer, excluding fees. Precision: 2 decimal places. Example: 100.00"},"originationCurrencyISO":{"type":"string","properties":{},"description":"Source currency ISO 4217 code (3 uppercase letters). This is the currency the sender is paying in. Common values: USD (US Dollar), EUR (Euro), GBP (British Pound). Example: 'USD'"},"deliveryAmount":{"type":"number","properties":{},"description":"Amount the recipient will receive in the destination currency. This is calculated by applying the exchange rate to the origination amount. Precision: 2 decimal places. Example: 1850.00"},"deliveryAmountCurrencyISO":{"type":"string","properties":{},"description":"Destination currency ISO 4217 code (3 uppercase letters). This is the currency the recipient will receive. Common values: MXN (Mexican Peso), COP (Colombian Peso), GTQ (Guatemalan Quetzal), HNL (Honduran Lempira). Example: 'MXN'"},"totalAmount":{"type":"number","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total amount the sender will pay, including all fees (originationAmount + totalFee). This is the final amount that will be charged to the sender. Precision: 2 decimal places. Example: 102.50"},"children":[]}]}]}]},"exchangeRate":{"type":"number","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate applied to convert from source currency to destination currency. The deliveryAmount is calculated as: originationAmount ├ù exchangeRate, using this rate exactly as returned, so the value is reproducible on the client side. The rate is rounded to 2 decimal places to match the ViaOne platform. Precision: 2 decimal places. Example: 18.50 (meaning 1 USD = 18.50 MXN)"},"children":[]}]}]}]},"feeBreakdown":{"type":"object","properties":{"fee":{"type":"number","description":"Base transaction service fee charged for processing the remittance. This is the standard fee for the transfer service. Precision: 2 decimal places. Example: 2.00"},"fundingFee":{"type":"number","description":"Additional fee charged based on the funding method used by the sender (e.g., bank account, credit card, debit card). Different funding methods may have different fees. Precision: 2 decimal places. Example: 0.50"},"taxes":{"type":"number","description":"Applicable taxes on the transaction, if any. This may include state or local taxes depending on the sender's location. Will be 0.00 if no taxes apply. Precision: 2 decimal places. Example: 0.00"},"discount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount amount applied from a valid promo code (negative value). Only present when a valid promoCode is provided. Formula: discount = -(fixDiscount + fee ├ù percentageDiscount). Example: -2.50"},"children":[]}]}]}]},"totalFee":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sum of all fees (fee + fundingFee + taxes + discount). This is the total cost of fees that will be added to the origination amount. When a promo code discount is applied, totalFee is reduced accordingly. Precision: 2 decimal places. Example: 2.50"},"children":[]}]}]}]}},"description":"Detailed breakdown of all fees and charges applied to the transaction."},"deliveryMode":{"type":"string","properties":{},"description":"Delivery method code indicating how the recipient will receive the funds. Single-letter codes: 'C' (Bank Deposit - funds deposited directly to recipient's bank account), 'P' (Cash Pickup - recipient collects cash at a physical location), 'O' (Mobile Wallet - funds sent to recipient's mobile wallet), 'H' (Home Delivery - cash delivered to recipient's address). Example: 'P'"},"deliveryLocationNetwork":{"type":"string","properties":{},"description":"Payout network or provider code identifying the specific network used for delivery. This code determines which banks, cash pickup locations, or mobile wallet providers can be used. Format: alphanumeric code, typically 6-8 characters. Examples: '059568AA' (Elektra), '000010AA' (Bancomer), 'PV0001' (specific bank network). Required for accurate pricing and delivery routing."},"minimumAmount":{"type":"number","properties":{},"description":"Minimum transaction amount allowed for this currency pair and delivery method. Transactions below this amount will be rejected. This limit is determined by regulatory requirements and partner configuration. Precision: 2 decimal places. Example: 10.00"},"maximumAmount":{"type":"number","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum origination amount allowed (in source currency, e.g. USD). Determined by rate ranges and payer limits (limit_field < 3). Transactions above this amount will be rejected. Precision: 2 decimal places."},"children":[]}]}]}]},"maximumDeliveryAmount":{"type":"number","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum delivery amount allowed in destination currency (e.g. MXN, COP). Only present when the payer has a local currency limit configured (limit_field >= 3). The recipient cannot receive more than this amount. Precision: 2 decimal places."},"children":[]}]}]}]},"maximumDeliveryAmountCurrency":{"type":"string","properties":{},"description":"ISO 4217 currency code for the maximumDeliveryAmount field (e.g. 'MXN', 'COP'). Only present when maximumDeliveryAmount is included."},"receiptUrl":{"type":"string","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional URL to a pre-transaction receipt (PDF or HTML) that can be shared with the customer before committing to the transaction. The format is controlled by the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"receiptFormat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request field (defaults to HTML). The receipt provides a visual summary of the quote including all fees, exchange rate, and delivery details. Only included if receipt generation is enabled for the partner. Format: HTTPS URL. Example: 'https://s3.us-east-1.amazonaws.com/receipts.viamericas.net/abc123.html'"},"children":[]}]}]}]},"promoCode":{"type":"object","properties":{"code":{"type":"string","description":"The promo code that was submitted for validation."},"isValid":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the promo code is valid and the discount was applied. true = discount applied to feeBreakdown, false = no discount applied."},"children":[]}]}]}]},"fixDiscount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed discount amount in USD (only present when isValid=true). Example: 1.00"},"children":[]}]}]}]},"percentageDiscount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage of the fee to discount as a decimal (only present when isValid=true). Example: 0.10 means 10% of the fee. Formula: totalDiscount = fixDiscount + (fee ├ù percentageDiscount)"},"children":[]}]}]}]},"totalDiscount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total calculated discount amount applied to the fee (only present when isValid=true). This value appears as negative in feeBreakdown.discount."},"children":[]}]}]}]},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason why the promo code is invalid (only present when isValid=false). Values: 'invalid' (code does not exist), 'expired' (code has expired), 'used' (code already used), 'error' (validation service unavailable)."},"children":[]}]}]}]},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable message explaining why the promo code is invalid (only present when isValid=false)."},"children":[]}]}]}]}},"description":"Promo code validation result. Only present when a promoCode was included in the request. Contains validation status and discount details if valid."},"viaTasa":{"type":"object","properties":{"originalRate":{"type":"number","description":"Base exchange rate from pricing factors before the ViaTasa markup. Example: 18.50"},"adjustedRate":{"type":"number","description":"Exchange rate after applying the ViaTasa markup. This is the rate reflected in the quote's exchangeRate and used to compute deliveryAmount. Example: 18.70"},"viaTasaAmount":{"type":"number","description":"The ViaTasa markup added to the original rate (adjustedRate - originalRate). Example: 0.20"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ViaTasa exchange rate markup result. Only present when ViaTasa is active for the partner/agency (viaTasa amount != 0). When applied, the exchangeRate returned in the quote already reflects the adjusted rate. ViaTasa is configured per agency; there is no request field for it."},"children":[]}]}]}]},"rateRange":{"type":"object","properties":{"minRate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum exchange rate the agency may apply. Equals the original rate when the agency does not allow decreasing the rate (ViatasaAllowDecrease=false). Precision: 2 decimal places. Example: 18.13"},"children":[]}]}]}]},"maxRate":{"type":"number","description":"Maximum exchange rate the agency may apply, based on the original rate plus ViatasaLimit. Precision: 2 decimal places. Example: 18.87"}},"description":"Allowed exchange-rate modification bounds when the agency has ViaTasa rules active. Indicates the min/max rate the agency may set for this quote. Only present when agency ViaTasa rules are configured (IsViatasa, branchType 'A', idFlagBranch 'A', PricingVersion 'v2'). Bounds are derived from the original rate and the agency's ViatasaLimit; the range may extend to cover the compositor ViaTasa amount."},"warnings":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-blocking notices about the quote. These do NOT block the quote, but signal conditions that will prevent transaction creation (amount limits) or documental payer-limit notices (non-blocking payer limits, LIMIT_BLOCK='N'). Only present when at least one notice applies."},"children":[]}]}]}],"items":{"type":"object","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notice code. Business-rule codes: 'EXCEEDS_PAYER_DELIVERY_LIMIT', 'EXCEEDS_MAX_ORIGINATION_AMOUNT', 'BELOW_MIN_ORIGINATION_AMOUNT'. Non-blocking payer-limit notice code: 'PAYER_LIMIT_NOTICE'."},"children":[]}]}]}]},"message":{"type":"string","description":"Human-readable explanation of the notice."},"limit":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The configured limit value that was exceeded. Only present for 'PAYER_LIMIT_NOTICE' notices."},"children":[]}]}]}]},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency of the limit (origination currency when limit_field < 3, destination currency when limit_field >= 3). Only present for 'PAYER_LIMIT_NOTICE' notices."},"children":[]}]}]}]},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional short title for the payer-limit notice, when configured. Only present for 'PAYER_LIMIT_NOTICE' notices."},"children":[]}]}]}]}}}}}}},"description":"Successful quote response"}},"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_400":{"id":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"TRANSACTION_QUOTE_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the request is required. Invalid JSON format of the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field is required (applies to any required field)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field must be of the correct type (string, number, object, array)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field does not meet minimum length requirement"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field exceeds maximum length"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field does not match required format (e.g., email, date)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value is below minimum allowed value"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400007"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value exceeds maximum allowed value"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400008"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field has too many decimal places"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field does not match required pattern (regex)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field value is not in the list of allowed values"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Numeric error code identifying the specific validation error (400001-400010)"},"message":{"type":"string","description":"Human-readable error message describing the validation failure"},"details":{"type":"string","description":"Field name that failed validation"}}}}},"description":"Validation error"}},"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_401":{"id":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"TRANSACTION_QUOTE_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Authentication error code (401000)"},"message":{"type":"string","description":"Human-readable authentication error message"},"details":{"type":"string","description":"Additional authentication error context (optional)"}}}}},"description":"Authentication error"}},"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_422":{"id":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_422","kind":"json-schema","title":"TRANSACTION_QUOTE_REQUEST_post_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of business rule errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount below minimum transaction limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount exceeds maximum transaction limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422003"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country not supported (Note: This error may also occur when deliveryLocationNetwork is missing or empty, as the pricing engine requires a specific payout network to determine rates)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode not available for destination country"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currency pair not supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422006"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing not available for requested parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422007"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner not configured for quote endpoint"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422008"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount exceeds a blocking payer limit (LIMIT_BLOCK='Y'). The error payload includes 'limit' and 'currency' fields."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business rule error code (422001-422008). 422008 (AMOUNT_EXCEEDS_LIMIT) is returned when the amount to send exceeds a blocking payer limit (LIMIT_BLOCK='Y'); the error payload also includes 'limit' and 'currency', and may include 'title'. Non-blocking payer limits (LIMIT_BLOCK='N') do not error ΓÇö they appear in the response 'warnings' array as 'PAYER_LIMIT_NOTICE'."},"children":[]}]}]}]},"message":{"type":"string","description":"Human-readable business rule error message"},"details":{"type":"string","description":"Additional context about the business rule violation"}}}}},"description":"Business rule validation error"}},"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_500":{"id":"components/schemas/TRANSACTION_QUOTE_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"TRANSACTION_QUOTE_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database error"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing service unavailable"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string","description":"Error status (always 'failed' for errors)"},"code":{"type":"number","description":"Server error code (500000-500002)"},"message":{"type":"string","description":"Human-readable server error message"},"details":{"type":"string","description":"Additional server error context (optional)"}}}}},"description":"Internal server error"}},"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_200":{"id":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Request status (success, error, etc.)."},"message":{"type":"string","description":"Process message"},"receipt_url":{"type":"string","description":"Publicly accessible URL where the generated receipt is hosted (S3)."},"receipt_html":{"type":"string","description":"Full HTML content of the generated receipt, ready for rendering or printing."}},"description":"Response success"}},"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400":{"id":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the request is required. Invalid JSON format of the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client_id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret_key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail validations"}},"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_401":{"id":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail authentication"}},"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_404":{"id":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not found."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail not found"}},"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_422":{"id":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_422","kind":"json-schema","title":"TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The receipt cannot be generated. The transaction has not been confirmed."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Response fail - Transaction has not been confirmed yet"}},"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500":{"id":"components/schemas/TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"TRANSACTION_RECEIPT_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail - Internal Error"}},"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_200":{"id":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"TRANSACTION_STATUS_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"transaction_uuid":{"type":"string","description":"Unique UUID identifier of the transaction."},"transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal transaction identifier in the format {branchId}-{receiverId} (e.g., I00123-456789)."},"children":[]}]}]}]},"status_track_url":{"type":"string","description":"URL where the user can track the transaction status in real-time."},"date_created":{"type":"string","description":"Date and time when the transaction was created. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time)."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"VOID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The transaction has been voided and is no longer valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CANCEL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The transaction was cancelled before completion."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"EXPIRED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The transaction was not completed within the allowed time window and has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"HOLD"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The transaction is temporarily on hold due to compliance or operational review."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DONE"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The transaction has completed its internal processing flow successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SENDTOBANK"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The transaction has been sent to the bank for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PAID"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The funds have been paid out to the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TRANSFERED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The funds have been transferred to the payout network or external institution."},"children":[]}]}]}]}]}]},"folio":{"type":"string","description":"Money transfer tracking number (MTCN)."},"source_currency_amount":{"type":"number","description":"Amount in the source (origination) currency that the sender is sending."},"source_currency_iso":{"type":"string","description":"ISO currency code of the source (sending) amount. Represents the currency in which the sender funds the transaction."},"total_receiver":{"type":"number","description":"Total amount in destination currency that the customer is sending (including fees applied to delivery)."},"total_pay_receiver":{"type":"number","description":"Amount in destination currency that the beneficiary will actually receive."},"currency_receiver_iso":{"type":"string","description":"ISO currency code of the destination (receiving) amount. Represents the currency in which the beneficiary will receive the funds."},"rate":{"type":"number","description":"Exchange rate applied to the transaction."},"holds":{"type":"array","description":"List of compliance or operational holds applied to the transaction.\n\n Each hold represents a restriction or review requirement that must be resolved before the transaction can proceed.","items":{"type":"object","properties":{"type":{"type":"string","description":"Hold type code."},"description":{"type":"string","description":"Name or description of the hold that lifted the transaction."}}}},"required_document_list":{"type":"array","description":"List of documents required to resolve compliance or regulatory requirements for the transaction.\n\n  This list is typically populated when the transaction requires additional verification or is placed on hold.","items":{"type":"object"}},"document_requirements":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detailed real-time status of each required document. Use this field to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show the user which requirements are complete and which need action"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determine if a document is under review (no action needed, wait)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detect rejections or expirations that require re-submission"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each object contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The compliance requirement code (matches items in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"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":"fulfilled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no further action is needed for this requirement, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if action is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Detailed lifecycle status of the requirement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Action"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirement fully satisfied and approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not yet submitted — upload/submit required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit via PUT /transaction/update"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_review"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document uploaded, awaiting approval"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wait — do not re-submit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document was reviewed and rejected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-submit with corrected document"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document was valid but has expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-submit with current document"},"children":[]}]}]}]}]}]}],"items":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance requirement code. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Full identity and employment verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC-Short"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Basic identity verification (no employer/SSN)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KYC-Long"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Identity + employer verification (no SSN)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Identification document information"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Copy1ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Identification document image (front required, back may be required depending on document type)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Date of birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SSN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Social Security Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SFunds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Source of funds declaration"},"children":[]}]}]}]}]},"fulfilled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no further action is needed (completed or in review). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the user must take action (pending, rejected, or expired)."},"children":[]}]}]}]},"status":{"type":"string","description":"Current lifecycle status of this requirement."}}}},"payment_rail":{"type":"string","description":"Payment rail used for the transaction (e.g., ACH, RTP, FEDNOW). Null if not applicable or not yet determined."},"date_available":{"type":"string","description":"Estimated date when the funds will be available to the beneficiary. Null if not applicable or not yet determined. Format: MM/DD/YYYY or ISO 8601 depending on the payout network."},"date_payment":{"type":"string","description":"Date when the transaction was paid out to the beneficiary. Null if the transaction has not been paid yet. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time)."},"date_transfer":{"type":"string","description":"Date when the funds were transferred to the payout network or external institution. Null if the transaction has not been transferred yet. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time)."},"date_cancel":{"type":"string","description":"Date when the transaction was cancelled or voided. Null if the transaction has not been cancelled. Format: MM/DD/YYYY HH:MM:SS AM/PM (US Eastern time)."}},"description":"Response success"}},"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_400":{"id":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"TRANSACTION_STATUS_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body of the request is required. Invalid JSON format of the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client_id is required"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400005"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"secret_key is required"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail validations"}},"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_401":{"id":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"TRANSACTION_STATUS_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail authentication"}},"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_404":{"id":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"TRANSACTION_STATUS_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction not found."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail not found"}},"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_500":{"id":"components/schemas/TRANSACTION_STATUS_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"TRANSACTION_STATUS_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of object errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Error"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Response fail - Internal Error"}},"components/schemas/TRANSACTION_UPDATE_REQUEST":{"id":"components/schemas/TRANSACTION_UPDATE_REQUEST","kind":"json-schema","title":"TRANSACTION_UPDATE_REQUEST","data":{"type":"object","properties":{"uuid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier (UUID) of the transaction to update. Must match an existing transaction in the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":32,"maxLength":60,"x-viablocks-error-codes":{"required":400001,"type":400002,"minLength":400003,"maxLength":400004}},"transactionContext":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational context for the transaction update, including branch and cashier identification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"branchId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch ID associated with the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"cashierId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cashier or operator ID performing the update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":4,"maxLength":20,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}},"sender":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender information for compliance and identity verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields in this object are conditionally required based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction/status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The system will only request fields that haven't been fulfilled yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"dateOfBirth":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's date of birth, used for identity verification and compliance checks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, format=400005"},"children":[]}]}]}],"minLength":8,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"format":400005}},"documentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identification document provided by the sender (e.g., Passport, National ID)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the types of documents available according to your document country in our catalogs API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Identifications: GET /catalogs/countries/{deliveryCountryISO}/identifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Document types (documentType) — click to expand"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Document Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PA"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PASSPORT"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DRIVER'S LICENSE"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"STATE ISSUED ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"GREEN CARD"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MATRÍCULA CONSULAR"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identification document number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentExpirationDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration date of the identification document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format: YYYY-MM-DD"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, format=400005"},"children":[]}]}]}],"minLength":8,"maxLength":10,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"format":400005}},"documentCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country that issued the identification document (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"documentState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State that issued the identification document (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"ssnNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9-digit personal identification number issued by the U.S. government for tax, employment, and Social Security purposes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":8,"maxLength":9,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"occupation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender's occupation or professional activity. This refers to the name from the list of available jobs based on the selected industry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"employer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the sender's employer or business activity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"employerPhone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone number of the company or organization where the sender works."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":10,"maxLength":15,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"industry":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier referencing the industry classification. Property or key \"id\" in our catalogs API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"job":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier representing the specific job or position. Property or key \"jobs\" with \"id\" in our catalogs API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1industry/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Industry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"documentFrontImage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Front image of the identification document encoded in base64 JPEG format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data:image/jpeg;base64,/9j/4AAQSkZJRg..."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only JPEG images with the data URI prefix are accepted. Maximum size: 5 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is required when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required_document_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transaction/status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":100,"maxLength":6990508,"pattern":"^data:image\\/jpeg;base64,[A-Za-z0-9+/]+=*$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"documentBackImage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back image of the identification document encoded in base64 JPEG format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required format:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data:image/jpeg;base64,/9j/4AAQSkZJRg..."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only JPEG images with the data URI prefix are accepted. Maximum size: 5 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When is it required?"},"children":[]}]}]}]},{"$$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":"Required for document types that have information on both sides (e.g., Driver's License "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", State Issued ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Green Card "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not required for single-sided documents (e.g., Passport "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If required and not provided, the ID upload service will return a 400 error indicating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backImage is required for this document type and country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":100,"maxLength":6990508,"pattern":"^data:image\\/jpeg;base64,[A-Za-z0-9+/]+=*$","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}}},"x-viablocks-error-codes":{"type":400002}},"beneficiary":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the final recipient of the funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the personal and location information that can be updated for the beneficiary. Only fields with values will be updated; empty or missing fields retain their current values from the original transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"firstName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's given name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"middleName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's middle name, if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"lastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's primary family name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"secondLastName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's second family name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary's phone number without country code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":10,"maxLength":15,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"phoneCountryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"International dialing code of the beneficiary's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":4,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressStreet":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary address. Structure: [Description, city name, State ISO2 zipCode, Country ISO3]. Example:'54545 Salo Rd, Hancock, MI 49930, USA'"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressState":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City name of residence of the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressCountry":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beneficiary country (ISO 3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":3,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"addressZipCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postal or ZIP code of the beneficiary's address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":5,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"relationShip":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the relationship between the sender and the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of available relationship options can be retrieved from our API Catalogs:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1recipients~1relationships/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint RelationShips"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint returns a structured list of supported relationship types, including their corresponding codes and descriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}},"transactionInformation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the transaction processing parameters that can be updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes delivery mode details, geographic information, and compliance-related fields (source of funds, remittance purpose) that may be required for KYC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"deliveryModeDetails":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the bank account and routing information for the payout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object defines the destination financial institution and account where the funds will be deposited."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"properties":{"accountNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":6,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of bank account associated with the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available account types from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1account-types/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Account Types"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Account types"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Account Type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Saving"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Savings account"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Checking"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Checking account"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Undefined"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Undefined"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, allowedValues=400010"},"children":[]}]}]}],"enum":["S","C","U"],"minLength":1,"maxLength":1,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"allowedValues":400010}},"routingNumber":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank routing or clearing number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":9,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}},"deliveryStateISO":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery state (ISO 2). https://en.wikipedia.org/wiki/ISO_3166-2"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":6,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"deliveryLocationCity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City where the funds will be delivered."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":2,"maxLength":60,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}},"sourceOfFounds":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code that identifies where the funds come from (e.g., salary, savings, investments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available fund sources from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1funds-origin/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Funds Origin"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This information may be required for compliance (KYC/AML) depending on the client configuration, corridor, or transaction amount thresholds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minimum=400006, decimal=400008"},"children":[]}]}]}],"minimum":0,"x-viablocks-error-codes":{"type":400002,"minimum":400006,"decimal":400008}},"remittancePurpose":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code for the declared purpose of the remittance, describing why the funds are being sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available purposes from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1wire-purpose/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Wire Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This can be used for compliance classification, reporting, and corridor-specific regulatory requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004"},"children":[]}]}]}],"minLength":1,"maxLength":2,"x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004}}},"x-viablocks-error-codes":{"type":400002}}},"required":["uuid"]}},"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_200":{"id":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_200","kind":"json-schema","title":"TRANSACTION_UPDATE_REQUEST_put_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result status. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the request was processed correctly."},"children":[]}]}]}]},"message":{"type":"string","description":"Confirmation message describing the outcome."},"transaction_id":{"type":"string","description":"Unique transaction identifier."},"kyc_updated":{"type":"boolean","description":"Indicates that compliance (KYC) information was received and saved. Only present when compliance data was submitted."},"id_uploaded":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when an ID image upload was attempted in this request."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Document was accepted and is now under review"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Upload failed (e.g., image quality, format issue) — you can retry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not present"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when:"},"children":[]}]}]},{"$$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":"Copy1ID was not in the required documents"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID was already uploaded and is in review or approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only KYC or modification fields were submitted"},"children":[]}]}]}]}]},"modification_sent":{"type":"boolean","description":"Indicates that a modification request for beneficiary or delivery details was submitted for processing. Only present when modifiable fields were changed."}},"description":"The update was processed successfully. The response indicates which operations were performed."}},"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_400":{"id":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_400","kind":"json-schema","title":"TRANSACTION_UPDATE_REQUEST_put_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors with specific field details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body is required and must be valid JSON."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A required field is missing. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field for the specific field path."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400416"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided branchId is not valid for your account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400418"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No fields were provided to update. Include at least one field in sender, beneficiary, or transactionInformation."},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"The request contains invalid or missing data. Review the error details and correct the request."}},"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_401":{"id":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_401","kind":"json-schema","title":"TRANSACTION_UPDATE_REQUEST_put_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provided credentials are invalid. Verify your x-client-id and x-secret-key."},"children":[]}]}]}]}]}]}]}]}]}},"description":"Authentication failed. Verify your credentials."}},"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_404":{"id":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_404","kind":"json-schema","title":"TRANSACTION_UPDATE_REQUEST_put_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction was not found. Verify the UUID is correct."},"children":[]}]}]}]}]}]}]}]}]}},"description":"The transaction was not found. Verify the UUID is correct."}},"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_422":{"id":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_422","kind":"json-schema","title":"TRANSACTION_UPDATE_REQUEST_put_RESPONSE_422","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 422 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422012"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is not currently available for modification. Compliance submissions (KYC/ID) may still be allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422013"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A modification request is already in progress or has been completed. Compliance submissions (KYC/ID) may still be allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422014"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction cannot be updated due to its current status (e.g., cancelled or paid). No operations are allowed."},"children":[]}]}]}]}]}]}]}]}]}},"description":"The request was understood but cannot be processed due to the transaction's current state."}},"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_500":{"id":"components/schemas/TRANSACTION_UPDATE_REQUEST_put_RESPONSE_500","kind":"json-schema","title":"TRANSACTION_UPDATE_REQUEST_put_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred. Please try again later or contact support if the issue persists."},"children":[]}]}]}]}]}]}]}]}]}},"description":"An unexpected error occurred. Please try again later."}},"components/schemas/WEBHOOK_REQUEST":{"id":"components/schemas/WEBHOOK_REQUEST","kind":"json-schema","title":"WEBHOOK_REQUEST","data":{"type":"object","properties":{"webhook_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4 identifier of the webhook to update. Required for PUT operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"required":400001,"type":400002}},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New HTTPS endpoint URL for webhook notifications. If provided, triggers regeneration of the webhook_secret. Must use HTTPS scheme and not exceed 2048 characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002, minLength=400003, maxLength=400004, pattern=400009"},"children":[]}]}]}],"minLength":9,"maxLength":2048,"pattern":"^https://","x-viablocks-error-codes":{"type":400002,"minLength":400003,"maxLength":400004,"pattern":400009}},"events":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated list of transaction status event types to subscribe to. If provided, must contain at least one valid event type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"items":{"type":"string","enum":["transaction.status.onHold","transaction.status.inProcess","transaction.status.readyToSend","transaction.status.transferred","transaction.status.paid","transaction.status.cancelled","transaction.status.void","transaction.status.expired","transaction.status.all"]},"x-viablocks-error-codes":{"type":400002}},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the webhook should be active. Set to false to temporarily disable notifications without removing the configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"type":400002}},"branches":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of branch IDs to receive notifications for. Use [\"all\"] to receive notifications for all branches. If not provided, the current value is preserved."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: type=400002"},"children":[]}]}]}],"items":{"type":"string"},"x-viablocks-error-codes":{"type":400002}}},"required":["webhook_id"]}},"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_200":{"id":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"WEBHOOK_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status (success)"},"data":{"type":"object","description":"Registration result","properties":{"webhook_id":{"type":"string","properties":{},"description":"UUID v4 identifier for the registered webhook"},"webhook_url":{"type":"string","properties":{},"description":"The registered webhook URL"},"events":{"type":"array","description":"List of subscribed event types","items":{"type":"string"}},"webhook_secret":{"type":"string","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The generated 64-character hex HMAC signing secret. Store this securely — it is only returned at registration time."},"children":[]}]}]}]},"active":{"type":"boolean","properties":{},"description":"Whether the webhook is active (true after registration)"},"created_at":{"type":"string","properties":{},"description":"ISO 8601 UTC timestamp of when the webhook was registered"}}}},"description":"Webhook registered successfully"}},"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_400":{"id":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"WEBHOOK_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL is required, must use HTTPS scheme, or invalid event type provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL does not match required HTTPS pattern"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL exceeds maximum length of 2048 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type is not in the list of supported event types"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error"}},"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401":{"id":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"WEBHOOK_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authentication error"}},"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_500":{"id":"components/schemas/WEBHOOK_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"WEBHOOK_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error during registration"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Internal server error"}},"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_200":{"id":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_200","kind":"json-schema","title":"WEBHOOK_REQUEST_delete_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"success"},"data":{"type":"object","description":"Deactivated webhook config","properties":{"webhook_id":{"type":"string","properties":{}},"url":{"type":"string","properties":{}},"events":{"type":"array","items":{"type":"string"}},"branches":{"type":"array","items":{"type":"string"}},"active":{"type":"boolean","properties":{},"description":"Always false after DELETE"},"created_at":{"type":"string","properties":{}},"updated_at":{"type":"string","properties":{}}}}},"description":"Webhook deactivated"}},"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_400":{"id":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_400","kind":"json-schema","title":"WEBHOOK_REQUEST_delete_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook_id query parameter is required"},"children":[]}]}]}]}]}]}]}]}]}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing webhook_id"},"children":[]}]}]}]}},"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401":{"id":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_401","kind":"json-schema","title":"WEBHOOK_REQUEST_delete_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}]}},"description":"Authentication error"}},"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404":{"id":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_404","kind":"json-schema","title":"WEBHOOK_REQUEST_delete_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook not found"},"children":[]}]}]}]}]}]}]}]}]}},"description":"Webhook not found"}},"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500":{"id":"components/schemas/WEBHOOK_REQUEST_delete_RESPONSE_500","kind":"json-schema","title":"WEBHOOK_REQUEST_delete_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal server error"}},"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_200":{"id":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status (success)"},"data":{"type":"array","description":"List of delivery log records (max 50, sorted by timestamp descending)","items":{"type":"object","properties":{"event_id":{"type":"string","description":"UUID v4 identifier for the webhook event"},"transaction_uuid":{"type":"string","description":"UUID of the transaction that triggered the webhook"},"event_type":{"type":"string","description":"The event type delivered (e.g. transaction.status.paid)"},"timestamp":{"type":"string","description":"ISO 8601 UTC timestamp of the delivery attempt"},"http_status_code":{"type":"number","description":"HTTP status code returned by the partner endpoint (null if connection failed)"},"response_time_ms":{"type":"number","description":"Response time in milliseconds"},"attempt_number":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery attempt number (1 = initial, 2-6 = retries)"},"children":[]}]}]}]},"delivery_status":{"type":"string","description":"Delivery result: success, failed, pending, or filtered"},"failure_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for failure (null on success). E.g. connection_timeout, read_timeout, http_status_500"},"children":[]}]}]}]}}}}},"description":"Delivery history retrieved successfully"}},"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_400":{"id":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_400","kind":"json-schema","title":"WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid transaction_uuid format — must match UUID v4 pattern (lowercase hex with hyphens)"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error (invalid transaction_uuid format)"},"children":[]}]}]}]}},"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401":{"id":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error"}},"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_500":{"id":"components/schemas/WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"WEBHOOK_DELIVERIES_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error querying delivery log"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error"}},"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_200":{"id":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_200","kind":"json-schema","title":"WEBHOOK_REQUEST_get_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"success"},"data":{"type":"string","description":"Array of webhooks (no param) or single webhook object (with param)"}},"description":"Webhook configuration(s) retrieved"}},"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_401":{"id":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_401","kind":"json-schema","title":"WEBHOOK_REQUEST_get_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}]}},"description":"Authentication error"}},"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_404":{"id":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_404","kind":"json-schema","title":"WEBHOOK_REQUEST_get_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook not found"},"children":[]}]}]}]}]}]}]}]}]}},"description":"Webhook not found"}},"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_500":{"id":"components/schemas/WEBHOOK_REQUEST_get_RESPONSE_500","kind":"json-schema","title":"WEBHOOK_REQUEST_get_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error"},"children":[]}]}]}]}]}]}]}]}]}},"description":"Internal server error"}},"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST":{"id":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST","kind":"json-schema","title":"WEBHOOK_ROTATE_SECRET_REQUEST","data":{"type":"object","properties":{"webhook_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4 identifier of the webhook to rotate the secret for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"required":400001,"type":400002}}},"required":["webhook_id"]}},"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_200":{"id":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status (success)"},"data":{"type":"object","description":"Rotation result","properties":{"webhook_secret":{"type":"string","properties":{},"description":"The new 64-character hex HMAC signing secret. Store this securely."},"grace_period_expires_at":{"type":"string","properties":{},"description":"ISO 8601 UTC timestamp when the old secret will no longer be accepted for verification."},"message":{"type":"string","properties":{},"description":"Human-readable confirmation message."}}}},"description":"Secret rotated successfully"}},"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_401":{"id":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error"}},"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_404":{"id":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_404","kind":"json-schema","title":"WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No webhook configuration exists for this partner"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"No webhook registration found"}},"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_500":{"id":"components/schemas/WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"WEBHOOK_ROTATE_SECRET_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error during secret rotation"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error"}},"components/schemas/WEBHOOK_TEST_REQUEST":{"id":"components/schemas/WEBHOOK_TEST_REQUEST","kind":"json-schema","title":"WEBHOOK_TEST_REQUEST","data":{"type":"object","properties":{"webhook_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4 identifier of the webhook to send a test delivery to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes: required=400001, type=400002"},"children":[]}]}]}],"x-viablocks-error-codes":{"required":400001,"type":400002}}},"required":["webhook_id"]}},"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_200":{"id":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_200","kind":"json-schema","title":"WEBHOOK_TEST_REQUEST_post_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status (success)"},"data":{"type":"object","description":"Test delivery result","properties":{"test_event_id":{"type":"string","properties":{},"description":"UUID v4 identifier for the test event"},"delivery_status":{"type":"string","properties":{},"description":"Delivery result: success or failed"},"http_status_code":{"type":"number","properties":{},"description":"HTTP status code returned by the partner endpoint (null if connection failed)"},"response_time_ms":{"type":"number","properties":{},"description":"Response time in milliseconds"},"failure_reason":{"type":"string","properties":{},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason for failure (null on success). E.g. connection_timeout, read_timeout, http_status_500"},"children":[]}]}]}]},"webhook_url":{"type":"string","properties":{},"description":"The webhook URL the test was delivered to"},"signature_header":{"type":"string","properties":{},"description":"The X-Webhook-Signature header value sent with the test delivery (for verification debugging)"}}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test delivery completed (check delivery_status for result)"},"children":[]}]}]}]}},"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_400":{"id":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_400","kind":"json-schema","title":"WEBHOOK_TEST_REQUEST_post_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook is inactive — must be active to send test delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400002"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook does not have a signing secret configured"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Webhook is inactive or missing signing secret"}},"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_401":{"id":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_401","kind":"json-schema","title":"WEBHOOK_TEST_REQUEST_post_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Authentication error"}},"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_404":{"id":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_404","kind":"json-schema","title":"WEBHOOK_TEST_REQUEST_post_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No webhook found for the given webhook_id"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Webhook not found"}},"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_500":{"id":"components/schemas/WEBHOOK_TEST_REQUEST_post_RESPONSE_500","kind":"json-schema","title":"WEBHOOK_TEST_REQUEST_post_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error during test delivery"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"}}}}},"description":"Internal server error"}},"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_200":{"id":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_200","kind":"json-schema","title":"WEBHOOK_REQUEST_put_RESPONSE_200","data":{"type":"object","properties":{"status":{"type":"string","description":"Response status (success)"},"data":{"type":"object","description":"Updated webhook configuration","properties":{"webhook_url":{"type":"string","properties":{},"description":"The current webhook URL"},"events":{"type":"array","description":"List of subscribed event types","items":{"type":"string"}},"active":{"type":"boolean","properties":{},"description":"Whether the webhook is currently active"},"webhook_secret":{"type":"string","properties":{},"description":"New signing secret (only present if URL was changed). Store securely."},"created_at":{"type":"string","properties":{},"description":"ISO 8601 UTC timestamp of original registration"},"updated_at":{"type":"string","properties":{},"description":"ISO 8601 UTC timestamp of this update"}}}},"description":"Webhook configuration updated successfully"}},"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_400":{"id":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_400","kind":"json-schema","title":"WEBHOOK_REQUEST_put_RESPONSE_400","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of validation errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 400 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400001"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid event type provided or empty events list (at least one event type is required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400009"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL does not match required HTTPS pattern"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400004"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL exceeds maximum length of 2048 characters"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400010"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event type is not in the list of supported event types"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Validation error"}},"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_401":{"id":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_401","kind":"json-schema","title":"WEBHOOK_REQUEST_put_RESPONSE_401","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of authentication errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 401 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid credentials"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Authentication error"}},"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_404":{"id":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_404","kind":"json-schema","title":"WEBHOOK_REQUEST_put_RESPONSE_404","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of not found errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 404 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No webhook configuration exists for this webhook_id"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Webhook configuration not found"}},"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_500":{"id":"components/schemas/WEBHOOK_REQUEST_put_RESPONSE_500","kind":"json-schema","title":"WEBHOOK_REQUEST_put_RESPONSE_500","data":{"type":"object","properties":{"errors":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of server errors"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error catalog for 500 (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","width":"140px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500000"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal server error during update"},"children":[]}]}]}]}]}]}]}]}],"items":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"number"},"message":{"type":"string"},"details":{"type":"string"}}}}},"description":"Internal server error"}},"schema_89":{"kind":"json-schema","data":{"type":"string","description":"Unique identifier assigned to the integrating client.","minLength":16,"maxLength":64},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string","description":"Secret authentication key associated with the client.","minLength":32,"maxLength":128},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"string","description":"UUID of the beneficiary to retrieve.","minLength":10,"maxLength":60},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"string","description":"UUID of the sender. If provided, verifies the beneficiary belongs to this sender before returning it.","minLength":10,"maxLength":60},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"string","description":"Client identifier.","minLength":16,"maxLength":64},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"string","description":"Secret key.","minLength":32,"maxLength":128},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"string","description":"Return validation schema instead of executing the request","enum":["true","false"]},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"string","description":"Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request.","minLength":16,"maxLength":64},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"string","description":"Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential.","minLength":32,"maxLength":128},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"string","description":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., USA, MEX, COL)","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"string","description":"Delivery mode: P (Payout/Cash Pickup), C (Cash Delivery), O (Other)","enum":["P","C","O"],"minLength":1,"maxLength":1},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"string","description":"Payout location network code (e.g., ELEKTRA, OXXO, 059568AA)","minLength":1,"maxLength":50},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"string","description":"Postal/ZIP code for location lookup","minLength":3,"maxLength":10},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"string","description":"Search filter value for location lookup (used in master/location endpoint)","minLength":2,"maxLength":60},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"string","description":"Delivery location code for payers-rules endpoint","minLength":1,"maxLength":50},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"string","description":"Partner client identifier for authentication","minLength":16,"maxLength":64},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"string","description":"Partner secret key for authentication","minLength":32,"maxLength":128},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"string","description":"Country ISO 3166-1 alpha-3 code (3 uppercase letters, e.g., MEX, COL, BRA)","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode code that defines the payout execution method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how and where the funds will be delivered to the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the delivery methods available according to your delivery country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Delivery Methods: GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery modes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery Mode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CAJERO ELEC."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an ATM (electronic cashier)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"B"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK (DEPOSIT)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Direct deposit to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"D"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash delivered to the recipient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s address with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRODUCTOS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product-based delivery (specialized)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Home delivery with super/premium configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"G"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Super home delivery (premium, alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Priority delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B with super configuration (alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"L"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unified Payments Interface (India)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"N"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"O"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"P"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE (CASH)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an authorized location (office)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NOT USED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reserved code (not currently in use)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"T"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"V"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX instant payment (Brazil)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The availability of delivery methods may vary by destination country, partner configuration, and Viamericas internal operational settings. Always consult the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to obtain the methods currently available for your integration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryCountryISO=USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryMode=A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ATM), payout availability is additionally gated by the ATM network: an unreachable or excluded city yields a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"enum":["A","B","C","D","E","F","G","H","I","J","L","M","N","O","P","R","S","T","U","V","X"],"minLength":1,"maxLength":1},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branch the quote is for. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": exchange rates and the set of available payers depend on the branch, most chains operate more than one branch, and there is no safe default. Validated against the authenticated partner's chain; a branchId belonging to another chain is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400416"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":4,"maxLength":10},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout currency as an ISO 4217 code (3 uppercase letters, e.g., USD, COP, MXN). "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the pricing source filters payout locations by currency and treats an absent currency as matching nothing, so omitting it returns an empty list rather than all currencies. A currency that does not resolve to a supported payout currency is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400010"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use the same value you would pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryAmountCurrencyISO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/transaction/create"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional destination subdivision as an ISO 3166-2 code. Both the prefixed form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CO-ANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and the bare form ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are accepted. When supplied but not recognized for the destination country, the request is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400010"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than silently widening the result. Obtain valid values from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/states"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":2,"maxLength":6},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional internal city identifier used to narrow payout locations to a specific city. Passed through to the pricing source unchanged. Obtain valid values from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /catalogs/countries/{deliveryCountryISO}/states/{addressState}/cities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":20},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"type":"string","description":"Return the validation schema instead of executing the request.","enum":["true","false"]},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery mode code that defines the payout execution method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how and where the funds will be delivered to the beneficiary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can check the delivery methods available according to your delivery country in our catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Delivery Methods: GET /catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery modes (click to expand)"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{"style":{"borderCollapse":"collapse","width":"100%","marginTop":"8px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Code"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Delivery Mode"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px","textAlign":"left"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Description"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"CAJERO ELEC."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an ATM (electronic cashier)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"B"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"C"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK (DEPOSIT)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Direct deposit to a bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"D"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash delivered to the recipient"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"s address with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"E"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRODUCTOS"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Product-based delivery (specialized)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"F"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Home delivery with super/premium configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"G"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DELIVERY ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Super home delivery (premium, alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"H"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PRI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Priority delivery method."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"I"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B digital payment network with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"J"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bre-B with super configuration (alternate)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"L"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"UPI"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unified Payments Interface (India)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"N"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"O"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Deposit to a mobile wallet."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"P"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE (CASH)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash withdrawal at an authorized location (office)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"R"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"NOT USED"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Reserved code (not currently in use)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"S"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OFFICE ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Cash pickup at office with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"T"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"BANK ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Bank deposit with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"U"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ ESPEC"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with special configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"V"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"M-WALLET ++ SUPER"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Mobile wallet with super configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{"style":{"border":"1px solid #e5e7eb","padding":"6px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"PIX instant payment (Brazil)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The availability of delivery methods may vary by destination country, partner configuration, and Viamericas internal operational settings. Always consult the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/catalogs/countries/{deliveryCountryISO}/deliver-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to obtain the methods currently available for your integration."},"children":[]}]}]}]}],"enum":["A","B","C","D","E","F","G","H","I","J","L","M","N","O","P","R","S","T","U","V","X"],"minLength":1,"maxLength":1},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payer code (ProcessedByCode) obtained from the payouts endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field"},"children":[]}]}]}],"minLength":1,"maxLength":50},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout network code obtained from the payouts endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deliveryLocationNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field (e.g., '005141AA', 'ELEKTRA')"},"children":[]}]}]}],"minLength":1,"maxLength":50},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"type":"string","description":"Optional sender UUID. When provided, payer rules may include personalized field values (e.g., pre-filled phone number for hidden sender fields). If omitted, the property is sent empty to prevent errors.","minLength":0,"maxLength":36,"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^$"},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"string","description":"Language for localized response fields (labelText, errorMessage). Defaults to 'en' if omitted.","enum":["en","es"]},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional payout currency mode used to filter payout networks. This is NOT an ISO 4217 code. Accepted values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = the destination country's local currency, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = US dollars. Any other value matches no payout network and yields an empty list. Forwarded upstream to the catalog service."},"children":[]}]}]}],"enum":["N","D"],"minLength":1,"maxLength":1},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"string","description":"Optional city name used to narrow payout networks to those operating in a specific city. Forwarded upstream to the catalog service.","minLength":1,"maxLength":100},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"string","description":"Country ISO 3166-1 alpha-3 code (e.g., MEX, COL, USA)","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$"},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"string","description":"ISO 3166-2 state/province code as returned by the states endpoint (e.g., MX-JAL, US-CA, CO-ANT)","minLength":4,"maxLength":6,"pattern":"^[A-Z]{2}-[A-Z0-9]{1,3}$"},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"string","description":"Search filter value for location lookup (city, state, or country name)","minLength":2,"maxLength":60},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"string","description":"Postal/ZIP code for location lookup (e.g. '33166', '10001')","minLength":3,"maxLength":10,"pattern":"^[A-Za-z0-9\\- ]{3,10}$"},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"string","description":"Branch identifier for the partner. Must be a valid branch belonging to the partner's chain.","minLength":1,"maxLength":20},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination country in ISO 3166-1 alpha-3 format (e.g., MEX, COL, HND, GTM)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve the list of available countries from our Catalogs API:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/outbound/catalogs/paths/~1catalogs~1countries/get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalogs Endpoint Countries"},"children":[]}]}]}]}],"minLength":2,"maxLength":4,"pattern":"^[A-Z]{2,3}$"},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return validation schema instead of executing the request. When set to 'true', returns the merged schema (base + partner override) as JSON."},"children":[]}]}]}],"enum":["true","false"]},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"string","description":"Branch identifier for the partner. Must be a valid branch belonging to the partner's chain. Used to retrieve top-country rates for the specified branch.","minLength":1,"maxLength":20},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"string","description":"When set to 'true', returns the merged validation schema for this endpoint instead of executing the request.","enum":["true","false"]},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"string","description":"Sender global UUID used to look up the profile.","minLength":10,"maxLength":50},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string","description":"Specific branch to query. If omitted, the branch is resolved automatically across the partner's branches.","minLength":5,"maxLength":10},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string","description":"Search term. Can be a name (partial match) or phone number (exact match).","minLength":2,"maxLength":60},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country filter (ISO 3166-1 alpha-3). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not provided."},"children":[]}]}]}],"minLength":3,"maxLength":3},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"string","description":"API key for authentication. Use this OR x-client-id/x-secret-key pair.","minLength":16,"maxLength":128},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"string","description":"Partner client identifier. Must be sent together with x-secret-key.","minLength":16,"maxLength":64},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"type":"string","description":"Partner secret key. Must be sent together with x-client-id.","minLength":32,"maxLength":128},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"string","description":"Unique identifier (UUID) of the transaction for which to generate the receipt.","minLength":32,"maxLength":60},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"minLength":2,"maxLength":5},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output format for the receipt. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pdf","html"],"minLength":3,"maxLength":4},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"string","minLength":32,"maxLength":60},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"string","description":"UUID v4 identifier of the webhook to deactivate."},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"string","description":"UUID v4 identifier of a specific webhook to retrieve. If omitted, all webhooks for the partner are returned."},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"string","description":"UUID v4 identifier of the webhook to query deliveries for.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"string","description":"Filter delivery records by a specific transaction UUID. Must be lowercase UUID v4 format.","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"id":"schema_143"}},"exampleStore":{"paths/~1beneficiary/post/requestBody/content/application~1json/examples/default":{"value":{"senderUuid":"4ed19e29-5a6a-433d-908d-23377fabb617","firstName":"ANGEL","middleName":"","lastName":"RESTADO","secondLastName":"","phone":"3057118816","phoneCountryCode":"+1","email":"angel@example.com","addressStreet":"1450 Brickell Avenue Apt 2908, Miami, FL 33131, USA","addressState":"US-FL","addressCity":"MIAMI","addressCountry":"USA","addressZipCode":"33131","relationShip":"Family"},"key":"default","summary":"Create beneficiary","id":"paths/~1beneficiary/post/requestBody/content/application~1json/examples/default"},"paths/~1beneficiary/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"Beneficiary created successfully","uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"key":"default","summary":"Beneficiary created","id":"paths/~1beneficiary/post/responses/200/content/application~1json/examples/default"},"paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_missing_field":{"value":{"errors":[{"status":"failed","code":400001,"message":"senderUuid is required","details":"senderUuid"}]},"key":"400_missing_field","summary":"Required field missing","id":"paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_missing_field"},"paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_validation":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field firstName is required","details":"firstName"},{"status":"failed","code":400003,"message":"Field phone must have a minimum length of 10","details":"phone"}]},"key":"400_validation","summary":"Field validation error","id":"paths/~1beneficiary/post/responses/400/content/application~1json/examples/400_validation"},"paths/~1beneficiary/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1beneficiary/post/responses/401/content/application~1json/examples/default"},"paths/~1beneficiary/post/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404001,"message":"Sender not found. The provided senderUuid does not match any existing sender.","details":"senderUuid"}]},"key":"default","summary":"Sender not found","id":"paths/~1beneficiary/post/responses/404/content/application~1json/examples/default"},"paths/~1beneficiary/post/responses/422/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":422015,"message":"A beneficiary with the same name already exists for this sender.","details":"Beneficiary 'ANGEL RESTADO' is already registered.","uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}]},"key":"default","summary":"Beneficiary already exists","id":"paths/~1beneficiary/post/responses/422/content/application~1json/examples/default"},"paths/~1beneficiary/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Internal server error"}]},"key":"default","summary":"Internal error","id":"paths/~1beneficiary/post/responses/500/content/application~1json/examples/default"},"paths/~1beneficiary/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"Beneficiary retrieved successfully","data":{"idSenderGlobal":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","firstName":"ANGEL","lastName":"RESTADO","phone1":"3057118816","email":"angel@example.com","address":"1450 Brickell Avenue Apt 2908","cityName":"MIAMI","countryId":"USA","relationShip":"Family"}},"key":"default","summary":"Beneficiary found","id":"paths/~1beneficiary/get/responses/200/content/application~1json/examples/default"},"paths/~1beneficiary/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field uuid is required in query parameter"}]},"key":"default","summary":"Missing uuid","id":"paths/~1beneficiary/get/responses/400/content/application~1json/examples/default"},"paths/~1beneficiary/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1beneficiary/get/responses/401/content/application~1json/examples/default"},"paths/~1beneficiary/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"Beneficiary not found"}]},"key":"default","summary":"Not found","id":"paths/~1beneficiary/get/responses/404/content/application~1json/examples/default"},"paths/~1beneficiary/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Error retrieving beneficiary"}]},"key":"default","summary":"Internal error","id":"paths/~1beneficiary/get/responses/500/content/application~1json/examples/default"},"paths/~1beneficiary/put/requestBody/content/application~1json/examples/default":{"value":{"uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","firstName":"MARIA","phone":"5551234567","addressStreet":"2500 Main St, Dallas, TX 75201, USA","documentType":"DL","documentNumber":"D9876543"},"key":"default","summary":"Update beneficiary","id":"paths/~1beneficiary/put/requestBody/content/application~1json/examples/default"},"paths/~1beneficiary/put/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"Beneficiary updated successfully","uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"key":"default","summary":"Beneficiary updated","id":"paths/~1beneficiary/put/responses/200/content/application~1json/examples/default"},"paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_missing_uuid":{"value":{"errors":[{"status":"failed","code":400001,"message":"uuid is required","details":"uuid"}]},"key":"400_missing_uuid","summary":"Missing uuid","id":"paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_missing_uuid"},"paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_validation":{"value":{"errors":[{"status":"failed","code":400003,"message":"Field phone must have a minimum length of 10","details":"phone"}]},"key":"400_validation","summary":"Field validation error","id":"paths/~1beneficiary/put/responses/400/content/application~1json/examples/400_validation"},"paths/~1beneficiary/put/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1beneficiary/put/responses/401/content/application~1json/examples/default"},"paths/~1beneficiary/put/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Error updating beneficiary"}]},"key":"default","summary":"Internal error","id":"paths/~1beneficiary/put/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1account-types/get/responses/200/content/application~1json/examples/default":{"value":[{"id":"1","type":"Checking"},{"id":"2","type":"Savings"}],"key":"default","summary":"Successful account types response","id":"paths/~1catalogs~1account-types/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1account-types/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1account-types/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1account-types/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1account-types/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1account-types/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1account-types/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries/get/responses/200/content/application~1json/examples/default":{"value":[{"deliveryCountryISO":"BRA","countryName":"Brazil"},{"deliveryCountryISO":"COL","countryName":"Colombia"},{"deliveryCountryISO":"DOM","countryName":"Dominican Republic"},{"deliveryCountryISO":"ECU","countryName":"Ecuador"},{"deliveryCountryISO":"GTM","countryName":"Guatemala"},{"deliveryCountryISO":"HND","countryName":"Honduras"},{"deliveryCountryISO":"MEX","countryName":"Mexico"},{"deliveryCountryISO":"NIC","countryName":"Nicaragua"},{"deliveryCountryISO":"PER","countryName":"Peru"},{"deliveryCountryISO":"SLV","countryName":"El Salvador"},{"deliveryCountryISO":"USA","countryName":"United States"}],"key":"default","summary":"Successful response — list of available countries","id":"paths/~1catalogs~1countries/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1countries/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Partner not authorized","id":"paths/~1catalogs~1countries/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1countries/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/200/content/application~1json/examples/default":{"value":[{"id":1,"name":"PESO MEXICANO","code":"MXN"},{"id":2,"name":"DOLAR AMERICANO","code":"USD"}],"key":"default","summary":"Successful currencies response","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1currencies/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/200/content/application~1json/examples/default":{"value":[{"id":"C","name":"Deposit to Account"},{"id":"P","name":"Cash Pick Up"},{"id":"E","name":"Mobile Wallet"}],"key":"default","summary":"Successful delivery methods response","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":[{"paymentLocationCode":"U65120","paymentLocationName":"BANCOLOMBIA","payerName":"BANCOLOMBIA","processedByCode":"T060","whatToBring":"Documento de identidad","businessHours":"Lun-Vie 8:00-16:00","addressBranch":"Cra 40 N 13-34, Medellin","currencyName":"COLOMBIAN PESO","sortOrder":1,"dolarLimit":0,"nationalLimit":15000000,"sourceLimit":15000000,"networkPayment":false,"rates":[{"maxAmount":1000,"rate":3.92},{"maxAmount":1500,"rate":3.91}]}]},"key":"default","summary":"Colombia - Bank Deposit with rate tiers and limits","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/200_empty":{"value":{"status":"success","data":[]},"key":"200_empty","summary":"No payers for the corridor / currency, or ATM gate blocked (200, never 404)","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/200/content/application~1json/examples/200_empty"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"currency is required","details":"currency"}]},"key":"default","summary":"Validation error - required field missing","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_branch_wrong_chain":{"value":{"errors":[{"status":"failed","code":400416,"message":"The branchId 'A99999' is not valid.","details":{"branchId":"A99999"}}]},"key":"400_branch_wrong_chain","summary":"branchId does not belong to the partner's chain","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_branch_wrong_chain"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_unresolved_currency":{"value":{"errors":[{"status":"failed","code":400010,"message":"The currency 'XYZ' is not a supported currency.","details":"currency"}]},"key":"400_unresolved_currency","summary":"Supplied currency does not resolve","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/400/content/application~1json/examples/400_unresolved_currency"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Authorization error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500001,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Database error while fetching payout pricing","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":[{"mappedField":"beneficiary.phone","required":true,"type":"string","minLength":5,"maxLength":14,"pattern":null,"allowedValues":null,"description":null,"errorMessage":null,"order":0,"isHidden":false,"defaultValue":null},{"mappedField":"beneficiary.documentType","required":false,"type":"string","minLength":1,"maxLength":2,"pattern":null,"allowedValues":[{"id":"CI","value":"CEDULA DE IDENTIDAD"}],"description":"Beneficiary ID Type","errorMessage":"The ID type is invalid","order":1,"isHidden":false,"defaultValue":null},{"mappedField":"sender.governmentEmployee","required":true,"type":"string","minLength":0,"maxLength":5,"pattern":null,"allowedValues":[{"id":"true","value":"Yes"},{"id":"false","value":"No"}],"description":"Does the sender currently work for the Venezuelan government or a Venezuelan state-owned company?","errorMessage":"This field is required for transactions to Venezuela.","order":900,"isHidden":false,"defaultValue":null},{"mappedField":"beneficiary.governmentEmployee","required":true,"type":"string","minLength":0,"maxLength":5,"pattern":null,"allowedValues":[{"id":"true","value":"Yes"},{"id":"false","value":"No"}],"description":"To the best of your knowledge, does the beneficiary currently work for the Venezuelan government or a Venezuelan state-owned company?","errorMessage":"This field is required for transactions to Venezuela.","order":901,"isHidden":false,"defaultValue":null}]},"key":"default","summary":"Successful response with payer rules (VEN example with compliance questions)","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/200_no_country_rules":{"value":{"status":"success","data":[{"mappedField":"transactionInformation.deliveryModeDetails.accountNumber","required":true,"type":"string","minLength":18,"maxLength":18,"pattern":"^[0-9]{18}$","allowedValues":null,"description":"CLABE Number","errorMessage":"The CLABE must be exactly 18 digits","order":1,"isHidden":false,"defaultValue":null}]},"key":"200_no_country_rules","summary":"Successful response for non-VEN country (no compliance questions)","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/200/content/application~1json/examples/200_no_country_rules"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Missing required header","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Resource not authorized for partner","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No payer rules found for country VEN, delivery method Z, payer code INVALID"}]},"key":"default","summary":"No payer rules found","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/404/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payers-rules/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/default":{"value":[{"deliveryLocationNetwork":"ELEKTRA","deliveryLocationName":"Elektra","deliveryCountryISO":"MEX","nameCountry":"MEXICO","deliveryLocationCode":"V03001","accNumberRegex":null,"accTypeRequired":false,"networkPayment":true,"accountDescription":null,"accountLabel":null},{"deliveryLocationNetwork":"BANCOPPEL","deliveryLocationName":"BanCoppel","deliveryCountryISO":"MEX","nameCountry":"MEXICO","deliveryLocationCode":"V04001","accNumberRegex":null,"accTypeRequired":false,"networkPayment":true,"accountDescription":null,"accountLabel":null}],"key":"default","summary":"Mexico - Cash Pickup (OFFICE CASH)","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_colombia_bank":{"value":[{"deliveryLocationNetwork":"BC0001","deliveryLocationName":"Bancolombia","deliveryCountryISO":"COL","nameCountry":"COLOMBIA","deliveryLocationCode":"T060","accNumberRegex":"^[0-9]{8,16}$","accTypeRequired":true,"networkPayment":false,"accountDescription":"Numero de cuenta bancaria","accountLabel":"Cuenta"}],"key":"200_colombia_bank","summary":"Colombia - Bank Deposit (BANK DEPOSIT)","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_colombia_bank"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_brazil_pix":{"value":[{"deliveryLocationNetwork":"PIX001","deliveryLocationName":"PIX Brazil","deliveryCountryISO":"BRA","nameCountry":"BRAZIL","deliveryLocationCode":"BRPIX","accNumberRegex":"^[0-9]{11}$","accTypeRequired":false,"networkPayment":false,"accountDescription":"Chave PIX","accountLabel":"PIX"}],"key":"200_brazil_pix","summary":"Brazil - PIX","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/200/content/application~1json/examples/200_brazil_pix"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Authorization error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No payout networks found for country MEX with delivery method Z","details":"deliveryCountryISO: MEX, deliveryMode: Z"}]},"key":"default","summary":"Not found error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/404/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/200/content/application~1json/examples/default":{"value":[{"deliveryLocationNetwork":"006053AA","deliveryLocationName":"BANCO W","deliveryLocationCity":"LETICIA","SubDivisionCode":"AMA","SubDivisionName":"AMAZONAS","CountryName":"COLOMBIA","CountryCodeISO2":"CO","CountryCodeISO3":"COL","AddressBranch":"CALLE 7 # 10 - 36","WhatToBring":null,"BusinessHours":"L-D:9:00AM-5:00PM"},{"deliveryLocationNetwork":"014273AA","deliveryLocationName":"BANCO W","deliveryLocationCity":"MEDELLIN","SubDivisionCode":"ANT","SubDivisionName":"ANTIOQUIA","CountryName":"COLOMBIA","CountryCodeISO2":"CO","CountryCodeISO3":"COL","AddressBranch":"1 CUADRA ABAJO DE LA ESTACION PARQUE BERRIO POR AV COLOMBIA","WhatToBring":"FOLIO + ID","BusinessHours":"L-J 8:00AM-4:30PM;V:8:00AM-5:00PM"}],"key":"default","summary":"Payout locations list with subdivision and country codes","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400000,"message":"Missing required path parameter: deliveryCountryISO"}]},"key":"default","summary":"Validation error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Authorization error - partner not allowed","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1deliver-methods~1{deliveryMode}~1payouts~1{deliveryLocationNetwork}~1locations/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/200/content/application~1json/examples/default":{"value":[{"documentType":"PP","documentDescription":"Passport","expirationDateRequired":true,"backSideRequired":false},{"documentType":"DL","documentDescription":"Driver License","expirationDateRequired":true,"backSideRequired":true},{"documentType":"SS","documentDescription":"State ID","expirationDateRequired":true,"backSideRequired":true}],"key":"default","summary":"Successful identifications response","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1identifications/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/default":{"value":[{"addressState":"MX-AGU","stateName":"AGUASCALIENTES"},{"addressState":"MX-BCN","stateName":"BAJA CALIFORNIA"},{"addressState":"MX-BCS","stateName":"BAJA CALIFORNIA SUR"},{"addressState":"MX-CAM","stateName":"CAMPECHE"},{"addressState":"MX-CHP","stateName":"CHIAPAS"},{"addressState":"MX-CHH","stateName":"CHIHUAHUA"},{"addressState":"MX-DIF","stateName":"CIUDAD DE MEXICO"},{"addressState":"MX-COA","stateName":"COAHUILA"},{"addressState":"MX-COL","stateName":"COLIMA"},{"addressState":"MX-DUR","stateName":"DURANGO"},{"addressState":"MX-GUA","stateName":"GUANAJUATO"},{"addressState":"MX-GRO","stateName":"GUERRERO"},{"addressState":"MX-HID","stateName":"HIDALGO"},{"addressState":"MX-JAL","stateName":"JALISCO"},{"addressState":"MX-MEX","stateName":"MEXICO"},{"addressState":"MX-MIC","stateName":"MICHOACAN"},{"addressState":"MX-NLE","stateName":"NUEVO LEON"},{"addressState":"MX-OAX","stateName":"OAXACA"},{"addressState":"MX-PUE","stateName":"PUEBLA"},{"addressState":"MX-SIN","stateName":"SINALOA"}],"key":"default","summary":"Successful response — states for Mexico","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_colombia":{"value":[{"addressState":"CO-ANT","stateName":"ANTIOQUIA"},{"addressState":"CO-ATL","stateName":"ATLANTICO"},{"addressState":"CO-DC","stateName":"BOGOTA D.C."},{"addressState":"CO-BOL","stateName":"BOLIVAR"},{"addressState":"CO-CUN","stateName":"CUNDINAMARCA"},{"addressState":"CO-VAC","stateName":"VALLE DEL CAUCA"}],"key":"200_colombia","summary":"Successful response — states for Colombia","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_colombia"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_usa":{"value":[{"addressState":"US-CA","stateName":"CALIFORNIA"},{"addressState":"US-FL","stateName":"FLORIDA"},{"addressState":"US-NY","stateName":"NEW YORK"},{"addressState":"US-TX","stateName":"TEXAS"}],"key":"200_usa","summary":"Successful response — states for USA","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/200/content/application~1json/examples/200_usa"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400009,"message":"deliveryCountryISO must be 3 uppercase letters (e.g., MEX, COL)","details":"deliveryCountryISO"}]},"key":"default","summary":"Invalid path parameter","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Partner not authorized","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No states found for country ZZZ"}]},"key":"default","summary":"No states found","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/404/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/default":{"value":[{"cityId":"Z5624","cityName":"GUADALAJARA"},{"cityId":"Z5625","cityName":"ZAPOPAN"},{"cityId":"Z5626","cityName":"TLAQUEPAQUE"},{"cityId":"Z5627","cityName":"TONALA"},{"cityId":"Z5628","cityName":"PUERTO VALLARTA"},{"cityId":"Z5629","cityName":"LAGOS DE MORENO"},{"cityId":"Z5630","cityName":"TEPATITLAN DE MORELOS"}],"key":"default","summary":"Successful response — cities for Jalisco, Mexico","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_colombia":{"value":[{"cityId":"C1001","cityName":"MEDELLIN"},{"cityId":"C1002","cityName":"ENVIGADO"},{"cityId":"C1003","cityName":"BELLO"},{"cityId":"C1004","cityName":"ITAGUI"},{"cityId":"C1005","cityName":"RIONEGRO"}],"key":"200_colombia","summary":"Successful response — cities for Antioquia, Colombia","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_colombia"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_usa":{"value":[{"cityId":"U4001","cityName":"MIAMI"},{"cityId":"U4002","cityName":"ORLANDO"},{"cityId":"U4003","cityName":"TAMPA"},{"cityId":"U4004","cityName":"JACKSONVILLE"},{"cityId":"U4005","cityName":"FORT LAUDERDALE"}],"key":"200_usa","summary":"Successful response — cities for Florida, USA","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/200/content/application~1json/examples/200_usa"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400009,"message":"stateISO must match ISO 3166-2 format (e.g., MX-JAL, US-CA)","details":"stateISO"}]},"key":"default","summary":"Invalid path parameter","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Partner not authorized","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No cities found for state MX-ZZZ"}]},"key":"default","summary":"No cities found","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/404/content/application~1json/examples/default"},"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1countries~1{deliveryCountryISO}~1states~1{addressState}~1cities/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1funds-origin/get/responses/200/content/application~1json/examples/default":{"value":[{"id":6,"fundsOrigin":"EMPLOYMENT INCOME","order":1},{"id":2,"fundsOrigin":"SAVINGS","order":2},{"id":3,"fundsOrigin":"BUSINESS INCOME","order":3}],"key":"default","summary":"Successful funds origin response","id":"paths/~1catalogs~1funds-origin/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1funds-origin/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1funds-origin/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1funds-origin/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1funds-origin/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1funds-origin/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1funds-origin/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/autocomplete_request":{"value":{"address":"123 Main St","event":"autocomplete","countries":["us"]},"key":"autocomplete_request","summary":"Autocomplete address suggestions","description":"POST /catalogs/google-maps-api","id":"paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/autocomplete_request"},"paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/geocode_request":{"value":{"address":"1600 Amphitheatre Parkway, Mountain View, CA","event":"geocode","countries":["us"]},"key":"geocode_request","summary":"Geocode a full address","description":"POST /catalogs/google-maps-api","id":"paths/~1catalogs~1google-maps-api/post/requestBody/content/application~1json/examples/geocode_request"},"paths/~1catalogs~1google-maps-api/post/responses/200/content/application~1json/examples/default":{"value":{"predictions":[{"description":"123 Main Street, Miami, FL, USA","place_id":"ChIJN1t_tDeuEmsRUsoyG83frY4"},{"description":"123 Main Street, Los Angeles, CA, USA","place_id":"ChIJE9on3F3HwoAR9AhGJW_fL-I"}]},"key":"default","summary":"Successful autocomplete response","id":"paths/~1catalogs~1google-maps-api/post/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1google-maps-api/post/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"address is required","details":"address"}]},"key":"default","summary":"Validation error - missing address field","id":"paths/~1catalogs~1google-maps-api/post/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1google-maps-api/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1google-maps-api/post/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1google-maps-api/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1google-maps-api/post/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1industry/get/responses/200/content/application~1json/examples/default":{"value":[{"id":"7","industry":"AGRICULTURE/FARMING","order":1,"jobs":[{"id":"107","name":"ASSISTANT"},{"id":"108","name":"FARMER"}]},{"id":"3","industry":"CONSTRUCTION","order":2,"jobs":[{"id":"301","name":"CARPENTER"},{"id":"302","name":"ELECTRICIAN"}]}],"key":"default","summary":"Successful industries response","id":"paths/~1catalogs~1industry/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1industry/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1industry/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1industry/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1industry/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1industry/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1industry/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1master~1location/get/responses/200/content/application~1json/examples/default":{"value":[{"deliveryCountryISO":"MEX","stateName":"JALISCO","addressState":"MX-JAL","addressCity":"MEZCALA","addressZipCode":"00000"},{"deliveryCountryISO":"MEX","stateName":"GUERRERO","addressState":"MX-GRO","addressCity":"MEZCALA","addressZipCode":"40530"}],"key":"default","summary":"Successful location search","id":"paths/~1catalogs~1master~1location/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1master~1location/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"filterValue is required","details":"filterValue"}]},"key":"default","summary":"Validation error - missing filterValue","id":"paths/~1catalogs~1master~1location/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1master~1location/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1master~1location/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1master~1location/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1master~1location/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/200/content/application~1json/examples/default":{"value":[{"cityName":"MIAMI","addressState":"US-FL","stateName":"Florida"},{"cityName":"MIAMI SPRINGS","addressState":"US-FL","stateName":"Florida"}],"key":"default","summary":"Successful ZIP code lookup","id":"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1master~1zipcodes~1{addressZipCode}/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1recipients~1relationships/get/responses/200/content/application~1json/examples/default":{"value":[{"id":"AUNT","translations":{"en":"Aunt","es":"Tía"}},{"id":"SPOUSE","translations":{"en":"Spouse","es":"Cónyuge"}},{"id":"FRIEND","translations":{"en":"Friend","es":"Amigo/a"}},{"id":"UNCLE","translations":{"en":"Uncle","es":"Tío"}}],"key":"default","summary":"Successful relationships response","id":"paths/~1catalogs~1recipients~1relationships/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1recipients~1relationships/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1recipients~1relationships/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1recipients~1relationships/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1recipients~1relationships/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1recipients~1relationships/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1recipients~1relationships/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/200/content/application~1json/examples/default":{"value":[{"reasonId":"1","reasonName":"CAMBIO DE MODALIDAD DE PAGO"},{"reasonId":"2","reasonName":"CAMBIO DE BENEFICIARIO"},{"reasonId":"3","reasonName":"CAMBIO DE MONTO"}],"key":"default","summary":"Successful cancel reasons response","id":"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400000,"message":"Invalid request format"}]},"key":"default","summary":"Validation error - invalid request","id":"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Access forbidden","id":"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/403/content/application~1json/examples/default"},"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1transaction~1cancel-reasons/get/responses/500/content/application~1json/examples/default"},"paths/~1catalogs~1wire-purpose/get/responses/200/content/application~1json/examples/default":{"value":[{"id":"F","remittancePurpose":"FAMILY SUPPORT"},{"id":"E","remittancePurpose":"EDUCATION"},{"id":"B","remittancePurpose":"BILLS/UTILITY PAYMENT"}],"key":"default","summary":"Successful wire purposes response","id":"paths/~1catalogs~1wire-purpose/get/responses/200/content/application~1json/examples/default"},"paths/~1catalogs~1wire-purpose/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"default","summary":"Validation error - missing header","id":"paths/~1catalogs~1wire-purpose/get/responses/400/content/application~1json/examples/default"},"paths/~1catalogs~1wire-purpose/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1catalogs~1wire-purpose/get/responses/401/content/application~1json/examples/default"},"paths/~1catalogs~1wire-purpose/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1catalogs~1wire-purpose/get/responses/500/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":[{"deliveryLocationName":"Elektra","deliveryModeName":"CASH PICKUP","deliveryAmountCurrencyName":"Peso Mexicano","exchangeRate":18.5,"originationAmountFrom":1,"originationAmountTo":2999,"fundingType":"CASH","sort":1,"dolarAmountLimit":2999},{"deliveryLocationName":"Bancomer","deliveryModeName":"BANK DEPOSIT","deliveryAmountCurrencyName":"Peso Mexicano","exchangeRate":18.35,"originationAmountFrom":1,"originationAmountTo":5000,"fundingType":"ACH","sort":2,"dolarAmountLimit":5000}]},"key":"default","summary":"Successful payer rates response with multiple payers","id":"paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_single_payer":{"value":{"status":"success","data":[{"deliveryLocationName":"Banrural","deliveryModeName":"BANK DEPOSIT","deliveryAmountCurrencyName":"Quetzal","exchangeRate":7.75,"originationAmountFrom":1,"originationAmountTo":3000,"fundingType":"CASH","sort":1,"dolarAmountLimit":3000}]},"key":"200_single_payer","summary":"Response with a single payer available","id":"paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_single_payer"},"paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_empty":{"value":{"status":"success","data":[]},"key":"200_empty","summary":"No payers available for the requested country","id":"paths/~1pricing~1payers/get/responses/200/content/application~1json/examples/200_empty"},"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"branchId is required","details":"branchId"}]},"key":"default","summary":"Validation error — missing branchId","id":"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_country":{"value":{"errors":[{"status":"failed","code":400009,"message":"deliveryCountryISO is required","details":"deliveryCountryISO"}]},"key":"400_missing_country","summary":"Validation error — missing deliveryCountryISO","id":"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_country"},"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_invalid_branch":{"value":{"errors":[{"status":"failed","code":400416,"message":"The branchId 'INVALID' is not valid.","details":{"branchId":"INVALID"}}]},"key":"400_invalid_branch","summary":"Validation error — branchId not valid for partner","id":"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_invalid_branch"},"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_header":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"400_missing_header","summary":"Validation error — missing authentication header","id":"paths/~1pricing~1payers/get/responses/400/content/application~1json/examples/400_missing_header"},"paths/~1pricing~1payers/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication failed","id":"paths/~1pricing~1payers/get/responses/401/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Authorization failed — endpoint not allowed for partner","id":"paths/~1pricing~1payers/get/responses/403/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/422/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":422006,"message":"Pricing data could not be retrieved"}]},"key":"default","summary":"Pricing data could not be retrieved","id":"paths/~1pricing~1payers/get/responses/422/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1pricing~1payers/get/responses/500/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/502/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":502001,"message":"Unable to authenticate with pricing service"}]},"key":"default","summary":"Authentication with pricing service failed","id":"paths/~1pricing~1payers/get/responses/502/content/application~1json/examples/default"},"paths/~1pricing~1payers/get/responses/503/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":503001,"message":"Pricing service temporarily unavailable"}]},"key":"default","summary":"Pricing service temporarily unavailable","id":"paths/~1pricing~1payers/get/responses/503/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":[{"deliveryCountryISO":"MEX","countryName":"Mexico","deliveryLocationName":"Elektra","deliveryMode":"P","exchangeRate":18.5,"deliveryAmountCurrencyISO":"MXN"},{"deliveryCountryISO":"COL","countryName":"Colombia","deliveryLocationName":"Bancolombia","deliveryMode":"T","exchangeRate":4350,"deliveryAmountCurrencyISO":"COP"},{"deliveryCountryISO":"GTM","countryName":"Guatemala","deliveryLocationName":"Banrural","deliveryMode":"T","exchangeRate":7.75,"deliveryAmountCurrencyISO":"GTQ"}]},"key":"default","summary":"Successful top-countries response","id":"paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_single_country":{"value":{"status":"success","data":[{"deliveryCountryISO":"MEX","countryName":"Mexico","deliveryLocationName":"Elektra","deliveryMode":"P","exchangeRate":18.25,"deliveryAmountCurrencyISO":"MXN"}]},"key":"200_single_country","summary":"Response with a single top country","id":"paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_single_country"},"paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_empty":{"value":{"status":"success","data":[]},"key":"200_empty","summary":"No top countries available for this branch","id":"paths/~1pricing~1top-countries/get/responses/200/content/application~1json/examples/200_empty"},"paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"branchId is required","details":"branchId"}]},"key":"default","summary":"Validation error — missing branchId","id":"paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_invalid_branch":{"value":{"errors":[{"status":"failed","code":400416,"message":"The branchId 'INVALID' is not valid.","details":{"branchId":"INVALID"}}]},"key":"400_invalid_branch","summary":"Validation error — branchId not valid for partner","id":"paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_invalid_branch"},"paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_missing_header":{"value":{"errors":[{"status":"failed","code":400001,"message":"x-client-id is required (send it in headers)","details":"x-client-id"}]},"key":"400_missing_header","summary":"Validation error — missing authentication header","id":"paths/~1pricing~1top-countries/get/responses/400/content/application~1json/examples/400_missing_header"},"paths/~1pricing~1top-countries/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication failed","id":"paths/~1pricing~1top-countries/get/responses/401/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Authorization failed — endpoint not allowed for partner","id":"paths/~1pricing~1top-countries/get/responses/403/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/422/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":422006,"message":"Pricing data could not be retrieved"}]},"key":"default","summary":"Pricing data not available","id":"paths/~1pricing~1top-countries/get/responses/422/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1pricing~1top-countries/get/responses/500/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/502/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":502001,"message":"Unable to authenticate with pricing service"}]},"key":"default","summary":"Authentication with pricing service failed","id":"paths/~1pricing~1top-countries/get/responses/502/content/application~1json/examples/default"},"paths/~1pricing~1top-countries/get/responses/503/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":503001,"message":"Pricing service temporarily unavailable"}]},"key":"default","summary":"Pricing service temporarily unavailable","id":"paths/~1pricing~1top-countries/get/responses/503/content/application~1json/examples/default"},"paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_only":{"value":{"uuid":"4ed19e29-5a6a-433d-908d-23377fabb617","documentType":"PA","documentCountry":"MEX","documentNumber":"PA12345678","frontImage":"data:image/jpeg;base64,/9j/4AAQSkZJRg..."},"key":"front_only","summary":"Upload sender ID document (front only)","id":"paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_only"},"paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_and_back":{"value":{"uuid":"4ed19e29-5a6a-433d-908d-23377fabb617","documentType":"CL","documentCountry":"MEX","documentNumber":"DL12345678","frontImage":"data:image/jpeg;base64,/9j/4AAQSkZJRg...","backImage":"data:image/jpeg;base64,/9j/4BBRSkZJRg..."},"key":"front_and_back","summary":"Upload sender ID document (front and back)","description":"Upload front and back images of a Credencial de Elector (back side required).","id":"paths/~1sender~1id-upload/post/requestBody/content/application~1json/examples/front_and_back"},"paths/~1sender~1id-upload/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"The ID has been successfully uploaded"},"key":"default","summary":"Successful upload","id":"paths/~1sender~1id-upload/post/responses/200/content/application~1json/examples/default"},"paths/~1sender~1id-upload/post/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field uuid is required"}]},"key":"default","summary":"Validation error","id":"paths/~1sender~1id-upload/post/responses/400/content/application~1json/examples/default"},"paths/~1sender~1id-upload/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1sender~1id-upload/post/responses/401/content/application~1json/examples/default"},"paths/~1sender~1id-upload/post/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404002,"message":"Sender not found"}]},"key":"default","summary":"Sender not found","id":"paths/~1sender~1id-upload/post/responses/404/content/application~1json/examples/default"},"paths/~1sender~1id-upload/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Internal server error"}]},"key":"default","summary":"Internal error","id":"paths/~1sender~1id-upload/post/responses/500/content/application~1json/examples/default"},"paths/~1sender/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"Sender found successfully","data":{"uuid":"7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f","idSenderGlobal":1024142114,"idSender":55012,"firstName":"MICHAEL","middleName":"JAMES","lastName":"JOHNSON","secondLastName":"","phone":"3055551234","phoneCountryCode":"+1","email":"michael.johnson@example.com","dateOfBirth":"1985-03-14","addressStreet":"1450 Brickell Avenue Apt 2908, Miami, FL 33131, USA","addressCity":"MIAMI","addressState":"US-FL","addressCountry":"USA","addressZipCode":"33131","documentType":"DL","documentDescription":"DRIVER'S LICENSE","documentNumber":"J525874512030","documentExpirationDate":"2029-03-14","documentState":"US-FL","documentCountry":"USA","occupation":"SOFTWARE ENGINEER","employer":"VIAMERICAS CORP","employerPhone":"3055559876","proofOfIncome":"PAYSLIP","ssnNumber":"123456789","industry":7,"job":107,"nationality":"USA","currentBranch":"A00765","identityDocuments":[{"documentType":"DL","documentTypeName":"DRIVER'S LICENSE","documentNumber":"J525874512030","documentState":"US-FL","documentCountry":"USA","expirationDate":"2029-03-14 00:00:00","dateInserted":"2026-01-15 09:32:45","frontImageName":"DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_J525874512030_F_a1b2c3d4.jpeg","frontImagePath":"https://operations-via-docs-test.s3.us-east-1.amazonaws.com/55012/DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_J525874512030_F_a1b2c3d4.jpeg","backImageName":"DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_J525874512030_B_a1b2c3d4.jpeg","backImagePath":"https://operations-via-docs-test.s3.us-east-1.amazonaws.com/55012/DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_J525874512030_B_a1b2c3d4.jpeg","reviewStatus":"APPROVED","reviewStatusId":1,"rejectionCode":null,"rejectionReason":""},{"documentType":"CC","documentTypeName":"CEDULA CIUDADANIA","documentNumber":"1747777100","documentState":"","documentCountry":"COL","expirationDate":"1900-01-01 00:00:00","dateInserted":"2026-08-03 11:54:09","frontImageName":"DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_1747777100_F_a6d9f89c.jpeg","frontImagePath":"https://operations-via-docs-test.s3.us-east-1.amazonaws.com/55012/DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_1747777100_F_a6d9f89c.jpeg","backImageName":"DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_1747777100_B_a6d9f89c.jpeg","backImagePath":"https://operations-via-docs-test.s3.us-east-1.amazonaws.com/55012/DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_1747777100_B_a6d9f89c.jpeg","reviewStatus":"NOT REVIEWED","reviewStatusId":0,"rejectionCode":null,"rejectionReason":""},{"documentType":"PP","documentTypeName":"PASSPORT","documentNumber":"AB1234567","documentState":"","documentCountry":"USA","expirationDate":"2025-06-30 00:00:00","dateInserted":"2026-05-20 14:12:33","frontImageName":"DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_AB1234567_F_e5f6a7b8.jpeg","frontImagePath":"https://operations-via-docs-test.s3.us-east-1.amazonaws.com/55012/DOCUMENT_7c3f9a21-4b8e-4d12-9f6a-1e2d3c4b5a6f_AB1234567_F_e5f6a7b8.jpeg","backImageName":"","backImagePath":"","reviewStatus":"REJECTED","reviewStatusId":2,"rejectionCode":"EXPIRED_DOC","rejectionReason":"Document is expired. Please upload a valid, non-expired identification."}]}},"key":"default","summary":"Sender found","id":"paths/~1sender/get/responses/200/content/application~1json/examples/default"},"paths/~1sender/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"uuid is required in query parameter","details":"uuid"}]},"key":"default","summary":"Missing uuid","id":"paths/~1sender/get/responses/400/content/application~1json/examples/default"},"paths/~1sender/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1sender/get/responses/401/content/application~1json/examples/default"},"paths/~1sender/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404002,"message":"Sender not found"}]},"key":"default","summary":"Sender not found","id":"paths/~1sender/get/responses/404/content/application~1json/examples/default"},"paths/~1sender/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal error","id":"paths/~1sender/get/responses/500/content/application~1json/examples/default"},"paths/~1sender~1search/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","count":1,"data":[{"uuid":"54d008aa-067d-4341-9cd1-bb2f0705fba6","firstName":"YIRETH","middleName":"","lastName":"GRUESO","secondLastName":"","fullName":"YIRETH GRUESO","phone":"9257810000","addressStreet":"2301 Ruiz Alto, Coral Gables, Fl 33134, Usa, Miami, FL 07008, United states","addressCountry":"USA","currentBranch":"A00765","chainId":"USA0009714"}]},"key":"default","summary":"Senders found","id":"paths/~1sender~1search/get/responses/200/content/application~1json/examples/default"},"paths/~1sender~1search/get/responses/200/content/application~1json/examples/200_empty":{"value":{"status":"success","count":0,"data":[]},"key":"200_empty","summary":"No results found","id":"paths/~1sender~1search/get/responses/200/content/application~1json/examples/200_empty"},"paths/~1sender~1search/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field filterValue is required in query parameter","details":"filterValue"}]},"key":"default","summary":"Missing filterValue","id":"paths/~1sender~1search/get/responses/400/content/application~1json/examples/default"},"paths/~1sender~1search/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1sender~1search/get/responses/401/content/application~1json/examples/default"},"paths/~1sender~1search/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal error","id":"paths/~1sender~1search/get/responses/500/content/application~1json/examples/default"},"paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/savings_code":{"value":{"accountNumber":"987654321","routingNumber":96016930,"accountType":"S"},"key":"savings_code","summary":"Verify a savings account ","description":"Verifies a savings account using the abbreviation S.","id":"paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/savings_code"},"paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/checking_code":{"value":{"accountNumber":"112233445","routingNumber":"021000021","accountType":"C"},"key":"checking_code","summary":"Verify a checking account ","description":"Verifies a checking account using the abbreviation C.","id":"paths/~1service~1account~1verify/post/requestBody/content/application~1json/examples/checking_code"},"paths/~1service~1account~1verify/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"Account number verified successfully","data":{"verificationValue":"Pass","verificationRisk":"LOW","verificationDescription":"The suggested action is to accept the bank account and/or customer data for this inquiry.","bankName":"US BANK NA"}},"key":"default","summary":"Account verified - Pass","id":"paths/~1service~1account~1verify/post/responses/200/content/application~1json/examples/default"},"paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_missing_field":{"value":{"errors":[{"status":"failed","code":400001,"message":"accountNumber is required","details":"accountNumber"}]},"key":"400_missing_field","summary":"Missing required field","id":"paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_missing_field"},"paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_routing":{"value":{"errors":[{"status":"failed","code":400009,"message":"Routing number 123456789 is not a valid ABA routing number (checksum failed)","details":"routingNumber"}]},"key":"400_invalid_routing","summary":"Invalid routing number (checksum failed)","id":"paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_routing"},"paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_account_type":{"value":{"errors":[{"status":"failed","code":400010,"message":"accountType must be one of: C, S","details":"accountType"}]},"key":"400_invalid_account_type","summary":"Invalid account type","id":"paths/~1service~1account~1verify/post/responses/400/content/application~1json/examples/400_invalid_account_type"},"paths/~1service~1account~1verify/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid API key"}]},"key":"default","summary":"Authentication error","id":"paths/~1service~1account~1verify/post/responses/401/content/application~1json/examples/default"},"paths/~1service~1account~1verify/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500002,"message":"Account verification service unavailable","details":"GIACT request failed: Connection timeout"}]},"key":"default","summary":"Service unavailable","id":"paths/~1service~1account~1verify/post/responses/500/content/application~1json/examples/default"},"paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/required_fields":{"value":{"routingNumber":"021000021","countryISO":"USA"},"key":"required_fields","summary":"Routing verification only","description":"Verify a routing number without account verification.","id":"paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/required_fields"},"paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_checking":{"value":{"routingNumber":"021000021","countryISO":"USA","accountNumber":"123456789","accountType":"C"},"key":"with_account_checking","summary":"Routing + Account verification (Checking)","description":"Verify routing number and a checking account in a single request.","id":"paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_checking"},"paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_savings_short":{"value":{"routingNumber":96016930,"countryISO":"USA","accountNumber":"987654321","accountType":"S"},"key":"with_account_savings_short","summary":"Routing + Account verification (Savings)","description":"Verify routing number and a savings account.","id":"paths/~1service~1routing~1verify/post/requestBody/content/application~1json/examples/with_account_savings_short"},"paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_routing_only":{"value":{"status":"success","message":"Routing number verified successfully","data":{"routingNumber":"021000021","bank":"JPMORGAN CHASE","rtp":true,"fednow":true,"aba":true,"wire":true,"ach":true,"active":true}},"key":"200_routing_only","summary":"Routing verified (no account)","id":"paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_routing_only"},"paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_with_account":{"value":{"status":"success","message":"Routing number verified successfully","data":{"routingNumber":"021000021","bank":"JPMORGAN CHASE","rtp":true,"fednow":true,"aba":true,"wire":true,"ach":true,"active":true,"accountVerification":{"verificationValue":"Pass","verificationRisk":"LOW","verificationDescription":"The suggested action is to accept the bank account and/or customer data for this inquiry.","bankName":"JPMORGAN CHASE"}}},"key":"200_with_account","summary":"Routing + Account verified","id":"paths/~1service~1routing~1verify/post/responses/200/content/application~1json/examples/200_with_account"},"paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_checksum":{"value":{"errors":[{"status":"failed","code":400009,"message":"Routing number 123456789 is not a valid ABA routing number (checksum failed)","details":"routingNumber"}]},"key":"400_checksum","summary":"Invalid routing number checksum","id":"paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_checksum"},"paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_missing_account_type":{"value":{"errors":[{"status":"failed","code":400001,"message":"accountType is required when accountNumber is provided","details":"accountType"}]},"key":"400_missing_account_type","summary":"Account type missing when account number provided","id":"paths/~1service~1routing~1verify/post/responses/400/content/application~1json/examples/400_missing_account_type"},"paths/~1service~1routing~1verify/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid API key"}]},"key":"default","summary":"Authentication error","id":"paths/~1service~1routing~1verify/post/responses/401/content/application~1json/examples/default"},"paths/~1service~1routing~1verify/post/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"Routing number 021000021|USA not found.","details":"Routing number 021000021|USA not found."}]},"key":"default","summary":"Routing number not found","id":"paths/~1service~1routing~1verify/post/responses/404/content/application~1json/examples/default"},"paths/~1service~1routing~1verify/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500002,"message":"Account verification service unavailable","details":"GIACT request failed: Connection timeout"}]},"key":"default","summary":"Service unavailable","id":"paths/~1service~1routing~1verify/post/responses/500/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/required_fields":{"value":{"uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","transactionContext":{"cashierId":"CASHIER01"}},"key":"required_fields","summary":"Required fields only","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/required_fields"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/all_fields":{"value":{"uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","transactionContext":{"branchId":"A00765","cashierId":"CASHIER01"},"reasonName":"CAMBIO DE MODALIDAD DE PAGO","reasonId":"1","reasonNotes":"Customer requested a different payout method"},"key":"all_fields","summary":"All fields (including optional)","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/all_fields"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_void_flow":{"value":{"uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","transactionContext":{"branchId":"A00765","cashierId":"CASHIER01"}},"key":"outbound_void_flow","summary":"Outbound — Void flow (branchId starts with A, is_void=true)","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_void_flow"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_cancelation_request":{"value":{"uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","transactionContext":{"branchId":"A00765","cashierId":"CASHIER01"},"reasonName":"CAMBIO DE MODALIDAD DE PAGO","reasonId":"1","reasonNotes":"Customer requested change"},"key":"outbound_cancelation_request","summary":"Outbound — Cancelation Request (branchId starts with A, with reason)","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_cancelation_request"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_orchestrator":{"value":{"uuid":"7c1f0b52-3a9d-4e18-9f5b-2d6a4c8e1b70","transactionContext":{"branchId":"A00765","cashierId":"CASHIER01"},"reasonName":"CAMBIO DE MODALIDAD DE PAGO","reasonId":"1","reasonNotes":"Payer rejected the payout"},"key":"outbound_orchestrator","summary":"Outbound — Orchestrator flow (status DONE or TRANSFERED)","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/outbound_orchestrator"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_cancel":{"value":{"uuid":"b9e59b4a-0540-453a-86ca-cb6efa062b96","transactionContext":{"branchId":"I99984","cashierId":"ADMIN"},"reasonName":"CAMBIO DE BENEFICIARIO","reasonId":"2"},"key":"inbound_cancel","summary":"Inbound — Cancel (branchId starts with I, status I or H)","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_cancel"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_on_hold":{"value":{"uuid":"3f8b2c14-6d5e-4a97-b1c8-9e0f7a35d248","transactionContext":{"branchId":"I99983","cashierId":"ADMIN"},"reasonName":"CAMBIO DE BENEFICIARIO","reasonId":"2","reasonNotes":"Compliance hold released as cancellation"},"key":"inbound_on_hold","summary":"Inbound — Cancel while on hold (id_flag_receiver = H)","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/inbound_on_hold"},"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/cancelation_no_notes":{"value":{"uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","transactionContext":{"cashierId":"CASHIER01"},"reasonName":"CAMBIO DE BENEFICIARIO","reasonId":"2"},"key":"cancelation_no_notes","summary":"Cancelation request without notes","id":"paths/~1transaction~1cancel/delete/requestBody/content/application~1json/examples/cancelation_no_notes"},"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/default":{"value":{"status":"success","transaction_uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","cancelFlow":"void","message":"Transaction voided successfully"},"key":"default","summary":"Outbound — Void flow (branchId starts with A, is_void=true)","id":"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_cancelation_request":{"value":{"status":"success","transaction_uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","cancelFlow":"cancelation-request","message":"Cancelation request submitted"},"key":"200_outbound_cancelation_request","summary":"Outbound — Cancelation Request (branchId starts with A, with reason)","id":"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_cancelation_request"},"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_orchestrator":{"value":{"status":"success","transaction_uuid":"e2459eec-f25d-4450-8776-5b172cc7dc33","cancelFlow":"orchestrator","message":"Cancelation request submitted to orchestrator"},"key":"200_outbound_orchestrator","summary":"Outbound — Orchestrator (status DONE/TRANSFERED)","id":"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_outbound_orchestrator"},"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_inbound_cancel":{"value":{"status":"success","transaction_uuid":"b9e59b4a-0540-453a-86ca-cb6efa062b96","cancelFlow":"cancelation-request","message":"Cancelation request submitted"},"key":"200_inbound_cancel","summary":"Inbound — Cancel (branchId starts with I, status I or H)","id":"paths/~1transaction~1cancel/delete/responses/200/content/application~1json/examples/200_inbound_cancel"},"paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"uuid is required","details":"uuid"}]},"key":"default","summary":"Validation error - missing or invalid required fields, or branch ID validation failed","id":"paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_branch_mismatch":{"value":{"errors":[{"status":"failed","code":400417,"message":"Branch A99999 does not have permission to cancel this transaction"}]},"key":"400_branch_mismatch","summary":"The declared transactionContext.branchId does not own the transaction","id":"paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_branch_mismatch"},"paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_other_partner":{"value":{"errors":[{"status":"failed","code":400000,"message":"Transaction branch I99983 does not belong to this partner"}]},"key":"400_other_partner","summary":"Transaction belongs to another partner","id":"paths/~1transaction~1cancel/delete/responses/400/content/application~1json/examples/400_other_partner"},"paths/~1transaction~1cancel/delete/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication failed - invalid credentials","id":"paths/~1transaction~1cancel/delete/responses/401/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/responses/403/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":403001,"message":"Access to this resource is forbidden for this client.","details":"Your account is not authorized to access this endpoint."}]},"key":"default","summary":"Authorization failed - partner not allowed to access this resource","id":"paths/~1transaction~1cancel/delete/responses/403/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404001,"message":"Transaction not found"}]},"key":"default","summary":"Transaction not found in DynamoDB or SQL Server","id":"paths/~1transaction~1cancel/delete/responses/404/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":422001,"message":"Transaction cannot be cancelled. Current status: PAID"},{"status":"failed","code":422003,"message":"Inbound transaction can only be cancelled when status is I (in process) or H (on hold). Current: T"}]},"key":"default","summary":"Transaction cannot be cancelled due to business rules","id":"paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_duplicate_request":{"value":{"errors":[{"status":"failed","code":422002,"message":"Transaction already has a pending cancellation request"}]},"key":"422_duplicate_request","summary":"A cancellation request already exists","id":"paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_duplicate_request"},"paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_inbound_flag":{"value":{"errors":[{"status":"failed","code":422003,"message":"Inbound transaction can only be cancelled when status is I (in process) or H (on hold). Current: T"}]},"key":"422_inbound_flag","summary":"Inbound: receiver flag not cancellable","id":"paths/~1transaction~1cancel/delete/responses/422/content/application~1json/examples/422_inbound_flag"},"paths/~1transaction~1cancel/delete/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1transaction~1cancel/delete/responses/500/content/application~1json/examples/default"},"paths/~1transaction~1cancel/delete/responses/502/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":502001,"message":"External API error"}]},"key":"default","summary":"External API error during cancellation (ViaOne or Orchestrator)","id":"paths/~1transaction~1cancel/delete/responses/502/content/application~1json/examples/default"},"paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/cash_funding":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"receiptFormat":"html"},"key":"cash_funding","summary":"Confirm cash transaction","description":"Confirms a cash-funded transaction. No funding details required.","id":"paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/cash_funding"},"paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/debit_card_funding":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"receiptFormat":"pdf","transactionInformation":{"funding":{"last4CardNumber":"1234","approvalCode":"ABC123"}}},"key":"debit_card_funding","summary":"Confirm debit card transaction","description":"Confirms a debit card transaction. Requires last4CardNumber and approvalCode.","id":"paths/~1transaction~1confirm/post/requestBody/content/application~1json/examples/debit_card_funding"},"paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"The transaction has been confirmed.","folio":"123456789","transaction_id":"A00765-8","receipt_url":"https://s3.viamericas.io/receipts/eddcf7fb-d2ab-4f4b.html","receipt_html":"<div style=\"font-family:monospace\">VIAMERICAS CORP...</div>"},"key":"default","summary":"Transaction confirmed successfully","id":"paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/default"},"paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/200_already_confirmed":{"value":{"status":"success","message":"The transaction has already been confirmed.","folio":"123456789","transaction_id":"A00765-8","receipt_url":"https://s3.viamericas.io/receipts/eddcf7fb-d2ab-4f4b.html","receipt_html":"<div style=\"font-family:monospace\">VIAMERICAS CORP...</div>"},"key":"200_already_confirmed","summary":"Transaction was already confirmed (idempotent)","id":"paths/~1transaction~1confirm/post/responses/200/content/application~1json/examples/200_already_confirmed"},"paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/default":{"value":{"status":"failed","code":400000,"message":"Invalid JSON format of the request body Expecting ',' delimiter: line 3 column 5 (char 63)"},"key":"default","summary":"Malformed request body","id":"paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/default"},"paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_invalid_branch":{"value":{"status":"failed","code":400416,"message":"The transactionContext.branchId 'XXXXX' is not valid.","details":{"transactionContext.branchId":"XXXXX"}},"key":"400_invalid_branch","summary":"Branch ID not valid for partner","id":"paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_invalid_branch"},"paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_no_permission":{"value":{"status":"failed","code":400417,"message":"The transactionContext.branchId 'A00765' is not have permission to confirm this transaction.","details":{"transactionContext.branchId":"A00765"}},"key":"400_no_permission","summary":"Branch does not own the transaction","id":"paths/~1transaction~1confirm/post/responses/400/content/application~1json/examples/400_no_permission"},"paths/~1transaction~1confirm/post/responses/401/content/application~1json/examples/default":{"value":{"status":"failed","code":401000,"message":"Invalid credentials"},"key":"default","summary":"Invalid authentication credentials","id":"paths/~1transaction~1confirm/post/responses/401/content/application~1json/examples/default"},"paths/~1transaction~1confirm/post/responses/404/content/application~1json/examples/default":{"value":{"status":"failed","code":404000,"message":"Transaction not found.","details":"Transaction eddcf7fb-d2ab-4f4b-9d04-3799304f773c does not exist in DynamoDB."},"key":"default","summary":"Transaction does not exist","id":"paths/~1transaction~1confirm/post/responses/404/content/application~1json/examples/default"},"paths/~1transaction~1confirm/post/responses/422/content/application~1json/examples/default":{"value":{"status":"failed","code":422011,"message":"You are currently not allowed to confirm this transaction."},"key":"default","summary":"Funding type does not allow confirmation","id":"paths/~1transaction~1confirm/post/responses/422/content/application~1json/examples/default"},"paths/~1transaction~1confirm/post/responses/500/content/application~1json/examples/default":{"value":{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."},"key":"default","summary":"Internal server error","id":"paths/~1transaction~1confirm/post/responses/500/content/application~1json/examples/default"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/required_fields":{"value":{"sender":{"firstName":"MARIO","lastName":"LESTER","phone":"3117852691","phoneCountryCode":"+1","email":"sender@example.com","dateOfBirth":"1983-08-25","addressStreet":"1517 W 12 PL, LOS ANGELES, CA, USA","addressState":"US-CA","addressCity":"LOS ANGELES","addressCountry":"USA","addressZipCode":"90015"},"beneficiary":{"firstName":"ANGEL","lastName":"RESTADO","phone":"3057118816","phoneCountryCode":"+57","addressStreet":"Cra 40t N. 13-34, Medellin, Colombia","addressState":"CO-ANT","addressCity":"MEDELLIN","addressCountry":"COL","addressZipCode":"05001"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-CA","originationLocationCity":"LOS ANGELES","originationAmount":100,"originationCurrencyISO":"USD","deliveryCountryISO":"COL","deliveryStateISO":"CO-ANT","deliveryAmountCurrencyISO":"COP","deliveryLocationCode":"T060","deliveryLocationNetwork":"BC0001","deliveryLocationName":"BANCOLOMBIA","deliveryLocationCity":"MEDELLIN","deliveryMode":"C","deliveryModeDetails":{"accountNumber":"24578183503","accountType":"S"},"funding":{"type":"A","accountNumber":"530000000","routingNumber":80}}},"key":"required_fields","summary":"Required fields only","description":"Minimal request with only required fields. Optional fields like KYC, documents, and employer info are omitted.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/required_fields"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/all_fields":{"value":{"client_id":"xxxx123456789","secret_key":"xxxx987654321","sender":{"firstName":"MARLON","middleName":"","lastName":"ARANZA","secondLastName":"","phone":"3888111965","phoneCountryCode":"+52","email":"notificationsviablocks@gmail.com","dateOfBirth":"1987-01-01","addressStreet":"125 Hidalgo, Mezcala, Jalisco 47914, M├⌐xico","addressState":"MX-JAL","addressCity":"MEZCALA","addressCountry":"MEX","addressZipCode":"47914","documentType":"PA","documentDescription":"PASSPORT","documentNumber":"FF01231167855","documentState":"MX-JAL","documentCountry":"MEX","occupation":"DRIVER","employer":"UBER DRIVER","proofOfIncome":"NOT APPLICABLE","ssnNumber":"123456789","industry":7,"job":107,"employerPhone":"5201010101"},"beneficiary":{"firstName":"ANGEL","middleName":"","lastName":"RESTADO","secondLastName":"","phone":"3057118816","phoneCountryCode":"+1","email":"notificationsviablocks@gmail.com","addressStreet":"1450 Brickell Avenue Apt 2908, Miami, FL 33131, USA","addressState":"US-FL","addressCity":"MIAMI","addressCountry":"USA","addressZipCode":"33131","relationShip":"Family","documentType":"CC","documentNumber":"1234567890"},"transactionInformation":{"originationCountryISO":"MEX","originationStateISO":"MX-JAL","originationLocationCity":"MEZCALA","originationAmount":360,"originationCurrencyISO":"MXN","deliveryCountryISO":"USA","deliveryStateISO":"US-FL","deliveryAmountCurrencyISO":"USD","deliveryLocationCode":"T377","deliveryLocationNetwork":"PV0001","deliveryLocationName":"USA BANK DEPOSIT","deliveryLocationCity":"CITY USA BANK","deliveryMode":"C","deliveryModeDetails":{"accountNumber":"5369254747","routingNumber":96016930,"accountType":"S","bank":"USA BANK"},"funding":{"type":"A","accountNumber":"530000000","routingNumber":80},"sourceOfFounds":1,"remittancePurpose":"01","exchangeRate":3827,"fee":1.99,"fundingFee":2,"fixFee":1.99,"otherFees":0,"percentageFee":0,"taxes":0,"viaTasa":0.0555,"couponCode":"WELCOME10","deliveryAmount":3827},"channel":"API","channelMetadata":{"source":"integration-test"}},"key":"all_fields","summary":"All fields (including KYC and optional)","description":"Complete request with all available fields including KYC compliance data, document information, employer details, and channel metadata.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/all_fields"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_with_viatasa":{"value":{"sender":{"firstName":"MARIO","lastName":"LESTER","phone":"3117852691","phoneCountryCode":"+1","email":"sender@example.com","dateOfBirth":"1983-08-25","addressStreet":"1517 W 12 PL, LOS ANGELES, CA, USA","addressState":"US-CA","addressCity":"LOS ANGELES","addressCountry":"USA","addressZipCode":"90015"},"beneficiary":{"firstName":"ANGEL","lastName":"RESTADO","phone":"3057118816","phoneCountryCode":"+57","addressStreet":"Cra 40t N. 13-34, Medellin, Colombia","addressState":"CO-ANT","addressCity":"MEDELLIN","addressCountry":"COL","addressZipCode":"05001","relationShip":"SON"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-FL","originationLocationCity":"MIAMI","originationAmount":300,"originationCurrencyISO":"USD","exchangeRate":3250,"fee":2,"fundingFee":0,"taxes":3,"deliveryCountryISO":"COL","deliveryStateISO":"CO-ANT","deliveryAmountCurrencyISO":"COP","deliveryAmount":975000,"deliveryLocationCode":"T060","deliveryLocationNetwork":"BC0001","deliveryLocationName":"BANCOLOMBIA CASH","deliveryLocationCity":"MEDELLIN","deliveryMode":"P","funding":{"type":"C"}}},"key":"outbound_with_viatasa","summary":"Outbound USA with custom exchange rate (ViaTasa)","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_with_viatasa"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_cash_pickup":{"value":{"sender":{"firstName":"CARLOS","lastName":"MENDEZ","phone":"3051234567","phoneCountryCode":"+1","email":"carlos@example.com","dateOfBirth":"1990-03-15","addressStreet":"200 NW 1st Ave, Miami, FL 33128, USA","addressState":"US-FL","addressCity":"MIAMI","addressCountry":"USA","addressZipCode":"33128"},"beneficiary":{"firstName":"MARIA","lastName":"LOPEZ","phone":"3101234567","phoneCountryCode":"+57","addressStreet":"Calle 10 N 5-20, Bogota, Colombia","addressState":"CO-DC","addressCity":"BOGOTA","addressCountry":"COL","addressZipCode":"11001"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-FL","originationLocationCity":"MIAMI","originationAmount":500,"originationCurrencyISO":"USD","exchangeRate":3316,"fee":2,"fundingFee":0,"taxes":0,"deliveryCountryISO":"COL","deliveryStateISO":"CO-DC","deliveryAmountCurrencyISO":"COP","deliveryAmount":1658000,"deliveryLocationCode":"T060","deliveryLocationNetwork":"BC0001","deliveryLocationName":"BANCOLOMBIA","deliveryLocationCity":"BOGOTA","deliveryMode":"P","funding":{"type":"C"}}},"key":"outbound_cash_pickup","summary":"Outbound USA ΓåÆ COL ΓÇö Cash Pickup with cash funding","description":"Standard cash pickup transaction from USA to Colombia. Funding type C (cash), delivery mode P (cash pickup). No ViaTasa modification.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_cash_pickup"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_bank_deposit_ach":{"value":{"sender":{"firstName":"JOHN","lastName":"SMITH","phone":"7861234567","phoneCountryCode":"+1","email":"john.smith@example.com","dateOfBirth":"1985-07-20","addressStreet":"100 Main St, Orlando, FL 32801, USA","addressState":"US-FL","addressCity":"ORLANDO","addressCountry":"USA","addressZipCode":"32801"},"beneficiary":{"firstName":"PEDRO","lastName":"GARCIA","phone":"3209876543","phoneCountryCode":"+57","addressStreet":"Carrera 7 N 45-12, Cali, Colombia","addressState":"CO-VAC","addressCity":"CALI","addressCountry":"COL","addressZipCode":"76001"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-FL","originationLocationCity":"ORLANDO","originationAmount":200,"originationCurrencyISO":"USD","exchangeRate":3316,"fee":2,"fundingFee":1.5,"taxes":0,"deliveryCountryISO":"COL","deliveryStateISO":"CO-VAC","deliveryAmountCurrencyISO":"COP","deliveryAmount":663200,"deliveryLocationCode":"T060","deliveryLocationNetwork":"BC0001","deliveryLocationName":"BANCOLOMBIA","deliveryLocationCity":"CALI","deliveryMode":"C","deliveryModeDetails":{"accountNumber":"12345678901","accountType":"S"},"funding":{"type":"A","accountNumber":"9876543210","routingNumber":"021000021"}}},"key":"outbound_bank_deposit_ach","summary":"Outbound USA ΓåÆ COL ΓÇö Bank Deposit with ACH funding","description":"Bank deposit transaction with ACH funding (type A). Includes routing number and account number for the funding source. FundingFee applies.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_bank_deposit_ach"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_remote_payment":{"value":{"sender":{"firstName":"LAURA","lastName":"MARTINEZ","phone":"3055551234","phoneCountryCode":"+1","email":"laura@example.com","dateOfBirth":"1992-11-08","addressStreet":"500 Brickell Ave, Miami, FL 33131, USA","addressState":"US-FL","addressCity":"MIAMI","addressCountry":"USA","addressZipCode":"33131"},"beneficiary":{"firstName":"DIANA","lastName":"RAMIREZ","phone":"3157654321","phoneCountryCode":"+57","addressStreet":"Av 68 N 10-50, Medellin, Colombia","addressState":"CO-ANT","addressCity":"MEDELLIN","addressCountry":"COL","addressZipCode":"05001"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-FL","originationLocationCity":"MIAMI","originationAmount":150,"originationCurrencyISO":"USD","exchangeRate":3316,"fee":2,"fundingFee":0,"taxes":0,"deliveryCountryISO":"COL","deliveryStateISO":"CO-ANT","deliveryAmountCurrencyISO":"COP","deliveryAmount":497400,"deliveryLocationCode":"T060","deliveryLocationNetwork":"BC0001","deliveryLocationName":"BANCOLOMBIA","deliveryLocationCity":"MEDELLIN","deliveryMode":"P","funding":{"type":"H"}}},"key":"outbound_remote_payment","summary":"Outbound USA ΓåÆ COL ΓÇö Remote Payment funding (type H)","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_remote_payment"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_debit_card":{"value":{"sender":{"firstName":"ROBERTO","lastName":"HERNANDEZ","phone":"2125551234","phoneCountryCode":"+1","email":"roberto@example.com","dateOfBirth":"1988-02-14","addressStreet":"350 5th Ave, New York, NY 10118, USA","addressState":"US-NY","addressCity":"NEW YORK","addressCountry":"USA","addressZipCode":"10118"},"beneficiary":{"firstName":"GUADALUPE","lastName":"SANCHEZ","phone":"5551234567","phoneCountryCode":"+52","addressStreet":"Av Reforma 100, CDMX, Mexico","addressState":"MX-CMX","addressCity":"CIUDAD DE MEXICO","addressCountry":"MEX","addressZipCode":"06600"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-NY","originationLocationCity":"NEW YORK","originationAmount":400,"originationCurrencyISO":"USD","exchangeRate":18.5,"fee":3,"fundingFee":2,"taxes":0,"deliveryCountryISO":"MEX","deliveryStateISO":"MX-CMX","deliveryAmountCurrencyISO":"MXN","deliveryAmount":7400,"deliveryLocationCode":"T042","deliveryLocationNetwork":"T42037","deliveryLocationName":"ELEKTRA","deliveryLocationCity":"CIUDAD DE MEXICO","deliveryMode":"P","funding":{"type":"D"}}},"key":"outbound_debit_card","summary":"Outbound USA ΓåÆ MEX ΓÇö Debit Card funding (type D)","description":"Transaction with debit card funding (type D). After creation, the transaction requires confirmation via POST /transaction/confirm with approvalCode and last4CardNumber.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_debit_card"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_mobile_wallet":{"value":{"sender":{"firstName":"ANA","lastName":"TORRES","phone":"3055559876","phoneCountryCode":"+1","email":"ana.torres@example.com","dateOfBirth":"1995-06-30","addressStreet":"800 Ocean Dr, Miami Beach, FL 33139, USA","addressState":"US-FL","addressCity":"MIAMI BEACH","addressCountry":"USA","addressZipCode":"33139"},"beneficiary":{"firstName":"SANTIAGO","lastName":"MORALES","phone":"3001234567","phoneCountryCode":"+57","addressStreet":"Calle 80 N 12-30, Barranquilla, Colombia","addressState":"CO-ATL","addressCity":"BARRANQUILLA","addressCountry":"COL","addressZipCode":8001},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-FL","originationLocationCity":"MIAMI BEACH","originationAmount":50,"originationCurrencyISO":"USD","exchangeRate":3316,"fee":2,"fundingFee":0,"taxes":0,"deliveryCountryISO":"COL","deliveryStateISO":"CO-ATL","deliveryAmountCurrencyISO":"COP","deliveryAmount":165800,"deliveryLocationCode":"T060","deliveryLocationNetwork":"NQ0001","deliveryLocationName":"NEQUI","deliveryLocationCity":"BARRANQUILLA","deliveryMode":"O","deliveryModeDetails":{"accountNumber":"3001234567","accountType":"U"},"funding":{"type":"C"}}},"key":"outbound_mobile_wallet","summary":"Outbound USA ΓåÆ COL ΓÇö Mobile Wallet delivery","description":"Transaction with mobile wallet delivery (type O). Requires accountNumber in deliveryModeDetails for the wallet number.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_mobile_wallet"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_pix_brazil":{"value":{"sender":{"firstName":"MICHAEL","lastName":"JOHNSON","phone":"3051112222","phoneCountryCode":"+1","email":"michael.j@example.com","dateOfBirth":"1987-04-12","addressStreet":"1000 NW 57th Ave, Miami, FL 33126, USA","addressState":"US-FL","addressCity":"MIAMI","addressCountry":"USA","addressZipCode":"33126"},"beneficiary":{"firstName":"LUCAS","lastName":"SILVA","phone":"11987654321","phoneCountryCode":"+55","addressStreet":"Rua Augusta 500, Sao Paulo, Brazil","addressState":"BR-SP","addressCity":"SAO PAULO","addressCountry":"BRA","addressZipCode":"01305"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-FL","originationLocationCity":"MIAMI","originationAmount":150,"originationCurrencyISO":"USD","exchangeRate":5.1,"fee":2,"fundingFee":0,"taxes":0,"deliveryCountryISO":"BRA","deliveryStateISO":"BR-SP","deliveryAmountCurrencyISO":"BRL","deliveryAmount":765,"deliveryLocationCode":"BRPIX","deliveryLocationNetwork":"PIX001","deliveryLocationName":"PIX BRAZIL","deliveryLocationCity":"SAO PAULO","deliveryMode":"X","deliveryModeDetails":{"accountNumber":"12345678901"},"funding":{"type":"D"}}},"key":"outbound_pix_brazil","summary":"Outbound USA ΓåÆ BRA ΓÇö PIX instant payment","description":"Transaction with PIX delivery (mode X) to Brazil. Requires CPF document and PIX key in accountNumber.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_pix_brazil"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_upi_india":{"value":{"sender":{"firstName":"DAVID","lastName":"PATEL","phone":"2125559999","phoneCountryCode":"+1","email":"david.patel@example.com","dateOfBirth":"1991-09-25","addressStreet":"42 Broadway, New York, NY 10004, USA","addressState":"US-NY","addressCity":"NEW YORK","addressCountry":"USA","addressZipCode":"10004"},"beneficiary":{"firstName":"PRIYA","lastName":"SHARMA","phone":"9876543210","phoneCountryCode":"+91","addressStreet":"MG Road 45, Bangalore, India","addressState":"IN-KA","addressCity":"BANGALORE","addressCountry":"IND","addressZipCode":"560001"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-NY","originationLocationCity":"NEW YORK","originationAmount":200,"originationCurrencyISO":"USD","exchangeRate":83.5,"fee":3,"fundingFee":0,"taxes":0,"deliveryCountryISO":"IND","deliveryStateISO":"IN-KA","deliveryAmountCurrencyISO":"INR","deliveryAmount":16700,"deliveryLocationCode":"UPI001","deliveryLocationNetwork":"UPI001","deliveryLocationName":"UPI INDIA","deliveryLocationCity":"BANGALORE","deliveryMode":"L","deliveryModeDetails":{"accountNumber":"priya@upi"},"funding":{"type":"U"}}},"key":"outbound_upi_india","summary":"Outbound USA ΓåÆ IND ΓÇö UPI payment","description":"Transaction with UPI delivery (mode L) to India. Requires UPI ID (VPA) in accountNumber.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_upi_india"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_home_delivery":{"value":{"sender":{"firstName":"JOSE","lastName":"RAMIREZ","phone":"7135551234","phoneCountryCode":"+1","email":"jose.r@example.com","dateOfBirth":"1980-12-01","addressStreet":"1200 Travis St, Houston, TX 77002, USA","addressState":"US-TX","addressCity":"HOUSTON","addressCountry":"USA","addressZipCode":"77002"},"beneficiary":{"firstName":"ROSA","lastName":"FLORES","phone":"5553334444","phoneCountryCode":"+52","addressStreet":"Calle Juarez 200, Guadalajara, Mexico","addressState":"MX-JAL","addressCity":"GUADALAJARA","addressCountry":"MEX","addressZipCode":"44100"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-TX","originationLocationCity":"HOUSTON","originationAmount":300,"originationCurrencyISO":"USD","exchangeRate":18.5,"fee":5,"fundingFee":0,"taxes":0,"deliveryCountryISO":"MEX","deliveryStateISO":"MX-JAL","deliveryAmountCurrencyISO":"MXN","deliveryAmount":5550,"deliveryLocationCode":"DLV01","deliveryLocationNetwork":"DLV001AA","deliveryLocationName":"HOME DELIVERY JALISCO","deliveryLocationCity":"GUADALAJARA","deliveryMode":"D","funding":{"type":"C"}}},"key":"outbound_home_delivery","summary":"Outbound USA ΓåÆ MEX ΓÇö Home Delivery (DELIVERY ++ESPEC)","description":"Transaction with home delivery (mode D) to Mexico. Cash delivered directly to the recipient's address.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_home_delivery"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_atm_mexico":{"value":{"sender":{"firstName":"MARIA","lastName":"GONZALEZ","phone":"2145551111","phoneCountryCode":"+1","email":"maria.g@example.com","dateOfBirth":"1985-05-20","addressStreet":"600 Elm St, Dallas, TX 75202, USA","addressState":"US-TX","addressCity":"DALLAS","addressCountry":"USA","addressZipCode":"75202"},"beneficiary":{"firstName":"PEDRO","lastName":"MARTINEZ","phone":"5559998888","phoneCountryCode":"+52","addressStreet":"Av Vallarta 1500, Guadalajara, Mexico","addressState":"MX-JAL","addressCity":"GUADALAJARA","addressCountry":"MEX","addressZipCode":"44160"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-TX","originationLocationCity":"DALLAS","originationAmount":100,"originationCurrencyISO":"USD","exchangeRate":18.5,"fee":3,"fundingFee":0,"taxes":0,"deliveryCountryISO":"MEX","deliveryStateISO":"MX-JAL","deliveryAmountCurrencyISO":"MXN","deliveryAmount":1850,"deliveryLocationCode":"ATM01","deliveryLocationNetwork":"ATM001AA","deliveryLocationName":"CAJERO ELEC BANORTE","deliveryLocationCity":"GUADALAJARA","deliveryMode":"A","funding":{"type":"C"}}},"key":"outbound_atm_mexico","summary":"Outbound USA ΓåÆ MEX ΓÇö ATM withdrawal (CAJERO ELEC.)","description":"Transaction with ATM delivery (mode A) to Mexico. Recipient withdraws cash at an ATM using a reference code.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/outbound_atm_mexico"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_atm":{"value":{"transactionContext":{"branchId":"A00765","cashierId":"CASHIER01"},"sender":{"firstName":"JOHN","lastName":"SMITH","phone":"3055551234","phoneCountryCode":"+1","email":"john.smith@example.com","dateOfBirth":"1985-03-15","addressStreet":"1200 Main St, Miami, FL 33101, USA","addressState":"US-FL","addressCity":"MIAMI","addressCountry":"USA","addressZipCode":"33101","documentType":"DL","documentDescription":"DRIVER'S LICENSE","documentNumber":"D123456789","documentCountry":"USA","occupation":"ENGINEER","employer":"TECH CORP"},"beneficiary":{"firstName":"MARIA","lastName":"GARCIA","phone":"7865559876","phoneCountryCode":"+1","addressStreet":"500 Ocean Drive, Miami Beach, FL 33139, USA","addressState":"US-FL","addressCity":"MIAMI BEACH","addressCountry":"USA","addressZipCode":"33139"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-FL","originationLocationCity":"MIAMI","originationAmount":200,"originationCurrencyISO":"USD","exchangeRate":1,"fee":5.99,"fundingFee":0,"taxes":0,"deliveryCountryISO":"USA","deliveryStateISO":"US-FL","deliveryAmount":200,"deliveryAmountCurrencyISO":"USD","deliveryLocationCode":"T060","deliveryLocationNetwork":"ATM0001","deliveryLocationName":"ATM NETWORK","deliveryLocationCity":"MIAMI BEACH","deliveryMode":"A","funding":{"type":"C"}},"channel":"API"},"key":"domestic_usa_atm","summary":"Domestic USA ΓåÆ USA ΓÇö ATM Network","description":"Domestic transfer within the United States using ATM Network delivery mode (A). The beneficiary withdraws cash at any ATM using a reference code. Both origin and delivery are USA/USD with exchange rate 1.0.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_atm"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_cash_pickup_viamericas":{"value":{"transactionContext":{"branchId":"A00765","cashierId":"CASHIER01"},"sender":{"firstName":"CARLOS","lastName":"MARTINEZ","phone":"2125557890","phoneCountryCode":"+1","email":"carlos.martinez@example.com","dateOfBirth":"1990-07-22","addressStreet":"800 Broadway, New York, NY 10003, USA","addressState":"US-NY","addressCity":"NEW YORK","addressCountry":"USA","addressZipCode":"10003","documentType":"SI","documentDescription":"STATE ISSUED ID","documentNumber":"NY987654321","documentCountry":"USA","occupation":"DRIVER","employer":"DELIVERY CO"},"beneficiary":{"firstName":"ANA","lastName":"RODRIGUEZ","phone":"3235554567","phoneCountryCode":"+1","addressStreet":"1500 Sunset Blvd, Los Angeles, CA 90028, USA","addressState":"US-CA","addressCity":"LOS ANGELES","addressCountry":"USA","addressZipCode":"90028"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-NY","originationLocationCity":"NEW YORK","originationAmount":150,"originationCurrencyISO":"USD","exchangeRate":1,"fee":4.99,"fundingFee":0,"taxes":0,"deliveryCountryISO":"USA","deliveryStateISO":"US-CA","deliveryAmount":150,"deliveryAmountCurrencyISO":"USD","deliveryLocationCode":"V030","deliveryLocationNetwork":"V03001","deliveryLocationName":"VIAMERICAS AGENCY","deliveryLocationCity":"LOS ANGELES","deliveryMode":"P","funding":{"type":"C"}},"channel":"API"},"key":"domestic_usa_cash_pickup_viamericas","summary":"Domestic USA ΓåÆ USA ΓÇö Cash Pickup at Viamericas Agency","description":"Domestic transfer within the United States using Cash Pickup (P) at a Viamericas agency location. The beneficiary picks up cash at an authorized Viamericas agent.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_cash_pickup_viamericas"},"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_bank_deposit":{"value":{"transactionContext":{"branchId":"A00765","cashierId":"CASHIER01"},"sender":{"firstName":"ROBERTO","lastName":"HERNANDEZ","phone":"7135553210","phoneCountryCode":"+1","email":"roberto.h@example.com","dateOfBirth":"1988-11-05","addressStreet":"2200 Main St, Houston, TX 77002, USA","addressState":"US-TX","addressCity":"HOUSTON","addressCountry":"USA","addressZipCode":"77002","documentType":"DL","documentDescription":"DRIVER'S LICENSE","documentNumber":"TX12345678","documentCountry":"USA","occupation":"MECHANIC","employer":"AUTO SHOP INC"},"beneficiary":{"firstName":"LAURA","lastName":"PEREZ","phone":"4155558765","phoneCountryCode":"+1","addressStreet":"900 Market St, San Francisco, CA 94102, USA","addressState":"US-CA","addressCity":"SAN FRANCISCO","addressCountry":"USA","addressZipCode":"94102"},"transactionInformation":{"originationCountryISO":"USA","originationStateISO":"US-TX","originationLocationCity":"HOUSTON","originationAmount":500,"originationCurrencyISO":"USD","exchangeRate":1,"fee":3.99,"fundingFee":2,"taxes":0,"deliveryCountryISO":"USA","deliveryStateISO":"US-CA","deliveryAmount":500,"deliveryAmountCurrencyISO":"USD","deliveryLocationCode":"T060","deliveryLocationNetwork":"BC0001","deliveryLocationName":"BANK OF AMERICA","deliveryLocationCity":"SAN FRANCISCO","deliveryMode":"C","deliveryModeDetails":{"accountNumber":"4567891234","routingNumber":"121000358","accountType":"C","bank":"BANK OF AMERICA"},"funding":{"type":"D"}},"channel":"API"},"key":"domestic_usa_bank_deposit","summary":"Domestic USA ΓåÆ USA ΓÇö Bank Deposit (any U.S. bank)","description":"Domestic transfer within the United States using Bank Deposit (C). Funds are deposited directly to any U.S. bank account. Requires accountNumber, routingNumber, and accountType in deliveryModeDetails.","id":"paths/~1transaction~1create/post/requestBody/content/application~1json/examples/domestic_usa_bank_deposit"},"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"Transaction created successfully","transaction_uuid":"xxxxxx-xxxxx-xxx-xxxx-xxxxx","transaction_id":"xxxxxx-8","folio":"123456789","total_receiver":"46.6200","total_pay_receiver":"46.6200","source_currency_amount":"840.0000","rate":"0.0555","status_track_url":"https://status-track.viamericas.io/?token=xxxxxx-xxxxx-xxx-xxxx-xxxxx","required_document_list":["Copy1ID","DOB","ID"],"document_requirements":[{"type":"Copy1ID","fulfilled":false,"status":"pending","missing":["sender.documentFrontImage"]},{"type":"DOB","fulfilled":true,"status":"completed"},{"type":"ID","fulfilled":true,"status":"completed"}]},"key":"default","summary":"Successful transaction with pending compliance","id":"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/default"},"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_no_compliance":{"value":{"status":"success","message":"Transaction created successfully","transaction_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","transaction_id":"A00765-42","folio":"9876543210","total_receiver":"9500.0000","total_pay_receiver":"9500.0000","source_currency_amount":"500.0000","rate":"19.0000","status_track_url":"https://status-track.viamericas.io/?token=a1b2c3d4-e5f6-7890-abcd-ef1234567890","required_document_list":[],"document_requirements":[]},"key":"200_no_compliance","summary":"Successful transaction ΓÇö no compliance requirements","id":"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_no_compliance"},"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_all_fulfilled_at_creation":{"value":{"status":"success","message":"Transaction created successfully","transaction_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901","transaction_id":"A00765-99","folio":"5566778899","total_receiver":"3043.1000","total_pay_receiver":"9981160.0000","source_currency_amount":"95151.0000","rate":"94.8300","status_track_url":"https://status-track.viamericas.io/?token=b2c3d4e5-f6a7-8901-bcde-f12345678901","required_document_list":["KYC","DOB","ID"],"document_requirements":[{"type":"KYC","fulfilled":true,"status":"completed"},{"type":"DOB","fulfilled":true,"status":"completed"},{"type":"ID","fulfilled":true,"status":"completed"}]},"key":"200_all_fulfilled_at_creation","summary":"Successful transaction ΓÇö all compliance fulfilled at creation","id":"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_all_fulfilled_at_creation"},"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_remote_payment":{"value":{"status":"success","message":"Transaction created successfully","transaction_uuid":"c3d4e5f6-a7b8-9012-cdef-123456789012","transaction_id":"A00765-150","folio":"1122334455","total_receiver":"1850.0000","total_pay_receiver":"1850.0000","source_currency_amount":"103.5000","rate":"18.5000","status_track_url":"https://status-track.viamericas.io/?token=c3d4e5f6-a7b8-9012-cdef-123456789012","payment_url":"https://pay.viamericas.io/checkout/abc123def456","required_document_list":[],"document_requirements":[]},"key":"200_remote_payment","summary":"Successful transaction with remote payment link","id":"paths/~1transaction~1create/post/responses/200/content/application~1json/examples/200_remote_payment"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400000,"message":"Invalid JSON format of the request body Expecting ',' delimiter: line 3 column 5 (char 63)"},{"status":"failed","code":400013,"message":"Field sender.firstName is required","details":"sender.firstName"},{"status":"failed","code":400082,"message":"Field sender.dateOfBirth must have format YYYY-MM-DD","details":"sender.dateOfBirth"},{"status":"failed","code":400046,"message":"Field sender.addressStreet does not match the required pattern","details":"sender.addressStreet"},{"status":"failed","code":400058,"message":"Field sender.addressCountry must have a maximum length of 3","details":"sender.addressCountry"},{"status":"failed","code":400085,"message":"Field sender.addressCountry must be one of: TCD, COL, DOM, COD, GNB, HTI, JAM, MEX, MAR, MOZ, NER, PAK, PHL, TUR, ALB, BOL, CMR, CAF, CRI, ECU, SLV, GHA, GTM, HND, IDN, KEN, KGZ, LBR, MLI, MRT, NIC, NGA, PER, SEN, TZA, THA, AND, ARG, AUS, AUT, AZE, BGD, BEL, BEN, BIH, BRA, BGR, BFA, CAN, CHL, COG, HRV, CYP, CZE, DNK, ERI, EST, SWZ, FIN, FRA, GAB, GMB, GEO, DEU, GIB, GRC, GIN, HKG, HUN, ISL, IND, IRL, ITA, CIV, LVA, LIE, LTU, LUX, MDG, MYS, MLT, MCO, NPL, NLD, NZL, NOR, POL, PRT, ROU, RWA, SMR, SLE, SVK, SVN, KOR, ESP, LKA, SWE, CHE, TGO, UGA, GBR, USA, URY, VNM, ZMB","details":"sender.addressCountry"},{"status":"failed","code":400399,"message":"Field transactionInformation.originationAmount must have at most 2 decimal places","details":"transactionInformation.originationAmount"},{"status":"failed","code":400415,"message":"The routing number 'XXXXXXXXX' is not valid. Please verify that the routing number is correct."}]},"key":"default","summary":"Validation error","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/default"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_mismatch":{"value":{"errors":[{"status":"failed","code":400420,"message":"The fee provided (3.50) does not match the expected fee (2.00). Please request a new quote.","details":{"field":"transactionInformation.fee","provided":3.5,"expected":2}}]},"key":"400_fee_mismatch","summary":"Quote coherence ΓÇö fee does not match pricing","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_mismatch"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_mismatch":{"value":{"errors":[{"status":"failed","code":400418,"message":"The exchangeRate provided (3200.00) does not match the current rate (3316.00). Please request a new quote.","details":{"field":"transactionInformation.exchangeRate","provided":3200,"expected":3316}}]},"key":"400_rate_mismatch","summary":"Quote coherence ΓÇö exchange rate does not match","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_mismatch"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_out_of_range":{"value":{"errors":[{"status":"failed","code":400422,"message":"The exchangeRate provided (3100.00) is outside the allowed range [3249.68, 3382.32]. Please request a new quote.","details":{"field":"transactionInformation.exchangeRate","provided":3100,"minRate":3249.68,"maxRate":3382.32}}]},"key":"400_rate_out_of_range","summary":"Quote coherence ΓÇö exchange rate outside ViaTasa range","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_rate_out_of_range"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_delivery_mismatch":{"value":{"errors":[{"status":"failed","code":400419,"message":"The deliveryAmount (1000000.00) does not match the expected calculation based on originationAmount (300.00) and exchangeRate (3316.00). Expected deliveryAmount: 994800.00.","details":{"field":"transactionInformation.deliveryAmount","provided":1000000,"expected":994800,"originationAmount":300,"exchangeRate":3316}}]},"key":"400_delivery_mismatch","summary":"Quote coherence ΓÇö delivery amount does not match calculation","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_delivery_mismatch"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_funding_fee_required":{"value":{"errors":[{"status":"failed","code":400001,"message":"fundingFee is required. Expected value: 1.50. Please include it from the quote feeBreakdown.","details":{"field":"transactionInformation.fundingFee","expected":1.5}}]},"key":"400_funding_fee_required","summary":"Quote coherence ΓÇö fundingFee is required but missing","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_funding_fee_required"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_taxes_required":{"value":{"errors":[{"status":"failed","code":400001,"message":"taxes is required. Expected value: 3.00. Please include it from the quote feeBreakdown.","details":{"field":"transactionInformation.taxes","expected":3}}]},"key":"400_taxes_required","summary":"Quote coherence ΓÇö taxes is required but missing","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_taxes_required"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_required":{"value":{"errors":[{"status":"failed","code":400001,"message":"fee is required. Expected value: 2.00. Please include it from the quote feeBreakdown.","details":{"field":"transactionInformation.fee","expected":2}}]},"key":"400_fee_required","summary":"Quote coherence ΓÇö fee is required but missing","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_fee_required"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_promo_invalid":{"value":{"errors":[{"status":"failed","code":400050,"message":"The promo code 'EXPIRED10' is not valid or has expired.","details":{"promoCode":"EXPIRED10","reason":"expired"}}]},"key":"400_promo_invalid","summary":"Invalid promo code","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_promo_invalid"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_routing_invalid":{"value":{"errors":[{"status":"failed","code":400415,"message":"The routing number [transactionInformation.funding]:'123456789|USA' is not valid. Please verify that the routing number is correct.","details":{"routingType":"transactionInformation.funding","routingNumber":"123456789"}}]},"key":"400_routing_invalid","summary":"Routing number ABA validation failed (USA only)","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_routing_invalid"},"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_account_high_risk":{"value":{"errors":[{"status":"failed","code":400416,"message":"The account number verification failed for [transactionInformation.funding].","details":{"field":"transactionInformation.funding","routingNumber":"322271627","verificationValue":"Declined","verificationRisk":"HIGH","verificationDescription":"The suggested action is to decline the bank account and/or customer data for this inquiry.","bankName":null}}]},"key":"400_account_high_risk","summary":"Account number verification ΓÇö high risk (USA only)","id":"paths/~1transaction~1create/post/responses/400/content/application~1json/examples/400_account_high_risk"},"paths/~1transaction~1create/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Validation error autorization","id":"paths/~1transaction~1create/post/responses/401/content/application~1json/examples/default"},"paths/~1transaction~1create/post/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404001,"message":"Sender not found"},{"status":"failed","code":404002,"message":"Beneficiary does not belong to this sender"}]},"key":"default","summary":"Validation error not found","id":"paths/~1transaction~1create/post/responses/404/content/application~1json/examples/default"},"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":422001,"message":"The agency credit limit has been exceeded or is insufficient to process this transaction."}]},"key":"default","summary":"Business rule rejection ΓÇö credit limit","id":"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/default"},"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_exceeds_max":{"value":{"errors":[{"status":"failed","code":422010,"message":"The origination amount (9000.0) exceeds the maximum allowed (8000 USD) for outbound transactions."}]},"key":"422_amount_exceeds_max","summary":"Business rule rejection ΓÇö amount exceeds maximum","id":"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_exceeds_max"},"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_below_min":{"value":{"errors":[{"status":"failed","code":422011,"message":"The origination amount (0.5) is below the minimum allowed (1 USD) for outbound transactions."}]},"key":"422_amount_below_min","summary":"Business rule rejection ΓÇö amount below minimum","id":"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_amount_below_min"},"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_compliance_block":{"value":{"errors":[{"status":"failed","code":422003,"message":"Viamericas is unable to process a transaction for this customer/beneficiary"}]},"key":"422_compliance_block","summary":"Business rule rejection ΓÇö compliance block","id":"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_compliance_block"},"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_duplicate_external_id":{"value":{"errors":[{"status":"failed","code":422004,"message":"The externalTransactionId has already been used for another transaction."}]},"key":"422_duplicate_external_id","summary":"Business rule rejection ΓÇö duplicate externalTransactionId","id":"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_duplicate_external_id"},"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_pricing_not_available":{"value":{"errors":[{"status":"failed","code":422006,"message":"Pricing not available for the requested transaction parameters."}]},"key":"422_pricing_not_available","summary":"Business rule rejection ΓÇö pricing not available","id":"paths/~1transaction~1create/post/responses/422/content/application~1json/examples/422_pricing_not_available"},"paths/~1transaction~1create/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Internal server error. We're experiencing technical difficulties. Please try again later."},{"status":"failed","code":500003,"message":"creation transaction"}]},"key":"default","summary":"Validation error","id":"paths/~1transaction~1create/post/responses/500/content/application~1json/examples/default"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/required_fields":{"value":{"originationAmount":100,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"P","deliveryLocationNetwork":"059568AA","fundingType":"C"},"key":"required_fields","summary":"Required fields only","description":"Minimal quote request with only required fields. Uses originationAmount mode.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/required_fields"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/all_fields":{"value":{"originationAmount":500,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"COP","deliveryCountryISO":"COL","deliveryMode":"C","deliveryLocationNetwork":"BC0001","fundingType":"C","promoCode":"VBLOCKS15","receiptFormat":"pdf","transactionContext":{"branchId":"A00765"}},"key":"all_fields","summary":"All fields (including optional)","description":"Complete quote request with every available field: promoCode, receiptFormat, and transactionContext.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/all_fields"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/basic_quote_origination":{"value":{"originationAmount":100,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"P","deliveryLocationNetwork":"059568AA","fundingType":"C"},"key":"basic_quote_origination","summary":"Basic quote by origination amount","description":"Standard quote requesting pricing by amount to send (originationAmount). Most common use case.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/basic_quote_origination"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_by_delivery_amount":{"value":{"deliveryAmount":5000,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"P","deliveryLocationNetwork":"059568AA","fundingType":"C"},"key":"quote_by_delivery_amount","summary":"Quote by delivery amount (reverse calculation)","description":"Quote specifying how much the recipient should receive. The system calculates the origination amount.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_by_delivery_amount"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_bank_deposit_colombia":{"value":{"originationAmount":500,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"COP","deliveryCountryISO":"COL","deliveryMode":"C","deliveryLocationNetwork":"BC0001","fundingType":"U"},"key":"quote_bank_deposit_colombia","summary":"Bank deposit to Colombia","description":"Quote for a bank deposit (mode C) to Colombia with ACH funding.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_bank_deposit_colombia"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_promo_code":{"value":{"originationAmount":500,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"COP","deliveryCountryISO":"COL","deliveryMode":"C","deliveryLocationNetwork":"BC0001","fundingType":"C","promoCode":"VBLOCKS15"},"key":"quote_with_promo_code","summary":"Quote with promotional code","description":"Quote including a promoCode for fee discount. The response will include promoCode validation result and adjusted feeBreakdown.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_promo_code"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_receipt_pdf":{"value":{"originationAmount":200,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"P","deliveryLocationNetwork":"059568AA","fundingType":"C","receiptFormat":"pdf"},"key":"quote_with_receipt_pdf","summary":"Quote with PDF receipt format","description":"Quote requesting a pre-receipt in PDF format (default is HTML).","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_receipt_pdf"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_branch_context":{"value":{"originationAmount":100,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"P","deliveryLocationNetwork":"059568AA","fundingType":"C","transactionContext":{"branchId":"A00765"}},"key":"quote_with_branch_context","summary":"Quote with specific branchId","description":"Quote specifying a transactionContext.branchId to override the default branch resolution from the partner chain.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_with_branch_context"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_paybyphone_funding":{"value":{"originationAmount":300,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"P","deliveryLocationNetwork":"059568AA","fundingType":"H"},"key":"quote_paybyphone_funding","summary":"Quote with PayByPhone funding","description":"Quote using PayByPhone (H) as the funding method, which may affect fee calculation.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_paybyphone_funding"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_mobile_wallet":{"value":{"originationAmount":50,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"COP","deliveryCountryISO":"COL","deliveryMode":"O","deliveryLocationNetwork":"NEQUI01","fundingType":"C"},"key":"quote_mobile_wallet","summary":"Mobile Wallet (M-WALLET) to Colombia","description":"Quote for mobile wallet delivery (mode O) to Colombia.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_mobile_wallet"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_atm_mexico":{"value":{"originationAmount":200,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"A","deliveryLocationNetwork":"ATM001AA","fundingType":"C"},"key":"quote_atm_mexico","summary":"ATM (CAJERO ELEC.) in Mexico","description":"Quote for ATM cash withdrawal (mode A) in Mexico.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_atm_mexico"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_pix_brazil":{"value":{"originationAmount":150,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"BRL","deliveryCountryISO":"BRA","deliveryMode":"X","deliveryLocationNetwork":"PIX001","fundingType":"D"},"key":"quote_pix_brazil","summary":"PIX instant payment to Brazil","description":"Quote for PIX delivery (mode X) to Brazil.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_pix_brazil"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_upi_india":{"value":{"originationAmount":200,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"INR","deliveryCountryISO":"IND","deliveryMode":"L","deliveryLocationNetwork":"UPI001","fundingType":"U"},"key":"quote_upi_india","summary":"UPI payment to India","description":"Quote for UPI delivery (mode L) to India.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_upi_india"},"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_home_delivery":{"value":{"originationAmount":500,"originationCurrencyISO":"USD","deliveryAmountCurrencyISO":"MXN","deliveryCountryISO":"MEX","deliveryMode":"D","deliveryLocationNetwork":"DLV001AA","fundingType":"C"},"key":"quote_home_delivery","summary":"Home Delivery (DELIVERY ++ESPEC) to Mexico","description":"Quote for home delivery (mode D) in Mexico.","id":"paths/~1transaction~1quote/post/requestBody/content/application~1json/examples/quote_home_delivery"},"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","quote":{"quoteTimestamp":"2026-07-10T18:12:14.144357Z","originationAmount":100,"originationCurrencyISO":"USD","deliveryAmount":1850,"deliveryAmountCurrencyISO":"MXN","totalAmount":102.5,"exchangeRate":18.5,"feeBreakdown":{"fee":2,"fundingFee":0.5,"taxes":0,"totalFee":2.5},"deliveryMode":"P","deliveryLocationNetwork":"059568AA","minimumAmount":1,"maximumAmount":8000,"receiptUrl":"https://s3.us-east-1.amazonaws.com/dev-receipts.viamericas.net/fkr94jh2ui.html"}},"key":"default","summary":"Successful quote response (basic)","id":"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/default"},"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_payer_limits":{"value":{"status":"success","quote":{"quoteTimestamp":"2026-07-10T18:12:14.144357Z","originationAmount":500,"originationCurrencyISO":"USD","deliveryAmount":1658000,"deliveryAmountCurrencyISO":"COP","totalAmount":507,"exchangeRate":3316,"feeBreakdown":{"fee":2,"fundingFee":0,"taxes":5,"totalFee":7},"deliveryMode":"C","deliveryLocationNetwork":"BC0001","minimumAmount":1,"maximumAmount":8000,"maximumDeliveryAmount":57000000,"maximumDeliveryAmountCurrency":"COP"}},"key":"200_with_payer_limits","summary":"Successful quote with payer delivery limit","id":"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_payer_limits"},"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_valid":{"value":{"status":"success","quote":{"quoteTimestamp":"2026-07-10T18:12:14.144357Z","originationAmount":500,"originationCurrencyISO":"USD","deliveryAmount":1658000,"deliveryAmountCurrencyISO":"COP","totalAmount":505.8,"exchangeRate":3316,"feeBreakdown":{"fee":2,"fundingFee":0,"taxes":5,"discount":-1.2,"totalFee":5.8},"deliveryMode":"C","deliveryLocationNetwork":"BC0001","minimumAmount":1,"maximumAmount":8000,"promoCode":{"code":"VBLOCKS15","isValid":true,"fixDiscount":1,"percentageDiscount":0.1,"totalDiscount":1.2}}},"key":"200_with_promo_code_valid","summary":"Successful quote with valid promo code applied","id":"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_valid"},"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_invalid":{"value":{"status":"success","quote":{"quoteTimestamp":"2026-07-10T18:12:14.144357Z","originationAmount":500,"originationCurrencyISO":"USD","deliveryAmount":1658000,"deliveryAmountCurrencyISO":"COP","totalAmount":507,"exchangeRate":3316,"feeBreakdown":{"fee":2,"fundingFee":0,"taxes":5,"totalFee":7},"deliveryMode":"C","deliveryLocationNetwork":"BC0001","minimumAmount":1,"maximumAmount":8000,"promoCode":{"code":"EXPIRED99","isValid":false,"reason":"expired","message":"This promotional code has expired."}}},"key":"200_with_promo_code_invalid","summary":"Successful quote with invalid promo code (quote still returned)","id":"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_promo_code_invalid"},"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_viatasa":{"value":{"status":"success","quote":{"quoteTimestamp":"2026-07-10T18:12:14.144357Z","originationAmount":100,"originationCurrencyISO":"USD","deliveryAmount":1870,"deliveryAmountCurrencyISO":"MXN","totalAmount":102.5,"exchangeRate":18.7,"feeBreakdown":{"fee":2,"fundingFee":0.5,"taxes":0,"totalFee":2.5},"deliveryMode":"P","deliveryLocationNetwork":"059568AA","minimumAmount":1,"maximumAmount":8000,"viaTasa":{"originalRate":18.5,"adjustedRate":18.7,"viaTasaAmount":0.2},"rateRange":{"minRate":18.13,"maxRate":18.87}}},"key":"200_with_viatasa","summary":"Successful quote with ViaTasa exchange rate markup","id":"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_viatasa"},"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_warnings":{"value":{"status":"success","quote":{"quoteTimestamp":"2026-07-10T18:12:14.144357Z","originationAmount":7500,"originationCurrencyISO":"USD","deliveryAmount":138750,"deliveryAmountCurrencyISO":"MXN","totalAmount":7502.5,"exchangeRate":18.5,"feeBreakdown":{"fee":2,"fundingFee":0.5,"taxes":0,"totalFee":2.5},"deliveryMode":"P","deliveryLocationNetwork":"059568AA","minimumAmount":1,"maximumAmount":8000,"warnings":[{"code":"PAYER_LIMIT_NOTICE","message":"This transaction exceeds the payer documentation threshold of 50000.00 MXN. Additional documentation may be required.","limit":50000,"currency":"MXN","title":"Documentation threshold"}]}},"key":"200_with_warnings","summary":"Successful quote with non-blocking warnings","id":"paths/~1transaction~1quote/post/responses/200/content/application~1json/examples/200_with_warnings"},"paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field originationCurrencyISO is required","details":"originationCurrencyISO"}]},"key":"default","summary":"Validation error ΓÇö missing required field","id":"paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/default"},"paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_invalid_format":{"value":{"errors":[{"status":"failed","code":400009,"message":"deliveryCountryISO must match pattern ^[A-Z]{3}$","details":"deliveryCountryISO"}]},"key":"400_invalid_format","summary":"Validation error ΓÇö invalid field format","id":"paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_invalid_format"},"paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_not_allowed":{"value":{"errors":[{"status":"failed","code":400010,"message":"deliveryMode must be one of: C, P, O, H","details":"deliveryMode"}]},"key":"400_not_allowed","summary":"Validation error ΓÇö value not in allowed list","id":"paths/~1transaction~1quote/post/responses/400/content/application~1json/examples/400_not_allowed"},"paths/~1transaction~1quote/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1transaction~1quote/post/responses/401/content/application~1json/examples/default"},"paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":422001,"message":"Amount below minimum transaction limit","details":"Minimum amount is 1.00 USD"}]},"key":"default","summary":"Business rule error ΓÇö amount below minimum","id":"paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/default"},"paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_payer_limit_blocking":{"value":{"errors":[{"status":"failed","code":422008,"message":"The transaction amount exceeds the payer limit of 100000.00 MXN.","details":"AMOUNT_EXCEEDS_LIMIT","limit":100000,"currency":"MXN"}]},"key":"422_payer_limit_blocking","summary":"Business rule error ΓÇö amount exceeds blocking payer limit","id":"paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_payer_limit_blocking"},"paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_pricing_unavailable":{"value":{"errors":[{"status":"failed","code":422006,"message":"Pricing not available for requested parameters"}]},"key":"422_pricing_unavailable","summary":"Business rule error ΓÇö pricing not available","id":"paths/~1transaction~1quote/post/responses/422/content/application~1json/examples/422_pricing_unavailable"},"paths/~1transaction~1quote/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1transaction~1quote/post/responses/500/content/application~1json/examples/default"},"paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","message":"The transaction receipt has been successfully generated.","receipt_url":"https://s3.viamericas.io/receipts/eddcf7fb-d2ab-4f4b.html","receipt_html":"<div style=\"font-family:monospace;white-space:pre\">VIAMERICAS CORP\n..."},"key":"default","summary":"Successful receipt generation (HTML)","id":"paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/default"},"paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/200_pdf":{"value":{"status":"success","message":"The transaction receipt has been successfully generated.","receipt_url":"https://s3.viamericas.io/receipts/eddcf7fb-d2ab-4f4b.pdf","receipt_html":"<div style=\"font-family:monospace;white-space:pre\">VIAMERICAS CORP\n..."},"key":"200_pdf","summary":"Successful receipt generation (PDF)","id":"paths/~1transaction~1receipt/get/responses/200/content/application~1json/examples/200_pdf"},"paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/default":{"value":{"status":"failed","code":400000,"message":"Invalid format 'xml'. Allowed values: html, pdf."},"key":"default","summary":"Invalid format parameter","id":"paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/default"},"paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/400_missing_uuid":{"value":{"status":"failed","code":400500,"message":"Field uuid is required","details":"uuid"},"key":"400_missing_uuid","summary":"Missing required UUID","id":"paths/~1transaction~1receipt/get/responses/400/content/application~1json/examples/400_missing_uuid"},"paths/~1transaction~1receipt/get/responses/401/content/application~1json/examples/default":{"value":{"status":"failed","code":401000,"message":"Invalid credentials"},"key":"default","summary":"Invalid authentication credentials","id":"paths/~1transaction~1receipt/get/responses/401/content/application~1json/examples/default"},"paths/~1transaction~1receipt/get/responses/404/content/application~1json/examples/default":{"value":{"status":"failed","code":404000,"message":"Transaction not found.","details":"Transaction eddcf7fb-d2ab-4f4b-9d04-3799304f773c does not exist in DynamoDB."},"key":"default","summary":"Transaction does not exist","id":"paths/~1transaction~1receipt/get/responses/404/content/application~1json/examples/default"},"paths/~1transaction~1receipt/get/responses/422/content/application~1json/examples/default":{"value":{"status":"failed","code":422000,"message":"The receipt cannot be generated. The transaction has not been confirmed."},"key":"default","summary":"Transaction has not been confirmed","id":"paths/~1transaction~1receipt/get/responses/422/content/application~1json/examples/default"},"paths/~1transaction~1receipt/get/responses/500/content/application~1json/examples/default":{"value":{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."},"key":"default","summary":"Internal server error","id":"paths/~1transaction~1receipt/get/responses/500/content/application~1json/examples/default"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/default":{"value":{"transaction_uuid":"xxxxx-xxxx-xxxx-xxxx-xxxxx","transaction_id":"I00123-456789","status_track_url":"https://status-track.viamericas.io/?token=xxxxx-xxxx-xxxx-xxxx-xxxxx","date_created":"07/27/2026 01:45:19 PM","status":"HOLD","folio":"1234567890","source_currency_amount":84000,"source_currency_iso":"MXN","total_receiver":84000,"total_pay_receiver":4662,"currency_receiver_iso":"USD","rate":0.0555,"holds":[{"type":"79","description":"Benef. 30DAY > 8,000 USD"},{"type":"80","description":"10 min Hold/Under processing"}],"required_document_list":["Copy1ID","DOB","ID","KYC"],"document_requirements":[{"type":"KYC","fulfilled":true,"status":"completed"},{"type":"DOB","fulfilled":true,"status":"completed"},{"type":"ID","fulfilled":true,"status":"completed"},{"type":"Copy1ID","fulfilled":true,"status":"in_review"}],"payment_rail":null,"date_available":null,"date_payment":null,"date_transfer":null,"date_cancel":null},"key":"default","summary":"HOLD — Transaction on hold with pending compliance documents","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/default"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_rejected":{"value":{"transaction_uuid":"xxxxx-xxxx-xxxx-xxxx-xxxxx","status_track_url":"https://status-track.viamericas.io/?token=xxxxx-xxxx-xxxx-xxxx-xxxxx","status":"HOLD","folio":"1234567890","source_currency_amount":500,"source_currency_iso":"USD","total_receiver":9500,"total_pay_receiver":9500,"currency_receiver_iso":"MXN","rate":19,"holds":[{"type":"80","description":"10 min Hold/Under processing"}],"required_document_list":["Copy1ID","ID"],"document_requirements":[{"type":"ID","fulfilled":true,"status":"completed"},{"type":"Copy1ID","fulfilled":false,"status":"rejected"}]},"key":"200_id_rejected","summary":"Transaction with rejected ID — re-upload needed","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_rejected"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_all_documents_fulfilled":{"value":{"transaction_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","transaction_id":"I00456-789012","status_track_url":"https://status-track.viamericas.io/?token=a1b2c3d4-e5f6-7890-abcd-ef1234567890","date_created":"07/25/2026 10:30:00 AM","status":"DONE","folio":"9876543210","source_currency_amount":500,"source_currency_iso":"USD","total_receiver":2250000,"total_pay_receiver":2250000,"currency_receiver_iso":"COP","rate":4500,"holds":[],"required_document_list":["KYC","ID"],"document_requirements":[{"type":"KYC","fulfilled":true,"status":"completed"},{"type":"ID","fulfilled":true,"status":"completed"}],"payment_rail":null,"date_available":null,"date_payment":null,"date_transfer":null,"date_cancel":null},"key":"200_all_documents_fulfilled","summary":"Transaction with all required documents fulfilled","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_all_documents_fulfilled"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_sendtobank":{"value":{"transaction_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901","transaction_id":"I00234-567890","status_track_url":"https://status-track.viamericas.io/?token=b2c3d4e5-f6a7-8901-bcde-f12345678901","date_created":"07/26/2026 03:00:00 PM","status":"SENDTOBANK","folio":"2233445566","source_currency_amount":1000,"source_currency_iso":"USD","total_receiver":19000,"total_pay_receiver":19000,"currency_receiver_iso":"MXN","rate":19,"holds":[],"required_document_list":[],"document_requirements":[],"payment_rail":"ACH","date_available":"07/29/2026","date_payment":null,"date_transfer":null,"date_cancel":null},"key":"200_sendtobank","summary":"SENDTOBANK — Transaction sent to bank for processing","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_sendtobank"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_transfered":{"value":{"transaction_uuid":"c3d4e5f6-a7b8-9012-cdef-234567890123","transaction_id":"I00345-678901","status_track_url":"https://status-track.viamericas.io/?token=c3d4e5f6-a7b8-9012-cdef-234567890123","date_created":"07/24/2026 08:00:00 AM","status":"TRANSFERED","folio":"3344556677","source_currency_amount":300,"source_currency_iso":"USD","total_receiver":1350000,"total_pay_receiver":1350000,"currency_receiver_iso":"COP","rate":4500,"holds":[],"required_document_list":[],"document_requirements":[],"payment_rail":"RTP","date_available":"07/24/2026","date_payment":null,"date_transfer":"07/24/2026 09:15:00 AM","date_cancel":null},"key":"200_transfered","summary":"TRANSFERED — Funds transferred to payout network","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_transfered"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_paid":{"value":{"transaction_uuid":"f1e2d3c4-b5a6-9870-fedc-ba0987654321","transaction_id":"I00789-345678","status_track_url":"https://status-track.viamericas.io/?token=f1e2d3c4-b5a6-9870-fedc-ba0987654321","date_created":"07/20/2026 09:15:00 AM","status":"PAID","folio":"5678901234","source_currency_amount":200,"source_currency_iso":"USD","total_receiver":3600,"total_pay_receiver":3600,"currency_receiver_iso":"MXN","rate":18,"holds":[],"required_document_list":[],"document_requirements":[],"payment_rail":"ACH","date_available":"07/22/2026","date_payment":"07/22/2026 11:30:00 AM","date_transfer":"07/20/2026 09:45:00 AM","date_cancel":null},"key":"200_paid","summary":"PAID — Funds paid out to the beneficiary","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_paid"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_in_review":{"value":{"transaction_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status_track_url":"https://status-track.viamericas.io/?token=a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"HOLD","folio":"9876543210","source_currency_amount":1500,"source_currency_iso":"USD","total_receiver":28500,"total_pay_receiver":28500,"currency_receiver_iso":"MXN","rate":19,"holds":[{"type":"80","description":"10 min Hold/Under processing"}],"required_document_list":["Copy1ID","KYC"],"document_requirements":[{"type":"KYC","fulfilled":true,"status":"completed"},{"type":"Copy1ID","fulfilled":true,"status":"in_review"}]},"key":"200_id_in_review","summary":"ID uploaded and under review — no action needed","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_in_review"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_expired":{"value":{"transaction_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901","status_track_url":"https://status-track.viamericas.io/?token=b2c3d4e5-f6a7-8901-bcde-f12345678901","status":"HOLD","folio":"1122334455","source_currency_amount":300,"source_currency_iso":"USD","total_receiver":1200000,"total_pay_receiver":1200000,"currency_receiver_iso":"COP","rate":4000,"holds":[{"type":"80","description":"10 min Hold/Under processing"}],"required_document_list":["Copy1ID"],"document_requirements":[{"type":"Copy1ID","fulfilled":false,"status":"expired"}]},"key":"200_id_expired","summary":"ID expired — re-upload needed","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_id_expired"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_pending_all":{"value":{"transaction_uuid":"c3d4e5f6-a7b8-9012-cdef-123456789012","status_track_url":"https://status-track.viamericas.io/?token=c3d4e5f6-a7b8-9012-cdef-123456789012","status":"HOLD","folio":"5566778899","source_currency_amount":5000,"source_currency_iso":"USD","total_receiver":95000,"total_pay_receiver":95000,"currency_receiver_iso":"MXN","rate":19,"holds":[{"type":"120","description":"Sender 1DAY Anywhere digital > 3,000 USD"}],"required_document_list":["KYC","Copy1ID","DOB","ID"],"document_requirements":[{"type":"KYC","fulfilled":false,"status":"pending"},{"type":"Copy1ID","fulfilled":false,"status":"pending"},{"type":"DOB","fulfilled":true,"status":"completed"},{"type":"ID","fulfilled":false,"status":"pending"}]},"key":"200_pending_all","summary":"New transaction — all documents pending","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_pending_all"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_cancel":{"value":{"transaction_uuid":"d4e5f6a7-b8c9-0123-def0-345678901234","transaction_id":"I00567-890123","status_track_url":"https://status-track.viamericas.io/?token=d4e5f6a7-b8c9-0123-def0-345678901234","date_created":"07/26/2026 02:00:00 PM","status":"CANCEL","folio":"4455667788","source_currency_amount":150,"source_currency_iso":"USD","total_receiver":2850,"total_pay_receiver":2850,"currency_receiver_iso":"MXN","rate":19,"holds":[],"required_document_list":[],"document_requirements":[],"payment_rail":null,"date_available":null,"date_payment":null,"date_transfer":null,"date_cancel":"07/26/2026 04:30:00 PM"},"key":"200_cancel","summary":"CANCEL — Transaction cancelled before completion","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_cancel"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_void":{"value":{"transaction_uuid":"e5f6a7b8-c9d0-1234-ef01-456789012345","transaction_id":"I00678-901234","status_track_url":"https://status-track.viamericas.io/?token=e5f6a7b8-c9d0-1234-ef01-456789012345","date_created":"07/25/2026 11:00:00 AM","status":"VOID","folio":"5566778899","source_currency_amount":50,"source_currency_iso":"USD","total_receiver":950,"total_pay_receiver":950,"currency_receiver_iso":"MXN","rate":19,"holds":[],"required_document_list":[],"document_requirements":[],"payment_rail":null,"date_available":null,"date_payment":null,"date_transfer":null,"date_cancel":"07/25/2026 11:05:00 AM"},"key":"200_void","summary":"VOID — Transaction voided and no longer valid","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_void"},"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_expired":{"value":{"transaction_uuid":"f6a7b8c9-d0e1-2345-f012-567890123456","transaction_id":"I00890-123456","status_track_url":"https://status-track.viamericas.io/?token=f6a7b8c9-d0e1-2345-f012-567890123456","date_created":"07/20/2026 10:00:00 AM","status":"EXPIRED","folio":"6677889900","source_currency_amount":400,"source_currency_iso":"USD","total_receiver":7600,"total_pay_receiver":7600,"currency_receiver_iso":"MXN","rate":19,"holds":[],"required_document_list":[],"document_requirements":[],"payment_rail":null,"date_available":null,"date_payment":null,"date_transfer":null,"date_cancel":null},"key":"200_expired","summary":"EXPIRED — Transaction expired due to time limit","id":"paths/~1transaction~1status/get/responses/200/content/application~1json/examples/200_expired"},"paths/~1transaction~1status/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400000,"message":"Invalid JSON format of the request body Expecting property name enclosed in double quotes: line 6 column 1 (char 191)"},{"status":"failed","code":400500,"message":"Field uuid is required","details":"uuid"}]},"key":"default","summary":"Validation error Invalid","id":"paths/~1transaction~1status/get/responses/400/content/application~1json/examples/default"},"paths/~1transaction~1status/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Validation error autorization","id":"paths/~1transaction~1status/get/responses/401/content/application~1json/examples/default"},"paths/~1transaction~1status/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"Transaction not found."}]},"key":"default","summary":"Validation error not found","id":"paths/~1transaction~1status/get/responses/404/content/application~1json/examples/default"},"paths/~1transaction~1status/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Internal server error. We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Validation error","id":"paths/~1transaction~1status/get/responses/500/content/application~1json/examples/default"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/full_update":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"sender":{"dateOfBirth":"1983-08-25","documentType":"PA","documentNumber":"FF01231167855","documentExpirationDate":"2030-12-31","documentCountry":"USA","documentState":"US-CA","ssnNumber":"123456789","occupation":"DRIVER","employer":"UBER DRIVER","employerPhone":"5201010101","industry":7,"job":107,"documentFrontImage":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL...","documentBackImage":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL..."},"beneficiary":{"firstName":"ANGEL","lastName":"RESTADO","phone":"3057118816","relationShip":"Family"},"transactionInformation":{"deliveryModeDetails":{"accountNumber":"5369254747","routingNumber":96016930,"accountType":"S"},"sourceOfFounds":1,"remittancePurpose":"F"}},"key":"full_update","summary":"Complete update: compliance + ID + modification","description":"Submits compliance data, identification documents, and beneficiary changes in a single request. Demonstrates all three use cases combined.","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/full_update"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/compliance_kyc":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"sender":{"dateOfBirth":"1983-08-25","documentType":"DL","documentNumber":"D1234567","documentExpirationDate":"2028-06-15","documentCountry":"USA","documentState":"US-FL","ssnNumber":"987654321","occupation":"ENGINEER","employer":"TECH CORP","employerPhone":"3051234567","industry":3,"job":45},"beneficiary":{"relationShip":"Friend"},"transactionInformation":{"sourceOfFounds":2,"remittancePurpose":"S"}},"key":"compliance_kyc","summary":"Compliance (KYC) submission only","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/compliance_kyc"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_drivers_license":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"sender":{"documentType":"DL","documentNumber":"D1234567","documentFrontImage":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL...","documentBackImage":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL..."}},"key":"id_upload_drivers_license","summary":"ID upload — Driver's License (front + back required)","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_drivers_license"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_passport":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"sender":{"documentType":"PA","documentNumber":"FF01231167855","documentFrontImage":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL..."}},"key":"id_upload_passport","summary":"ID upload — Passport (front only)","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/id_upload_passport"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/modification":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"beneficiary":{"firstName":"MARIA","lastName":"GONZALEZ","phone":"5551234567","phoneCountryCode":"+52","addressStreet":"2500 Main St, Dallas, TX 75201, USA","addressCity":"DALLAS","addressState":"US-TX","addressCountry":"USA","addressZipCode":"75201"},"transactionInformation":{"deliveryModeDetails":{"accountNumber":"9876543210","routingNumber":"021000021","accountType":"C"},"deliveryStateISO":"US-TX","deliveryLocationCity":"DALLAS"}},"key":"modification","summary":"Beneficiary and delivery modification","description":"Request changes to beneficiary personal information and/or delivery account details. The transaction must be eligible for modification (not already modified or pending). KYC/ID submissions are independent and always allowed.","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/modification"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/dob_only":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"sender":{"dateOfBirth":"1990-05-15"}},"key":"dob_only","summary":"Submit date of birth only (DOB requirement)","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/dob_only"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/ssn_and_sfunds":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"sender":{"ssnNumber":"123456789"},"transactionInformation":{"sourceOfFounds":1}},"key":"ssn_and_sfunds","summary":"Submit SSN and source of funds","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/ssn_and_sfunds"},"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/reupload_rejected_id":{"value":{"uuid":"eddcf7fb-d2ab-4f4b-9d04-3799304f773c","transactionContext":{"branchId":"A00765","cashierId":"TEST.T"},"sender":{"documentType":"DL","documentNumber":"D9876543","documentExpirationDate":"2029-08-20","documentCountry":"USA","documentFrontImage":"data:image/jpeg;base64,/9j/4AAQSkZJRg...","documentBackImage":"data:image/jpeg;base64,/9j/4AAQSkZJRg..."}},"key":"reupload_rejected_id","summary":"Re-upload rejected ID document","id":"paths/~1transaction~1update/put/requestBody/content/application~1json/examples/reupload_rejected_id"},"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_all_operations":{"value":{"status":"success","message":"The transaction has been updated.","transaction_id":"A00765-12345","kyc_updated":true,"id_uploaded":true,"modification_sent":true},"key":"200_all_operations","summary":"All operations successful","id":"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_all_operations"},"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_compliance_only":{"value":{"status":"success","message":"The transaction has been updated.","transaction_id":"A00765-12345","kyc_updated":true},"key":"200_compliance_only","summary":"Compliance data saved","id":"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_compliance_only"},"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_uploaded":{"value":{"status":"success","message":"The transaction has been updated.","transaction_id":"A00765-12345","id_uploaded":true},"key":"200_id_uploaded","summary":"ID document accepted","id":"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_uploaded"},"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_retry_needed":{"value":{"status":"success","message":"The transaction has been updated.","transaction_id":"A00765-12345","id_uploaded":false},"key":"200_id_retry_needed","summary":"ID upload needs retry","id":"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_id_retry_needed"},"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_modification_sent":{"value":{"status":"success","message":"The transaction has been updated.","transaction_id":"A00765-12345","modification_sent":true},"key":"200_modification_sent","summary":"Modification request submitted","id":"paths/~1transaction~1update/put/responses/200/content/application~1json/examples/200_modification_sent"},"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_no_fields":{"value":{"errors":[{"status":"failed","code":400418,"message":"No fields have been provided to update.","details":"sender, beneficiary or transactionInformation must contain at least one field to update."}]},"key":"400_no_fields","summary":"No fields provided","id":"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_no_fields"},"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_compliance_fields_missing":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field sender.documentType is required for KYC compliance","details":"sender.documentType"},{"status":"failed","code":400001,"message":"Field sender.dateOfBirth is required for KYC compliance","details":"sender.dateOfBirth"}]},"key":"400_compliance_fields_missing","summary":"Required compliance fields missing","id":"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_compliance_fields_missing"},"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_fields_missing":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field sender.documentFrontImage is required for Copy1ID compliance","details":"sender.documentFrontImage"}]},"key":"400_id_fields_missing","summary":"Required ID fields missing","id":"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_fields_missing"},"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_back_image_required":{"value":{"errors":[{"status":"failed","code":400001,"message":"backImage is required for this document type and country"}]},"key":"400_id_back_image_required","summary":"Back image required for this document type","id":"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_back_image_required"},"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_rejected_reupload":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field sender.documentFrontImage is required for Copy1ID compliance (Your previous ID document was rejected. Please upload a new, valid document.)","details":"sender.documentFrontImage","reason":"rejected"}]},"key":"400_id_rejected_reupload","summary":"ID was rejected — re-upload required","id":"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_rejected_reupload"},"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_expired_reupload":{"value":{"errors":[{"status":"failed","code":400001,"message":"Field sender.documentFrontImage is required for Copy1ID compliance (Your ID document has expired. Please upload a current, non-expired document.)","details":"sender.documentFrontImage","reason":"expired"}]},"key":"400_id_expired_reupload","summary":"ID has expired — re-upload required","id":"paths/~1transaction~1update/put/responses/400/content/application~1json/examples/400_id_expired_reupload"},"paths/~1transaction~1update/put/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Invalid credentials","id":"paths/~1transaction~1update/put/responses/401/content/application~1json/examples/default"},"paths/~1transaction~1update/put/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"Transaction not found.","details":"Transaction eddcf7fb-d2ab-4f4b-9d04-3799304f773c does not exist."}]},"key":"default","summary":"Transaction not found","id":"paths/~1transaction~1update/put/responses/404/content/application~1json/examples/default"},"paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_cancelled":{"value":{"errors":[{"status":"failed","code":422014,"message":"The transaction cannot be modified due to its current status."}]},"key":"422_cancelled","summary":"Transaction cancelled or paid","id":"paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_cancelled"},"paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_not_eligible":{"value":{"errors":[{"status":"failed","code":422012,"message":"The transaction is not available for modification."}]},"key":"422_not_eligible","summary":"Not eligible for modification","id":"paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_not_eligible"},"paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_already_modified":{"value":{"errors":[{"status":"failed","code":422013,"message":"The transaction has a modification request in process or has already been modified."}]},"key":"422_already_modified","summary":"Modification already in progress","id":"paths/~1transaction~1update/put/responses/422/content/application~1json/examples/422_already_modified"},"paths/~1transaction~1update/put/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal error","id":"paths/~1transaction~1update/put/responses/500/content/application~1json/examples/default"},"paths/~1webhook/post/requestBody/content/application~1json/examples/all_branches_all_events":{"value":{"url":"https://partner.example.com/webhooks/viablocks"},"key":"all_branches_all_events","summary":"Register for all branches and all events (defaults)","description":"Register a webhook URL without specifying branches or events. Defaults to all branches and all event types.","id":"paths/~1webhook/post/requestBody/content/application~1json/examples/all_branches_all_events"},"paths/~1webhook/post/requestBody/content/application~1json/examples/specific_branches":{"value":{"url":"https://partner.example.com/webhooks/viablocks","events":["transaction.status.all"],"branches":["A00765","A00766"]},"key":"specific_branches","summary":"Register for specific branches only","description":"Register a webhook URL that only receives notifications for transactions from branches A00765 and A00766.","id":"paths/~1webhook/post/requestBody/content/application~1json/examples/specific_branches"},"paths/~1webhook/post/requestBody/content/application~1json/examples/specific_events_all_branches":{"value":{"url":"https://partner.example.com/webhooks/viablocks","events":["transaction.status.paid","transaction.status.cancelled"],"branches":["all"]},"key":"specific_events_all_branches","summary":"Register with specific events for all branches","description":"Subscribe to only paid and cancelled events across all branches of the partner.","id":"paths/~1webhook/post/requestBody/content/application~1json/examples/specific_events_all_branches"},"paths/~1webhook/post/requestBody/content/application~1json/examples/single_branch_specific_events":{"value":{"url":"https://partner.example.com/webhooks/viablocks","events":["transaction.status.paid"],"branches":["A00765"]},"key":"single_branch_specific_events","summary":"Single branch with specific events","description":"Only receive notifications for paid transactions from branch A00765.","id":"paths/~1webhook/post/requestBody/content/application~1json/examples/single_branch_specific_events"},"paths/~1webhook/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","webhook_url":"https://partner.example.com/webhooks/viablocks","events":["transaction.status.all"],"webhook_secret":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","active":true,"created_at":"2025-01-15T10:30:00Z","message":"Webhook registered successfully"}},"key":"default","summary":"Successful registration","id":"paths/~1webhook/post/responses/200/content/application~1json/examples/default"},"paths/~1webhook/post/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"URL must use HTTPS scheme and not exceed 2048 characters","details":"url"}]},"key":"default","summary":"Validation error - invalid URL","id":"paths/~1webhook/post/responses/400/content/application~1json/examples/default"},"paths/~1webhook/post/responses/400/content/application~1json/examples/400_invalid_branches":{"value":{"errors":[{"status":"failed","code":400001,"message":"Invalid branches for this partner: ZZZZ, B99999"}]},"key":"400_invalid_branches","summary":"Validation error - invalid branches","id":"paths/~1webhook/post/responses/400/content/application~1json/examples/400_invalid_branches"},"paths/~1webhook/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1webhook/post/responses/401/content/application~1json/examples/default"},"paths/~1webhook/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Internal server error. We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1webhook/post/responses/500/content/application~1json/examples/default"},"paths/~1webhook/delete/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","url":"https://partner.example.com/hooks","events":["transaction.status.all"],"branches":["all"],"active":false,"created_at":"2025-01-15T10:30:00Z","updated_at":"2025-01-16T08:15:00Z"}},"key":"default","summary":"Webhook deactivated","id":"paths/~1webhook/delete/responses/200/content/application~1json/examples/default"},"paths/~1webhook/delete/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"webhook_id query parameter is required to deactivate a webhook."}]},"key":"default","summary":"Missing webhook_id","id":"paths/~1webhook/delete/responses/400/content/application~1json/examples/default"},"paths/~1webhook/delete/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No webhook configuration found for this partner."}]},"key":"default","summary":"Not found","id":"paths/~1webhook/delete/responses/404/content/application~1json/examples/default"},"paths/~1webhook/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":[{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","url":"https://partner.example.com/hooks","events":["transaction.status.all"],"branches":["all"],"active":true,"created_at":"2025-01-15T10:30:00Z","updated_at":"2025-01-15T10:30:00Z"}]},"key":"default","summary":"List all webhooks","id":"paths/~1webhook/get/responses/200/content/application~1json/examples/default"},"paths/~1webhook/get/responses/200/content/application~1json/examples/200_single":{"value":{"status":"success","data":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","url":"https://partner.example.com/hooks","events":["transaction.status.paid"],"branches":["A00765"],"active":true,"created_at":"2025-01-15T10:30:00Z","updated_at":"2025-01-15T10:30:00Z"}},"key":"200_single","summary":"Get one webhook","id":"paths/~1webhook/get/responses/200/content/application~1json/examples/200_single"},"paths/~1webhook/get/responses/200/content/application~1json/examples/200_empty":{"value":{"status":"success","data":[]},"key":"200_empty","summary":"No webhooks","id":"paths/~1webhook/get/responses/200/content/application~1json/examples/200_empty"},"paths/~1webhook/get/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No webhook configuration found with that webhook_id."}]},"key":"default","summary":"Not found","id":"paths/~1webhook/get/responses/404/content/application~1json/examples/default"},"paths/~1webhook/put/requestBody/content/application~1json/examples/update_events":{"value":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","events":["transaction.status.paid","transaction.status.cancelled","transaction.status.onHold"],"active":true},"key":"update_events","summary":"Update subscribed events and activate","description":"Change the subscribed event types and re-activate the webhook.","id":"paths/~1webhook/put/requestBody/content/application~1json/examples/update_events"},"paths/~1webhook/put/requestBody/content/application~1json/examples/update_url":{"value":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","url":"https://new-endpoint.partner.com/hooks/viablocks"},"key":"update_url","summary":"Change webhook URL (triggers secret regeneration)","id":"paths/~1webhook/put/requestBody/content/application~1json/examples/update_url"},"paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_specific":{"value":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","branches":["A00765","A00766"]},"key":"update_branches_specific","summary":"Restrict to specific branches","description":"Change the webhook to only receive notifications from branches A00765 and A00766.","id":"paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_specific"},"paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_all":{"value":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","branches":["all"]},"key":"update_branches_all","summary":"Enable for all branches","description":"Change the webhook to receive notifications from all branches of the partner.","id":"paths/~1webhook/put/requestBody/content/application~1json/examples/update_branches_all"},"paths/~1webhook/put/requestBody/content/application~1json/examples/deactivate":{"value":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","active":false},"key":"deactivate","summary":"Temporarily deactivate webhook","description":"Set active to false to pause notifications without removing the registration.","id":"paths/~1webhook/put/requestBody/content/application~1json/examples/deactivate"},"paths/~1webhook/put/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":{"url":"https://partner.example.com/webhooks/viablocks","events":["transaction.status.paid","transaction.status.cancelled","transaction.status.onHold"],"branches":["A00765","A00766"],"active":true,"created_at":"2025-01-15T10:30:00Z","updated_at":"2025-01-16T08:15:00Z"}},"key":"default","summary":"Successful update","id":"paths/~1webhook/put/responses/200/content/application~1json/examples/default"},"paths/~1webhook/put/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400009,"message":"URL must use HTTPS scheme","details":"url"}]},"key":"default","summary":"Validation error - invalid URL","id":"paths/~1webhook/put/responses/400/content/application~1json/examples/default"},"paths/~1webhook/put/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1webhook/put/responses/401/content/application~1json/examples/default"},"paths/~1webhook/put/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No webhook configuration found for this partner"}]},"key":"default","summary":"No webhook configuration found","id":"paths/~1webhook/put/responses/404/content/application~1json/examples/default"},"paths/~1webhook/put/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Internal server error. We're experiencing technical difficulties. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1webhook/put/responses/500/content/application~1json/examples/default"},"paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":[{"event_id":"550e8400-e29b-41d4-a716-446655440000","transaction_uuid":"4ed19e29-5a6a-433d-908d-23377fabb617","event_type":"transaction.status.paid","timestamp":"2025-01-15T10:30:05Z","http_status_code":200,"response_time_ms":150,"attempt_number":1,"delivery_status":"success","failure_reason":null},{"event_id":"660f9511-f30c-52e5-b827-557766551111","transaction_uuid":"5fe2af3a-6b7b-544e-a19e-34488gbc7728","event_type":"transaction.status.onHold","timestamp":"2025-01-15T10:28:30Z","http_status_code":500,"response_time_ms":2300,"attempt_number":1,"delivery_status":"failed","failure_reason":"http_status_500"}]},"key":"default","summary":"Successful response with delivery records","id":"paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/default"},"paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/200_empty":{"value":{"status":"success","data":[]},"key":"200_empty","summary":"No delivery records found","id":"paths/~1webhook~1deliveries/get/responses/200/content/application~1json/examples/200_empty"},"paths/~1webhook~1deliveries/get/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"Invalid transaction_uuid format. Must be a valid UUID (lowercase hex)."}]},"key":"default","summary":"Invalid transaction_uuid format","id":"paths/~1webhook~1deliveries/get/responses/400/content/application~1json/examples/default"},"paths/~1webhook~1deliveries/get/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1webhook~1deliveries/get/responses/401/content/application~1json/examples/default"},"paths/~1webhook~1deliveries/get/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Failed to retrieve delivery history. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1webhook~1deliveries/get/responses/500/content/application~1json/examples/default"},"paths/~1webhook~1rotate-secret/post/requestBody/content/application~1json/examples/rotate_secret":{"value":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"key":"rotate_secret","summary":"Rotate webhook secret","id":"paths/~1webhook~1rotate-secret/post/requestBody/content/application~1json/examples/rotate_secret"},"paths/~1webhook~1rotate-secret/post/responses/200/content/application~1json/examples/default":{"value":{"status":"success","data":{"webhook_secret":"b3f8a2d1e7c9b0f4a6d8e2c1b5f7a3d9e1c4b8f2a6d0e3c7b9f5a1d4e8c2b6f0","grace_period_expires_at":"2025-01-16T10:30:00+00:00","message":"Webhook secret rotated successfully"}},"key":"default","summary":"Successful rotation","id":"paths/~1webhook~1rotate-secret/post/responses/200/content/application~1json/examples/default"},"paths/~1webhook~1rotate-secret/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1webhook~1rotate-secret/post/responses/401/content/application~1json/examples/default"},"paths/~1webhook~1rotate-secret/post/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No webhook configuration found for this partner."}]},"key":"default","summary":"No webhook registration found","id":"paths/~1webhook~1rotate-secret/post/responses/404/content/application~1json/examples/default"},"paths/~1webhook~1rotate-secret/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Failed to rotate webhook secret. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1webhook~1rotate-secret/post/responses/500/content/application~1json/examples/default"},"paths/~1webhook~1test/post/requestBody/content/application~1json/examples/send_test":{"value":{"webhook_id":"f47ac10b-58cc-4372-a567-0e02b2c3d479"},"key":"send_test","summary":"Send test delivery","id":"paths/~1webhook~1test/post/requestBody/content/application~1json/examples/send_test"},"paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_success":{"value":{"status":"success","data":{"test_event_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","delivery_status":"success","http_status_code":200,"response_time_ms":145,"failure_reason":null,"webhook_url":"https://partner.example.com/webhooks/viablocks","signature_header":"sha256=a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"}},"key":"200_success","summary":"Test delivery successful","id":"paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_success"},"paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_failed":{"value":{"status":"success","data":{"test_event_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","delivery_status":"failed","http_status_code":500,"response_time_ms":2300,"failure_reason":"http_status_500","webhook_url":"https://partner.example.com/webhooks/viablocks","signature_header":"sha256=a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"}},"key":"200_failed","summary":"Test delivery failed (endpoint returned error)","id":"paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_failed"},"paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_timeout":{"value":{"status":"success","data":{"test_event_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","delivery_status":"failed","http_status_code":null,"response_time_ms":5000,"failure_reason":"connection_timeout","webhook_url":"https://partner.example.com/webhooks/viablocks","signature_header":"sha256=a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"}},"key":"200_timeout","summary":"Test delivery failed (connection timeout)","id":"paths/~1webhook~1test/post/responses/200/content/application~1json/examples/200_timeout"},"paths/~1webhook~1test/post/responses/400/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":400001,"message":"Webhook is inactive. Activate the webhook before sending a test delivery."}]},"key":"default","summary":"Webhook inactive or missing secret","id":"paths/~1webhook~1test/post/responses/400/content/application~1json/examples/default"},"paths/~1webhook~1test/post/responses/400/content/application~1json/examples/400_no_secret":{"value":{"errors":[{"status":"failed","code":400001,"message":"Webhook does not have a signing secret configured. Re-register or rotate the secret."}]},"key":"400_no_secret","summary":"Webhook missing signing secret","id":"paths/~1webhook~1test/post/responses/400/content/application~1json/examples/400_no_secret"},"paths/~1webhook~1test/post/responses/401/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":401000,"message":"Invalid credentials"}]},"key":"default","summary":"Authentication error","id":"paths/~1webhook~1test/post/responses/401/content/application~1json/examples/default"},"paths/~1webhook~1test/post/responses/404/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":404000,"message":"No webhook found for the given webhook_id."}]},"key":"default","summary":"Webhook not found","id":"paths/~1webhook~1test/post/responses/404/content/application~1json/examples/default"},"paths/~1webhook~1test/post/responses/500/content/application~1json/examples/default":{"value":{"errors":[{"status":"failed","code":500000,"message":"Failed to send test delivery. Please try again later."}]},"key":"default","summary":"Internal server error","id":"paths/~1webhook~1test/post/responses/500/content/application~1json/examples/default"}},"securitySchemeStore":{},"servers":[{"url":"https://sandbox-viablocks.viamericas.io","description":"Sandbox environment"}]},"options":{"hideDownloadButtons":true,"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/outbound.json?download"},{"url":"/_bundle/apis/outbound.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview","description":"<div style='text-align:center'><img src='/images/logo_viamericas.png' width='60&#37'/></div>\n\nViaBlocks API Outbound is a secure, server-to-server REST API that enables regulated partners to create, manage, and track **outbound cross-border money transfers from the United States to international destinations** through the Viamericas network.\n\nThe API supports the full outbound transaction lifecycle, including U.S.-based sender onboarding, international beneficiary onboarding, transaction creation, funding initiation, foreign exchange (FX) handling, payout execution, and end-to-end status monitoring.\n\nPartners interact with the platform through two primary endpoints:\n\n- **POST /transaction/create** — used to submit sender, beneficiary, and transfer details to initiate an outbound transaction.\n- **POST /transaction/status** — used to retrieve the most recent processing status and lifecycle updates for an existing transaction.\n\nThis API is designed for licensed and compliant U.S. partners and abstracts regulatory, compliance, routing, and payout complexities, allowing integrators to focus on building scalable international money transfer experiences.\n"}},"baseSlug":"/apis/outbound","routesMapping":{}}