{"openapi":"3.1.0","info":{"title":"QR+ Service Provider Registry API","version":"1.2.0","description":"The Paylink Registry service is used by Service Providers to manage their QR+ services and as an authoritative reference to build local, cached service registries for use during QR+ enrichment flows.\n\nThe high level entity relationships exposed by this interface are:\n\n\n\nThe api exposes the following perspectives:\n\n- **Service Administration:** The `/profile` endpoints expose functionality for an authorized user to administer Service Provider services. This includes setting up Authorization Authorities and linking these authorities to Payer- and Payee- services.\n- **Service Registry:** The `/service-providers` and `/flow-types` endpoints expose a registry of all service providers and registered services. This enables service provider infrastructure to create local mapping tables to derive host location and authorization authorities during QR+ flows.\n","x-logo":{"url":"https://imagedelivery.net/ipmJ55bBDVfBJxiG3wVbtg/c6121c60-dcc9-4bf5-f7d1-72b607507c00/public"}},"servers":[{"url":"http://localhost:3000"}],"tags":[{"name":"Copyright and Liability Disclaimer","description":"\nFull Copyright and Liability Disclaimer
\n\nThe QR+ Standard has been developed by the South African Reserve Bank for use by participants in the National Payment System. All intellectual property rights, including copyright and any related rights in and to the QR+ Standard, are owned by, or vest in, the South African Reserve Bank. No participant or other person acquires any ownership right, title or interest in the QR+ Standard by virtue of its access to, implementation of or use of the QR+ Standard. The QR+ Standard may not be copied, reproduced, adapted, amended, transferred, ceded, assigned, sublicensed, published, distributed or otherwise made available to any third party, in whole or in part, without the prior written consent of the South African Reserve Bank, except to the extent expressly permitted by the South African Reserve Bank.\n\nParticipants are responsible for developing, implementing, maintaining and operating their own systems, processes and controls to ensure compliance with the QR+ Standard and with all applicable laws, regulatory requirements and industry standards. The South African Reserve Bank does not warrant that the QR+ Standard, or any implementation thereof by a participant, will be error-free, uninterrupted, fit for any particular purpose or suitable for any participant’s specific operational or commercial requirements.\n\nTo the fullest extent permitted by law, the South African Reserve Bank shall not be liable for any loss, damage, claim, cost or expense, whether direct, indirect, special, incidental or consequential, arising from or in connection with a participant’s access to, reliance on, implementation of, or use of the QR+ Standard, including any failure by a participant to comply with the QR+ Standard or any applicable legal or regulatory requirement.\n\n \n"},{"name":"Version Comments","description":"\n Version: 1.2.0 (2026-06-05)
\n\nRelease candidate 1.2.0-rc3 approved for publication\n\n \n"},{"name":"Profile - Services","description":"As a Service Provider, use these endpoints to manage your services.\n"},{"name":"Profile - Authorization Authorities","description":"As a Service Provider, use these endpoints to manage your authorization authorities.\n"},{"name":"Service Provider Registry","description":"Use the `/service-providers` endpoints to discover the owners of services.\n"},{"name":"Services Registry","description":"Use these endpoints to create a local cache of QR+ services.\n\n### For Payer Service Providers (PrSP)\n\nAs PrSP you will create a local Registry Cache to:\n\n- Do a lookup to find the PeSP service host address corresponding to the spIndicator extracted from a scanned Paylink\n- Authenticate PeSP calls to your API and confirm their rights to execute specific QR+ flow types.\n\n**Building Payee Services Registry:**\n\n1. Get flow types: `GET /flow-types`\n2. Retrieve all services by:\n 1. Either, retrieving the service list by flow type `GET /flow-types/{flowType}/payee-services` and then, for each service, doing `GET /flow-types/{flowType}/payee-services/{serviceId}`\n 2. Or, downloading the full registry `GET /flow-types/{flowType}/payee-registry-cache`\n3. Build a local cache for:\n 1. Paylink service provider host resolution `(encoding, flowTypeIndicator, spIndicator) → {host}`\n 2. JWT validation `(iss, sub, aud) → {authzAuthority keys}`\n\n### For Payee Service Providers (PeSP)\n\nAs a PeSP you will create a local Payer Services Registry to:\n\n- Do a lookup to find the PrSP service host address corresponding to the spIndicator extracted from a scanned Paylink\n- Authenticate PrSP calls to your API and confirm their rights to execute specific QR+ flow types.\n\n**Building Payer Services Registry:**\n\n1. Get flow types: `GET /flow-types`\n2. Retrieve all services by:\n 1. Either, retrieving the service list by flow type `GET /flow-types/{flowType}/payer-services` and then, for each service, doing `GET /flow-types/{flowType}/payer-services/{serviceId}`\n 2. Or, downloading the full registry `GET /flow-types/{flowType}/payer-registry-cache`\n3. Build a local cache for:\n 1. Paylink service provider host resolution `(encoding, flowTypeIndicator, spIndicator) → {host}`\n 2. JWT validation `(iss, sub, aud) → {authzAuthority keys}`\n"},{"name":"Implementation Requirements","description":"### Registry Cache Refresh\n\nA key responsibility of the QR+ Registry is to enable Clients to refresh their local Registry Cache.\n\n- Clients MUST NOT initiate a cache refresh request more than once in any 30 minute period\n- Clients SHOULD initiate a cache refresh request every 3 hours\n- Clients MUST initiate a cache refresh request at least once every 24 hours. If a Client has not executed a successful cache refresh request within this period, it should consider the cache stale and NOT execute QR+ flows using the configuration data.\n\n#### Registry Config Data Migration\n\nClient implementations of the Registry API must take care to assure system configuration integrity over the cache refresh cycles described above. All configuration changes must assure secure and functional operation of all current Registry Cache versions. To achieve this:\n\n- When updating the service `host` address, the service MUST be available at both old and new address for the next 24 hours\n- When associating a new Authorization Authority public key with a service (either by linking a Authorization Authority to a service or by adding a new key) the key MUST only enter use 24 hours after the update\n- When deploying a new Authorization Authority key for authentication, the related public key MUST be associated with the service for at least 24 hours.\n- When disassociating an Authorization Authority public key from a service (either by unlinking a Authorization Authority from a service or by deleting a key) the key MUST NOT be in use and the alternative MUST have been configured for at least 24 hours\n\n### Bearer Token Validation\n\nThis API uses a JWT based (RFC7519), http bearer token security scheme. The JWT MUST be signed by an authorization authority registered to the QR+ Registry against a Service Provider profile. The API user identity is derived from the JWT issuer and key id.\n\n### JWT claims\n\nThe JWT MUST contain the following Claims:\n\n- `iss` : Issuer Claim containing the `authzAuthorityId` as allocated by the QR+ Registry\n- `sub` : The Service Provider's `spId` as allocated by the QR+ Registry.\n- `aud` : Audience Claim containing the value `registry`\n- `exp` : Expiration time Claim defining a time of expiry for this token\n- `permissions` : An array of permissions for authorization from:\n - `view:profile` - Can view SP registry profile,\n - `update:profile` - Can update SP registry profile,\n - `view:registry` - Can view registry and build local cache\n\n### JWT header\n\nThe JWT header must contain the following parameters:\n\n- `alg` : The JOSE algorithm used for JWT generation\n- `kid` : The key id of the authorization authority key used to generate the JWT\n\n### JWT Validation\n\nImplementers of this API must satisfy the following minimum requirements when validating a presented JWT:\n\n- **Best Practice:** Follow best practices as outlined in RFC8725 and related standards\n- **User Identity:** The API user identity MUST be determined as the Service Provider (`sub`) only when (i) the Issuer claim (`iss`) matches an Authorization Authority belonging to the Service Provider and (ii) The key id of the key used is linked to the Authorization Authority\n- **Algorithms:** JWT MUST fail if the `alg` property in the header is set to 'none' or if it does not align with the key type of the referenced kid\n- **Audience validation:** The `aud` Claim MUST be `registry` to access Registry functionality.\n- **Registry authority validation:** The referenced issuer Authorization Authority MUST have its `isRegistryAuthority` flag on the Registry set to `true`.\n"},{"name":"Glossary","description":"| Term | Description |\n| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Acceptance Option | A payload specifying a payment rail supported by a Payee for payment. (Option Payload) |\n| Anchor Domain | The common domain used for all Paylink web URIs, allowing deep linking through officially registered mobile applications. |\n| Authorization Authority | An entity, managed on the QR+ Registry, which represents a Service Provider IdP that issues bearer tokens to authenticate API calls. A Service Provider manages Authorization Authorities according to their governance and security policies. |\n| Extended Number Encoded Paylink | A 27-character alphanumeric Paylink format (ZA-FTI-SPII-PLV) optimized for Code128 barcode scanning with extended PLV namespace for medium lifespan experiences. |\n| Facilitated Experience | The experience where the Scanner uses a Paylink Facilitator Application to start a QR+ Flow. |\n| Flow | A Flow is the set of actions executed between a PrSP and PeSP as part of one QR+ session. |\n| Flow Record | An audit trail record, created by both PrSP and PeSP, capturing all Service Provider Interactions exchanged as part of a unique Flow. |\n| Flow Session | A time-bound session that tracks the lifecycle of a Flow with states OPEN, TERMINATED, or EXPIRED. A PrSP only process PeSP Requests while a Flow Session is OPEN. |\n| Flow Tracker | A structured object within Service Provider Interactions containing Flow identifiers and Message Sequence Numbers to coordinate and track messages within a Flow. |\n| Flow Type | A classification of QR+ Flows which govern use case requirements, Paylink lifespan constraints, supported encodings, and security requirements (e.g., pep-general, pep-shortcode, prp-connected, prp-disconnected). Service Providers are licensed for individual Flow Types. |\n| Flow Type Indicator | An encoding-specific identifier that indicates which Flow Type is being used (e.g., 'general' representing the pep-general Flow Type in URI encoded Paylinks and '1' representing the prp-shortcode Flow TYpe in number encoded Paylinks). |\n| Identity Request | A QR+ Request for Payer identity information initiated by the PeSP on behalf of the Payee. |\n| Loyalty Request | A QR+ Request for Payer loyalty membership information initiated by the PeSP on behalf of the Payee. |\n| Message Sequence Number | An incrementing counter maintained by each Service Provider to track the ordering and uniqueness of messages sent within a Flow. Used for audit, idempotency and replay detection. |\n| Number Encoded Paylink | A 13-digit numeric Paylink format (FTI-SPII-PLV-Luhn) optimized for human reproduction via voice or manual keypad entry with built-in error detection. |\n| Payee (actor) | A party who interacts with a Paylink with the intention of receiving payment. The Payee can be either a Scanner or a Presenter depending on the use case. |\n| Payee Service Provider (PeSP) | A registered organization that executes QR+ enrichment flows on behalf of a Payee. The PeSP may deploy Paylink Provider and/or Paylink Facilitator functionality depending on its supported experiences. |\n| Payer (actor) | A party who interacts with a Paylink with intention to pay. The Payer can be either a Scanner or a Presenter depending on the use case. |\n| Payer Service Provider (PrSP) | A registered organization that executes QR+ enrichment flows on behalf of a Payer. The PrSP may deploy Paylink Provider and/or Paylink Facilitator functionality depending on its supported experiences. |\n| Paylink | A structured identifier, encoded and presented in various formats, used by Payers and Payees to initiate a financial interaction. |\n| Paylink actioning | The Scanner scanning the Paylink and submitting it to its Service Provider for processing. |\n| Paylink Encoding Format | A Paylink Encoding Format is a specific way the Paylink attributes are encoded. For example, URI encoded format. |\n| Paylink Facilitator (role) | A PrSP or PeSP organization registered to process Paylinks for Scanners. |\n| Paylink generation | An exchange between the Presenter (Payee or Payer) and the Service Provider (PeSP or PrSP) to generate a new Paylink. |\n| Paylink presentment | The Presenter presenting the Paylink to the Scanner for scanning. |\n| Paylink Presentment Format | A Paylink presentment format specifies the technology used to present the Paylink for scanning. For example, QR code, Barcode and web click. |\n| Paylink Provider (role) | A PrSP or PeSP registered to create Paylinks for Presenters. |\n| Paylink Quarantine Period | The period, after a Paylink has been cancelled, during which the PLV must not be used for a new Paylink. |\n| Paylink resolution | The Paylink Facilitator presenting the Paylink to the Paylink Provider to initiate a QR+ flow. |\n| Paylink Value (PLV) | The cryptographically secure random identifier component within a Paylink that uniquely identifies a specific Paylink instance. |\n| Payment Confirmation | A rail-specific payload passed by the PrSP to the PeSP confirming successful initiation of a Push Payment, without claiming settlement status. |\n| Payment Conclusion | A rail-specific payload passed by the PeSP to the PrSP to provide its view on the outcome of a Payment Request. |\n| Payment Delegation | A rail-specific payload passed by the PrSP to the PeSP containing Pull Payment credentials and transaction details, delegating payment initiation to the PeSP. |\n| Payment Request | A QR+ Request for payment initiated by the PeSP on behalf of the Payee. |\n| Presenter (role) | A Payer or Payee who presents a Paylink to a Scanner party to action. The Presenter interacts with her Service Provider to create the Paylink according to her requirements. |\n| Pull Payment | A payment mechanism that is initiated by a PeSP. |\n| Push Payment | A payment mechanism that is initiated by a PrSP. |\n| QR+ Flow Orchestration | The process of coordinating actions between the PrSP, PeSP, Payer and Payee to achieve a successful transaction outcome. |\n| QR+ Registry Service | A service operated by NPU to enable service discovery of registered Service Providers and Services. |\n| QR+ Service Provider | An organization registered to take part in QR+ flows on behalf of Payers and/or Payees. |\n| Scanner (role) | A party who actions a Paylink by submitting it to their chosen Paylink Facilitator. |\n| Service Provider Indicator | An encoding-specific identifier, assigned by SARB to a registered Service Provider, which allows all Service Providers to identify them as the creator of a Paylink. |\n| Service Provider Interaction | A request and response exchange between a PrSP and a PeSP during a Flow, captured for audit trail, Flow analysis, and idempotency purposes. |\n| Signed CBOR Encoded Paylink | A cryptographically signed Concise Binary Object Representation (CBOR) Paylink format using ECDSA signatures for high-security use cases requiring cryptographic attestation. |\n| URI Encoded Paylink | A non-URL, RFC3986-compliant URI format for Paylinks (`qr-plus:///v1///`) supporting deep linking and extended lifespans. |\n"}],"security":[{"bearerAuth":["view:registry"]}],"paths":{"/profile/services":{"get":{"operationId":"getProfileServices","summary":"Get SP services list","description":"As SP Administrator, use this endpoint to retrieve a list of all services configured for your Service Provider.","tags":["Profile - Services"],"security":[{"bearerAuth":["view:profile"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileServicesSummaryInfo"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/services/{serviceId}":{"get":{"operationId":"getProfileService","summary":"Get SP service info","description":"As SP Administrator, use this endpoint to retrieve detailed information about a specific service configured for your Service Provider.","tags":["Profile - Services"],"security":[{"bearerAuth":["view:profile"]}],"parameters":[{"in":"path","name":"serviceId","description":"Service Id","required":true,"schema":{"$ref":"#/components/schemas/ServiceId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileServiceInfo"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/services/{serviceId}/authz-authorities":{"post":{"operationId":"linkAuthzAuthority","summary":"Link service authorization authority","description":"As SP Administrator, use this endpoint to link an authorization authority to a service, enabling token-based authentication for that service.","tags":["Profile - Services"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"serviceId","description":"Service Id","required":true,"schema":{"$ref":"#/components/schemas/ServiceId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkAuthzAuthorityPayload"}}},"required":true},"responses":{"204":{"description":"No Content"},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/services/{serviceId}/authz-authorities/{authzAuthorityId}":{"delete":{"operationId":"unlinkAuthzAuthority","summary":"Unlink service authorization authority","description":"As SP Administrator, use this endpoint to unlink an authorization authority from a service, removing its ability to authorize token-based authentication for that service.","tags":["Profile - Services"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"serviceId","description":"Service Id","required":true,"schema":{"$ref":"#/components/schemas/ServiceId"}},{"in":"path","name":"authzAuthorityId","description":"Authorization Authority Id","required":true,"schema":{"$ref":"#/components/schemas/AuthzAuthorityId","description":"Authorization Authority Id"}}],"responses":{"204":{"description":"No Content"},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/services/{serviceId}/host":{"post":{"operationId":"setServiceHost","summary":"Set service host","description":"As SP Administrator, use this endpoint to configure the host URL for a service where API calls should be directed.","tags":["Profile - Services"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"serviceId","description":"Service Id","required":true,"schema":{"$ref":"#/components/schemas/ServiceId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetServiceHostPayload"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetServiceHostInfo"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}},"delete":{"operationId":"deleteServiceHost","summary":"Delete service host","description":"As SP Administrator, use this endpoint to remove the configured host URL for a service. This effectively decommissions the service from the network.","tags":["Profile - Services"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"serviceId","description":"Service Id","required":true,"schema":{"$ref":"#/components/schemas/ServiceId"}}],"responses":{"204":{"description":"No Content"},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/authz-authorities":{"get":{"operationId":"getAuthzAuthorities","summary":"Get authorization authorities list","description":"As SP Administrator, use this endpoint to retrieve a list of all authorization authorities configured for your Service Provider.","tags":["Profile - Authorization Authorities"],"security":[{"bearerAuth":["view:profile"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthoritySummaryInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthoritySummaryInfo"}}}}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}},"post":{"operationId":"createAuthzAuthority","summary":"Create authorization authority","description":"As SP Administrator, use this endpoint to create a new authorization authority for your Service Provider to manage API token authentication.","tags":["Profile - Authorization Authorities"],"security":[{"bearerAuth":["update:profile"]}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityPayload"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityPayload"}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityInfo"}}}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/authz-authorities/{authzAuthorityId}":{"get":{"operationId":"getAuthzAuthority","summary":"Get authorization authority","description":"As SP Administrator, use this endpoint to retrieve detailed information about a specific authorization authority.","tags":["Profile - Authorization Authorities"],"security":[{"bearerAuth":["view:profile"]}],"parameters":[{"in":"path","name":"authzAuthorityId","description":"Authorization Authority Id","required":true,"schema":{"$ref":"#/components/schemas/AuthzAuthorityId","description":"Authorization Authority Id"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityInfo"}}}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}},"post":{"operationId":"patchAuthzAuthority","summary":"Patch authorization authority","description":"As SP Administrator, use this endpoint to update specific fields of an authorization authority configuration.","tags":["Profile - Authorization Authorities"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"authzAuthorityId","description":"Authorization Authority Id","required":true,"schema":{"$ref":"#/components/schemas/AuthzAuthorityId","description":"Authorization Authority Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityPatch"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityInfo"}}}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}},"delete":{"operationId":"deleteAuthzAuthority","summary":"Delete authorization authority","description":"As SP Administrator, use this endpoint to delete an authorization authority. ","tags":["Profile - Authorization Authorities"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"authzAuthorityId","description":"Authorization Authority Id","required":true,"schema":{"$ref":"#/components/schemas/AuthzAuthorityId","description":"Authorization Authority Id"}}],"responses":{"204":{"description":"No Content"},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/authz-authorities/{authzAuthorityId}/keys":{"post":{"operationId":"addAuthzAuthorityKey","summary":"Add authorization authority key","description":"As SP Administrator, use this endpoint to add a cryptographic public key (JWK) to an authorization authority for token verification.","tags":["Profile - Authorization Authorities"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"authzAuthorityId","description":"Authorization Authority Id","required":true,"schema":{"$ref":"#/components/schemas/AuthzAuthorityId","description":"Authorization Authority Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthzAuthorityJWK"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthzAuthorityJWK"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/profile/authz-authorities/{authzAuthorityId}/keys/{kid}":{"delete":{"operationId":"deleteAuthzAuthorityKey","summary":"Delete authorization authority key","description":"As SP Administrator, use this endpoint to remove a cryptographic key from an authorization authority.","tags":["Profile - Authorization Authorities"],"security":[{"bearerAuth":["update:profile"]}],"parameters":[{"in":"path","name":"authzAuthorityId","description":"Authorization Authority Id","required":true,"schema":{"$ref":"#/components/schemas/AuthzAuthorityId","description":"Authorization Authority Id"}},{"in":"path","name":"kid","description":"Key Id","required":true,"schema":{"$ref":"#/components/schemas/Kid","description":"Key Id"}}],"responses":{"204":{"description":"No Content"},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/service-providers":{"get":{"operationId":"getServiceProviders","summary":"Get service providers list","description":"As SP Operator, use this endpoint to retrieve a list of all Service Providers registered in the QR+ network.","tags":["Service Provider Registry"],"security":[{"bearerAuth":["view:registry"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProvidersSummaryInfo"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/service-providers/{spId}":{"get":{"operationId":"getServiceProvider","summary":"Get service provider","description":"As SP Operator, use this endpoint to retrieve detailed information about a specific Service Provider.","tags":["Service Provider Registry"],"security":[{"bearerAuth":["view:registry"]}],"parameters":[{"in":"path","name":"spId","description":"Unique service provider id","required":true,"schema":{"$ref":"#/components/schemas/ServiceProviderId","description":"Unique service provider id"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProviderInfo"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/flow-types":{"get":{"operationId":"getFlowTypes","summary":"Get flow types list","description":"As SP Operator, use this endpoint to retrieve the list of supported flow types in the QR+ network.","tags":["Services Registry"],"security":[{"bearerAuth":["view:registry"]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FlowType"},"description":"List of supported flow types","example":["pep-general","pep-shortcode","prp-connected","prp-disconnected"]}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/flow-types/{flowType}/payer-services":{"get":{"operationId":"getPayerRegistryServices","summary":"Get payer registry services list","description":"As SP Operator, use this endpoint to retrieve a list of all Payer services for a specific flow type to build your local registry cache.","tags":["Services Registry"],"security":[{"bearerAuth":["view:registry"]}],"parameters":[{"in":"path","name":"flowType","description":"Flow type","required":true,"schema":{"$ref":"#/components/schemas/FlowType","description":"Flow type"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryPayerServicesSummary"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/flow-types/{flowType}/payer-services/{serviceId}":{"get":{"operationId":"getPayerRegistryService","summary":"Get payer registry service","description":"As SP Operator, use this endpoint to retrieve detailed information about a specific Payer service supporting a flow type.","tags":["Services Registry"],"security":[{"bearerAuth":["view:registry"]}],"parameters":[{"in":"path","name":"flowType","description":"Flow type","required":true,"schema":{"$ref":"#/components/schemas/FlowType","description":"Flow type"}},{"in":"path","name":"serviceId","description":"Service id","required":true,"schema":{"$ref":"#/components/schemas/ServiceId","description":"Service id"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryPayerServiceInfo"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/flow-types/{flowType}/payer-registry-cache":{"get":{"operationId":"getPayerRegistryCache","summary":"Download payer registry cache","description":"As SP Operator, use this endpoint as an alternative to download a complete registry cache of all Payer services for a specific flow type. The cache is a JSON document that conforms to the published Payer Registry Cache schema. Response includes ETag header for efficient conditional updates.","tags":["Services Registry"],"security":[{"bearerAuth":["view:registry"]}],"parameters":[{"in":"path","name":"flowType","description":"Flow type","required":true,"schema":{"$ref":"#/components/schemas/FlowType","description":"Flow type"}},{"name":"If-None-Match","in":"header","description":"Conditional request header containing ETag value from previous response. If the cache has not changed (ETag matches), server returns 304 Not Modified with no body.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Registry cache document. Includes ETag header based on cache creation timestamp and Link header referencing the JSON schema.","headers":{"ETag":{"description":"Entity tag for cache versioning, based on createdAt timestamp","schema":{"type":"string"}},"Link":{"description":"Link to JSON Schema definition with rel=\"describedby\"","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"serviceType":{"type":"string","const":"PAYER"},"createdAt":{"$ref":"#/components/schemas/TimeStampRo"},"flowType":{"$ref":"#/components/schemas/FlowType"},"services":{"type":"array","items":{"$ref":"#/components/schemas/RegistryPayerServiceInfo"}}},"required":["serviceType","createdAt","flowType","services"]}}}},"304":{"description":"Not Modified - Cache has not changed since last request. ETag header included but no response body.","headers":{"ETag":{"description":"Entity tag for cache versioning, based on createdAt timestamp","schema":{"type":"string"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/flow-types/{flowType}/payee-services":{"get":{"operationId":"getPayeeRegistryServices","summary":"Get payee registry services list","description":"As SP Operator, use this endpoint to retrieve a list of all Payee services supporting a specific flow type to build your local registry cache.","tags":["Services Registry"],"security":[{"bearerAuth":["view:registry"]}],"parameters":[{"in":"path","name":"flowType","description":"Flow type","required":true,"schema":{"$ref":"#/components/schemas/FlowType","description":"Flow type"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryPayeesServiceSummary"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/flow-types/{flowType}/payee-services/{serviceId}":{"get":{"operationId":"getPayeeRegistryService","summary":"Get payee registry service","description":"As SP Operator, use this endpoint to retrieve detailed information about a specific Payee service supporting a flow type.","tags":["Services Registry"],"security":[{"bearerAuth":["view:registry"]}],"parameters":[{"in":"path","name":"flowType","description":"Flow type","required":true,"schema":{"$ref":"#/components/schemas/FlowType","description":"Flow type"}},{"in":"path","name":"serviceId","description":"Payee service id","required":true,"schema":{"$ref":"#/components/schemas/ServiceId","description":"Payee service id"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistryPayeeServiceInfo"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}},"/flow-types/{flowType}/payee-registry-cache":{"get":{"operationId":"getPayeeRegistryCache","summary":"Download payee registry cache","description":"As SP Operator, use this endpoint as an alternative to download a complete registry cache of all Payee services for a specific flow type. The cache is a JSON document that conforms to the published Payee Registry Cache schema. Response includes ETag header for efficient conditional updates.","tags":["Services Registry"],"security":[{"bearerAuth":["view:registry"]}],"parameters":[{"in":"path","name":"flowType","description":"Flow type","required":true,"schema":{"$ref":"#/components/schemas/FlowType","description":"Flow type"}},{"name":"If-None-Match","in":"header","description":"Conditional request header containing ETag value from previous response. If the cache has not changed (ETag matches), server returns 304 Not Modified with no body.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Registry cache document. Includes ETag header based on cache creation timestamp and Link header referencing the JSON schema.","headers":{"ETag":{"description":"Entity tag for cache versioning, based on createdAt timestamp","schema":{"type":"string"}},"Link":{"description":"Link to JSON Schema definition with rel=\"describedby\"","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"serviceType":{"type":"string","const":"PAYEE"},"createdAt":{"$ref":"#/components/schemas/TimeStampRo"},"flowType":{"$ref":"#/components/schemas/FlowType"},"services":{"type":"array","items":{"$ref":"#/components/schemas/RegistryPayeeServiceInfo"}}},"required":["serviceType","createdAt","flowType","services"]}}}},"304":{"description":"Not Modified - Cache has not changed since last request. ETag header included but no response body.","headers":{"ETag":{"description":"Entity tag for cache versioning, based on createdAt timestamp","schema":{"type":"string"}}}},"default":{"description":"error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultErrorResponse"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT","description":"AuthzAuthority signed API token"}},"schemas":{"ProfileServicesSummaryInfo":{"type":"array","items":{"$ref":"#/components/schemas/ProfileServiceSummaryInfo"},"description":"Service Summary Information list"},"ProfileServiceSummaryInfo":{"oneOf":[{"$ref":"#/components/schemas/ProfilePayeeServiceSummary"},{"$ref":"#/components/schemas/ProfilePayerServiceSummary"}],"discriminator":{"propertyName":"kind","mapping":{"PAYEE":"#/components/schemas/ProfilePayeeServiceSummary","PAYER":"#/components/schemas/ProfilePayerServiceSummary"}}},"ProfilePayeeServiceSummary":{"type":"object","properties":{"kind":{"type":"string","const":"PAYEE"},"id":{"$ref":"#/components/schemas/ServiceId"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"alias":{"$ref":"#/components/schemas/ServiceAlias"}},"required":["kind","id","spId","flowType"]},"ServiceId":{"type":"string","format":"uuid","description":"Service Id"},"ServiceProviderId":{"type":"string","pattern":"^[a-z]+(?:-[a-z]+)*$","minLength":5,"maxLength":36,"description":"A unique value identifying the QR+ service provider. Must be in kebab-case (lowercase letters separated by single hyphens).","example":"north-big-bank"},"FlowType":{"type":"string","pattern":"^[a-zA-Z0-9-._~]*$","minLength":2,"maxLength":32,"description":"Flow Type","example":"pep-general"},"ServiceAlias":{"type":"string","maxLength":128,"description":"Recognizable name for the service, assigned by the Service Provider.","example":"Payer presented offline service B"},"ProfilePayerServiceSummary":{"type":"object","properties":{"kind":{"type":"string","const":"PAYER"},"id":{"$ref":"#/components/schemas/ServiceId"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"alias":{"$ref":"#/components/schemas/ServiceAlias"}},"required":["kind","id","spId","flowType"]},"DefaultErrorResponse":{"type":"object","properties":{"statusCode":{"type":"integer","minimum":400,"maximum":599,"description":"HTTP status code","example":403},"title":{"type":"string","maxLength":255,"description":"A short, human-readable summary of the problem type.","example":"Forbidden: The client does not have access rights to the content or functionality."},"detail":{"type":"string","maxLength":255,"description":"A human-readable explanation specific to this occurrence of the problem.","example":"You do not have permission to access this resource"},"instance":{"type":"string","format":"uuid","description":"Unique identifier for the instance of the error for further investigation","example":"0540fa0f-ccfa-4625-b006-725b4b580879"},"extensions":{"type":"array","items":{"type":"object","propertyNames":{"type":"string","maxLength":64},"additionalProperties":{"anyOf":[{"type":"string","maxLength":255},{"type":"number"},{"type":"boolean"},{"type":"null"}]}},"description":"An array of optional, additional error information objects","example":[{"requiredPermission":"profile:read"}]}},"required":["statusCode","title","instance"],"description":"An RFC9457 based error response payload"},"ProfileServiceInfo":{"oneOf":[{"$ref":"#/components/schemas/ProfilePayeeServiceInfo"},{"$ref":"#/components/schemas/ProfilePayerServiceInfo"}],"discriminator":{"propertyName":"kind","mapping":{"PAYEE":"#/components/schemas/ProfilePayeeServiceInfo","PAYER":"#/components/schemas/ProfilePayerServiceInfo"}}},"ProfilePayeeServiceInfo":{"type":"object","properties":{"kind":{"type":"string","const":"PAYEE"},"id":{"$ref":"#/components/schemas/ServiceId"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"alias":{"$ref":"#/components/schemas/ServiceAlias"},"indicatorMappings":{"type":"array","items":{"$ref":"#/components/schemas/IndicatorMapping"},"description":"List of paylink indicator mappings with encoding-specific flowTypeIndicators and spIndicators"},"host":{"oneOf":[{"$ref":"#/components/schemas/ServiceHost"},{"type":"null"}]},"authzAuthorities":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}}},"description":"List of authorization authorities"}},"required":["kind","id","spId","flowType","indicatorMappings","host","authzAuthorities"]},"IndicatorMapping":{"oneOf":[{"$ref":"#/components/schemas/UriEncodedIndicatorMapping"},{"$ref":"#/components/schemas/NumberEncodedIndicatorMapping"},{"$ref":"#/components/schemas/ExtNumberEncodedIndicatorMapping"},{"$ref":"#/components/schemas/SignedCborEncodedIndicatorMapping"}],"discriminator":{"propertyName":"encoding","mapping":{"URI_ENCODED":"#/components/schemas/UriEncodedIndicatorMapping","NUMBER_ENCODED":"#/components/schemas/NumberEncodedIndicatorMapping","EXTENDED_NUMBER_ENCODED":"#/components/schemas/ExtNumberEncodedIndicatorMapping","SIGNED_CBOR_ENCODED":"#/components/schemas/SignedCborEncodedIndicatorMapping"}},"description":"Paylink indicator mapping with encoding-specific validation for both flowTypeIndicator and spIndicator"},"UriEncodedIndicatorMapping":{"type":"object","properties":{"encoding":{"type":"string","const":"URI_ENCODED"},"flowTypeIndicator":{"$ref":"#/components/schemas/UriFlowTypeIndicator"},"spIndicator":{"$ref":"#/components/schemas/UriSpIndicator"}},"required":["encoding","flowTypeIndicator","spIndicator"]},"UriFlowTypeIndicator":{"type":"string","pattern":"^[a-zA-Z0-9-._~]*$","minLength":2,"maxLength":16,"description":"Uri encoded Flow Type Indicator","example":"general"},"UriSpIndicator":{"type":"string","pattern":"^[a-zA-Z0-9-._~]*$","minLength":2,"maxLength":16,"description":"Uri encoded Service Provider Indicator","example":"xmpl"},"NumberEncodedIndicatorMapping":{"type":"object","properties":{"encoding":{"type":"string","const":"NUMBER_ENCODED"},"flowTypeIndicator":{"$ref":"#/components/schemas/NFlowTypeIndicator"},"spIndicator":{"$ref":"#/components/schemas/NSpIndicator"}},"required":["encoding","flowTypeIndicator","spIndicator"]},"NFlowTypeIndicator":{"type":"string","pattern":"^[1-9]*$","minLength":1,"maxLength":1,"description":"Number encoded Flow Type Indicator","example":"2"},"NSpIndicator":{"type":"string","pattern":"^[0-9]*$","minLength":2,"maxLength":2,"description":"Number encoded Service Provider Indicator","example":"48"},"ExtNumberEncodedIndicatorMapping":{"type":"object","properties":{"encoding":{"type":"string","const":"EXTENDED_NUMBER_ENCODED"},"flowTypeIndicator":{"$ref":"#/components/schemas/NExtFlowTypeIndicator"},"spIndicator":{"$ref":"#/components/schemas/NExtSpIndicator"}},"required":["encoding","flowTypeIndicator","spIndicator"]},"NExtFlowTypeIndicator":{"type":"string","pattern":"^[1-9]*$","minLength":1,"maxLength":1,"description":"Extended number encoded Flow Type Indicator","example":"1"},"NExtSpIndicator":{"type":"string","pattern":"^[0-9]*$","minLength":4,"maxLength":4,"description":"Extended number encoded Service Provider Indicator","example":"3713"},"SignedCborEncodedIndicatorMapping":{"type":"object","properties":{"encoding":{"type":"string","const":"SIGNED_CBOR_ENCODED"},"flowTypeIndicator":{"$ref":"#/components/schemas/CborFlowTypeIndicator"},"spIndicator":{"$ref":"#/components/schemas/CborSpIndicator"}},"required":["encoding","flowTypeIndicator","spIndicator"]},"CborFlowTypeIndicator":{"type":"string","pattern":"^[0-9A-Fa-f]*$","minLength":1,"maxLength":1,"description":"CBOR encoded Flow Type Indicator (hex encoded)","example":"disconnected"},"CborSpIndicator":{"type":"string","pattern":"^[0-9A-Fa-f]*$","minLength":3,"maxLength":3,"description":"CBOR encoded Service Provider Type Indicator (hex encoded)","example":"d2b"},"ServiceHost":{"type":"string","format":"uri","maxLength":128,"description":"The https url where the service is hosted.","example":"https://best-link-provider.com/paylink/payer"},"SignedBearerAuthzAuthorityServiceInfo":{"type":"object","properties":{"kind":{"type":"string","const":"SIGNED_BEARER_TOKEN"},"id":{"$ref":"#/components/schemas/AuthzAuthorityId"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/AuthzAuthorityJWK"}}},"required":["kind","id","keys"],"description":"Authorization authority service information for a signed bearer authority"},"AuthzAuthorityId":{"type":"string","format":"uuid","description":"Authorization Authority Identifier","example":"c4dbf68e-9be0-4780-9e30-08d5414f3467"},"AuthzAuthorityJWK":{"oneOf":[{"$ref":"#/components/schemas/ECJWK"},{"$ref":"#/components/schemas/RSAJWK"},{"$ref":"#/components/schemas/OKPJWK"}],"discriminator":{"propertyName":"kty","mapping":{"EC":"#/components/schemas/ECJWK","RSA":"#/components/schemas/RSAJWK","OKP":"#/components/schemas/OKPJWK"}},"description":"Public JSON Web Key (JWK) as defined in RFC7517 for validating JWT API access tokens"},"ECJWK":{"type":"object","properties":{"kty":{"type":"string","const":"EC","description":"Key Type"},"alg":{"type":"string","enum":["ES256","ES384","ES512"],"description":"ECDSA Algorithm","example":"ES256"},"kid":{"$ref":"#/components/schemas/Kid"},"use":{"type":"string","const":"sig","description":"Public key use - signature verification only"},"crv":{"type":"string","enum":["P-256","P-384","P-521"],"description":"NIST P-curve (FIPS 186-4 compliant)","example":"P-256"},"x":{"type":"string","pattern":"^[A-Za-z0-9_-]+$","maxLength":128,"description":"X Coordinate - Base64Url encoded","example":"f83OJ3D2xF4a8u5lFh9a8u5lFh9a8u5lFh9a8u5lFh9a8u5lFh9a8u5lFh9a8u5l"},"y":{"type":"string","pattern":"^[A-Za-z0-9_-]+$","maxLength":128,"description":"Y Coordinate - Base64Url encoded","example":"x_FEzRu9u5lFh9a8u5lFh9a8u5lFh9a8u5lFh9a8u5lFh9a8u5lFh9a8u5lFh9a8u5l"}},"required":["kty","alg","kid","use","crv","x","y"],"description":"EC JSON Web Key (JWK) for signature verification (RFC 7517)"},"Kid":{"type":"string","pattern":"^[A-Za-z0-9_-]+$","minLength":36,"maxLength":128,"description":"Cryptographic key identifier - UUID or base64url-encoded thumbprint (min 36 chars for collision resistance)","example":"bq2wK4mVA6ahC1aUooSHO7i5PO_gbIkOQ5U2cYg5mnU"},"RSAJWK":{"type":"object","properties":{"kty":{"type":"string","const":"RSA","description":"Key Type"},"alg":{"type":"string","enum":["RS256","RS384","RS512","PS256","PS384","PS512"],"description":"RSA Signature Algorithm","example":"RS256"},"kid":{"$ref":"#/components/schemas/Kid"},"use":{"type":"string","const":"sig","description":"Public key use - signature verification only"},"n":{"type":"string","description":"RSA Modulus - Base64Url encoded"},"e":{"type":"string","description":"RSA Exponent - Base64Url encoded"}},"required":["kty","alg","kid","use","n","e"],"description":"RSA JSON Web Key (JWK) for signature verification (RFC 7517)"},"OKPJWK":{"type":"object","properties":{"kty":{"type":"string","const":"OKP","description":"Key Type"},"alg":{"type":"string","enum":["EdDSA"],"description":"EdDSA Signature Algorithm","example":"EdDSA"},"kid":{"$ref":"#/components/schemas/Kid"},"use":{"type":"string","const":"sig","description":"Public key use - signature verification only"},"crv":{"type":"string","enum":["Ed25519","Ed448"],"description":"Edwards Curve","example":"Ed25519"},"x":{"type":"string","pattern":"^[A-Za-z0-9_-]+$","maxLength":128,"description":"Public Key - Base64Url encoded","example":"11qYAYLefZBTm8gk1zo5d4z1Z8gk1zo5d4z1Z8gk1zo5d4z1Z8gk1zo5d4z1Z8gk1"}},"required":["kty","alg","kid","use","crv","x"],"description":"OKP JSON Web Key (JWK) for signature verification (RFC 7517)"},"ProfilePayerServiceInfo":{"type":"object","properties":{"kind":{"type":"string","const":"PAYER"},"id":{"$ref":"#/components/schemas/ServiceId"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"alias":{"$ref":"#/components/schemas/ServiceAlias"},"indicatorMappings":{"type":"array","items":{"$ref":"#/components/schemas/IndicatorMapping"},"description":"List of paylink indicator mappings with encoding-specific flowTypeIndicators and spIndicators"},"host":{"oneOf":[{"$ref":"#/components/schemas/ServiceHost"},{"type":"null"}]},"authzAuthorities":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}}},"description":"List of authorization authorities"}},"required":["kind","id","spId","flowType","indicatorMappings","host","authzAuthorities"]},"LinkAuthzAuthorityPayload":{"type":"object","properties":{"authorityId":{"$ref":"#/components/schemas/AuthzAuthorityId"}},"required":["authorityId"],"description":"Link services to authorization authority"},"SetServiceHostPayload":{"type":"object","properties":{"host":{"$ref":"#/components/schemas/ServiceHost"}},"required":["host"],"description":"Update service host"},"SetServiceHostInfo":{"type":"object","properties":{"host":{"$ref":"#/components/schemas/ServiceHost"}},"required":["host"],"description":"Updated service host value"},"SignedBearerAuthzAuthoritySummaryInfo":{"type":"object","properties":{"kind":{"type":"string","const":"SIGNED_BEARER_TOKEN"},"id":{"$ref":"#/components/schemas/AuthzAuthorityId"},"createdAt":{"$ref":"#/components/schemas/TimeStampRo"},"isRegistryAuthority":{"type":"boolean","description":"Stipulates whether this authority can authorize registry updates","default":false},"alias":{"$ref":"#/components/schemas/AuthzAuthorityAlias"}},"required":["kind","id","createdAt","isRegistryAuthority"],"description":"Authorization authority summary information for a signed bearer authority"},"TimeStampRo":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}\\.\\d{3}Z$","description":"RFC3339 date-time with millisecond precision in UTC (Z)","example":"2026-07-02T17:32:26.581Z","format":"date-time","readOnly":true},"AuthzAuthorityAlias":{"type":"string","maxLength":128,"description":"A Member recognizable name for the authorization authority","example":"Paylink Auth Key 2025-06"},"SignedBearerAuthzAuthorityPayload":{"type":"object","properties":{"kind":{"type":"string","const":"SIGNED_BEARER_TOKEN"},"isRegistryAuthority":{"type":"boolean","description":"Stipulates whether this authority can authorize registry updates","default":false},"alias":{"$ref":"#/components/schemas/AuthzAuthorityAlias"}},"required":["kind"],"description":"Authorization authority creation payload for a signed bearer authority"},"SignedBearerAuthzAuthorityInfo":{"type":"object","properties":{"kind":{"type":"string","const":"SIGNED_BEARER_TOKEN"},"id":{"$ref":"#/components/schemas/AuthzAuthorityId"},"linkedPayerServices":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","const":"PAYER"},"serviceId":{"$ref":"#/components/schemas/ServiceId"},"flowType":{"$ref":"#/components/schemas/FlowType"}},"required":["kind","serviceId","flowType"]}},"linkedPayeeServices":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","const":"PAYEE"},"serviceId":{"$ref":"#/components/schemas/ServiceId"},"flowType":{"$ref":"#/components/schemas/FlowType"}},"required":["kind","serviceId","flowType"]}},"createdAt":{"$ref":"#/components/schemas/TimeStampRo"},"alias":{"$ref":"#/components/schemas/AuthzAuthorityAlias"},"isRegistryAuthority":{"type":"boolean","description":"Stipulates whether this authority can authorize registry updates","default":false},"keys":{"type":"array","items":{"$ref":"#/components/schemas/AuthzAuthorityJWK"}}},"required":["kind","id","linkedPayerServices","linkedPayeeServices","createdAt","isRegistryAuthority","keys"],"description":"Authorization authority information for a signed bearer authority"},"SignedBearerAuthzAuthorityPatch":{"type":"object","properties":{"kind":{"type":"string","const":"SIGNED_BEARER_TOKEN"},"isRegistryAuthority":{"type":"boolean","description":"Stipulates whether this authority can authorize registry updates","default":false},"alias":{"oneOf":[{"$ref":"#/components/schemas/AuthzAuthorityAlias"},{"type":"null"}]}},"required":["kind"],"description":"Authorization authority patch payload for a signed bearer authority"},"ServiceProvidersSummaryInfo":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderSummaryInfo"},"description":"Summary information about all members"},"ServiceProviderSummaryInfo":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceProviderId"},"companyName":{"$ref":"#/components/schemas/CompanyName"}},"required":["id","companyName"],"description":"Summary information about a member"},"CompanyName":{"type":"string","maxLength":128,"description":"Company name","example":"Big Company Pty Ltd"},"ServiceProviderInfo":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceProviderId"},"name":{"$ref":"#/components/schemas/CompanyName"},"serviceSupportPhone":{"$ref":"#/components/schemas/PhoneNumberZa"},"serviceSupportEmail":{"$ref":"#/components/schemas/Email"},"payerServices":{"type":"array","items":{"$ref":"#/components/schemas/ServiceReference"},"description":"List of ServiceProvider's payer services"},"payeeServices":{"type":"array","items":{"$ref":"#/components/schemas/ServiceReference"},"description":"'List of ServiceProvider's payee services"}},"required":["id","name","serviceSupportPhone","serviceSupportEmail","payerServices","payeeServices"],"description":"Service provider information"},"PhoneNumberZa":{"type":"string","pattern":"^\\+27\\d{9}$","maxLength":25,"description":"South African phone number in E.164 format","example":"+27821234567"},"Email":{"type":"string","format":"email","description":"Email address","example":"email@example.com"},"ServiceReference":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceId"},"flowType":{"$ref":"#/components/schemas/FlowType"}},"required":["id","flowType"],"description":"Service reference"},"RegistryPayerServicesSummary":{"type":"array","items":{"$ref":"#/components/schemas/RegistryPayerServiceSummary"},"description":"PrSP service summary list"},"RegistryPayerServiceSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"}},"required":["id","flowType","spId"],"description":"Payer service summary information"},"RegistryPayerServiceInfo":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"},"authzAuthorities":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}}},"description":"List of authorization authorities linked to the service"},"indicatorMappings":{"type":"array","items":{"$ref":"#/components/schemas/IndicatorMapping"},"description":"List of paylink indicator mappings with encoding-specific flowTypeIndicators and spIndicators"},"host":{"oneOf":[{"$ref":"#/components/schemas/ServiceHost"},{"type":"null"}],"description":"The Public https host address where this payer service is hosted. If null then service is not currently active"}},"required":["id","flowType","spId","authzAuthorities","indicatorMappings","host"],"description":"Payer service registry information"},"RegistryPayeesServiceSummary":{"type":"array","items":{"$ref":"#/components/schemas/RegistryPayeeServiceSummary"},"description":"PeSP service summary list"},"RegistryPayeeServiceSummary":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"}},"required":["id","flowType","spId"],"description":"Summary information about a PeSP service"},"RegistryPayeeServiceInfo":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ServiceId"},"flowType":{"$ref":"#/components/schemas/FlowType"},"spId":{"$ref":"#/components/schemas/ServiceProviderId"},"authzAuthorities":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}],"discriminator":{"propertyName":"kind","mapping":{"SIGNED_BEARER_TOKEN":"#/components/schemas/SignedBearerAuthzAuthorityServiceInfo"}}},"description":"List of authorization authority public keys"},"indicatorMappings":{"type":"array","items":{"$ref":"#/components/schemas/IndicatorMapping"},"description":"List of paylink indicator mappings with encoding-specific flowTypeIndicators and spIndicators"},"host":{"oneOf":[{"$ref":"#/components/schemas/ServiceHost"},{"type":"null"}],"description":"The Public https host address where this payee service is hosted. If null then service is not currently active"}},"required":["id","flowType","spId","authzAuthorities","indicatorMappings","host"],"description":"Payee service information"}}}}