openapi: 3.0.0 info: description: | This schema defines the RESTful endpoints provided by the GSMA Mobile Money API. You can find out more about what the API can do for your business at [https://developer.mobilemoneyapi.io] version: "1.2.0" title: Mobile Money API servers: - description: This url points to the GSMA Mobile Money API v1.2 Simulator. url: https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm tags: - name: Transactions description: | The **Transactions** APIs are used to support mobile money financial transaction use cases. Transactions are used for a wide range of use cases including merchant payments, international transfers, domestic transfers and agent cash-in/cash-out. Reversals and adjustments are also treated as transactions. - name: Quotations description: | The **Quotations** APIs are used to obtain one or multiple quotes for a mobile money customer who wishes to transfer money. The creation of a quote involves returning any fees that will be levied on the sending customer and if the request is international, the forex rate is returned. A request is made for a quotation by the requesting Service Provider in response to a customer request. The quotation is calculated and returned. If the customer is satisfied with the quotation, then they can confirm and proceed with a transaction request using the **/transactions** API. - name: Accounts description: | The **Accounts** APIs are used to support a range of operations on a financial account resource and associated resources. Types of accounts include mobile wallets, financial institution accounts and utility accounts (e.g. for electricity). **Identifying a Target Account** Two methods are provided for identifying an account, the single identifier method and the multiple identifiers method. Single Identifier Method: - In the scenario where one identifier suffices to uniquely identify an account, the following path is to be used: **/accounts/{identifierType}/{identifier}**. Multiple Identifiers Method: - Where a single identifier is not sufficient to identify an account, the following path is to be used: ' **/accounts/{accountIdentifier1}@{value1}${accountIdentifier2}@{value2}${accountIdentifier3}@{value3}**'. The list of permitted account identifiers supported by the Mobile Money API can be found in the API documentation. As there can be multiple identifiers required to identify the target account, the path uses a '$' delimiter to separate each identifier, up to a limit of three account identifiers. - name: Bills description: | The **Bills** APIs allow a mobile money provider to allow customers to retrieve and pay bills. Specific use cases include: - Retrieving information on service providers (bill companies) that accept bill payments. - Retrieving bills at a service provider for a given mobile money customer. - Allowing mobile money customers to partially or fully pay bills for a service provider. - Retrieving bill payment information from a service provider for a given customer. - name: Debit Mandates description: | The **Debit Mandates** APIs allow a mobile money customer to provide prior approval for payments to be taken from their account by a requesting payee. If the amount limit field is not supplied, the payee will be able to take any amount. Mandates can be open-ended or can be constrained by a quantified number of payments for a given frequency. Mandates can be created, viewed and modified. The request to create a debit mandate will be typically initiated by the service provider (payee) but can also be requested by the customer (payer). - name: Links description: | The **Links** APIs are used to establish a link between two separate accounts on the client and provider systems. The API can be used for example to link a mobile wallet account to a Microfinance Institution account or a bank account. The link object does not mandate the processes to verify and authenticate a link request - this depends upon the use case. A link needs to be associated with a mode of operation: - pull. The link can be used by the client to debit the target account held by the provider. - push. The link can be used by the client to credit the target account held by the provider. - both. The link can be used for Push and Pull requests. - name: Authorisation Codes description: | The **Authorisation** Codes APIs allow a payer to generate a payment code which when presented to the payee, can be redeemed for an amount associated with the code. Authorisation codes can be set to expire. Note that expiry time can be specified via the API, however the mobile money provider may mandate a common expiry period for all codes. Authorisation Codes are used widely in the industry across a range of use cases, including: - ATM Codes for card-less withdrawals. A code is generated in advance by the customer and entered into the ATM to facilitate the withdrawal. - Pre-authorised codes for agent withdrawals. A code is generated in advance by the customer and given to the agent to facilitate the withdrawal. - Pre-authorised codes for merchant payments. The customer generates a code which can be redeemed at a merchant. - name: Supporting description: | Supporting APIs consist of the following: - **Heartbeat API:** Used for monitoring purposes and establishes whether the system of an API provider is in a state that enables a client to submit a request for processing within established SLAs. - **Request State API** : Used to determine the state of an asynchronous request. - **Responses API** : In some circumstances, the client may not have received the final representation of the resource for which it attempted to create or update. The **Responses** API allows a client to identify and retrieve the final representation of the resource assuming that the resource was created. paths: # Transactions APIs. These support creation, modification and viewing of financial transactions in singular and bulk. /transactions: post: deprecated: true # This POST operation is to be deprecated. Please use POST /transactions/type/{transactionType} instead. tags: - Transactions summary: Create a Transaction description: Provided with a valid object representation, this endpoint allows for a new transaction to be created operationId: transactionsPOST parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestTransaction' callbacks: transactionsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Transaction Success Callback description: This callback communicates the final representation of the transaction requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateTransaction' # The callback consists of the same body as a synchronous /transactions response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability transactionsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Transaction Failure Callback description: This callback communicates the information regarding a transaction failure in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Transaction response content: application/json: schema: $ref: "#/components/schemas/responseTransaction" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /transactions/type/{transactionType}: post: tags: - Transactions summary: Create a Transaction description: Provided with a valid object representation, this endpoint allows for a new transaction to be created for a given transaction type passed via the URL. operationId: "transactionstypetransactionTypePUT" parameters: - $ref: '#/components/parameters/transactionTypePath' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestTransactionType' callbacks: transactionsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Transaction Success Callback description: This callback communicates the final representation of the transaction requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsTransactionTypeSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateTransaction' # The callback consists of the same body as a synchronous /transactions response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability transactionsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Transaction Failure Callback description: This callback communicates the information regarding a transaction failure in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsTransactionTypeFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Transaction response content: application/json: schema: $ref: "#/components/schemas/responseTransactionType" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /transactions/{transactionReference}: parameters: - $ref: '#/components/parameters/transactionReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Transactions summary: View A Transaction description: This endpoint returns the details of a transaction operationId: "transactionsTransactionReferenceGET" responses: 200: description: Represents a Transaction response content: application/json: schema: $ref: "#/components/schemas/responseTransaction" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Transactions summary: Update A Transaction description: This endpoint allows the transactionStatus of a transaction to be updated. operationId: "transactionsTransactionReferencePATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: transactionsUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Transactions Update Success Callback description: This callback communicates a simple message to communicate that the transaction update completed successfully. operationId: "transactionsTransactionsUpdatePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability transactionsUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Transaction Update Failure Callback description: This callback communicates the information regarding a failure to update a transaction in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsTransactionsUpdateFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /transactions/{transactionReference}/reversals: post: tags: - Transactions summary: Create A Reversal description: Provided with a valid object representation, this endpoint allows for a new reversal to be created operationId: "transactionsTransactionReferenceReversalsPOST" parameters: - $ref: '#/components/parameters/transactionReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestReversal' callbacks: reversalsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Reversal Callback description: This callback communicates the final representation of the reversal requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsTransactionReferenceReversalsSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateReversal' # The callback consists of the same body as a synchronous /reversals response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability reversalsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Reversal Failure Callback description: This callback communicates the information regarding a transaction failure in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsTransactionReferenceReversalfailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Transaction Reversal response content: application/json: schema: $ref: "#/components/schemas/responseReversal" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /batchtransactions: post: tags: - Transactions summary: Create A Transaction Batch description: Provided with a valid object representation, this endpoint allows for a new transaction batch to be created operationId: "batchtransactionsPOST" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestBatchTransaction' callbacks: batchTransactionsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Batch Transactions Callback description: This callback communicates the final representation of the batch of transactions requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsBatchTransactionsSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateBatchTransaction' # The callback consists of the same body as a synchronous /batchtransactions response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability batchTransactionsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Batch Transaction Failure Callback description: This callback communicates the information regarding a failure to receive a transaction batch in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsBatchTransactionsFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /batchtransactions/{batchId}: parameters: - $ref: '#/components/parameters/batchId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Transactions summary: View A Transaction Batch description: This endpoint returns the current status of a batch transaction operationId: "batchtransactionsBatchIdGET" responses: 200: description: Represents a Batch Transaction response content: application/json: schema: $ref: "#/components/schemas/responseBatchTransaction" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Transactions summary: Update A Transaction Batch description: This endpoint updates a specific transaction batch. Only the batchStatus field can be modified. operationId: "batchtransactionsBatchIdPATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: batchTransactionsUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Batch Transactions Update Success Callback description: This callback communicates a simple message to communicate that the Batch Transactions update completed successfully. operationId: "transactionsBatchTransactionsUpdatePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability batchTransactionsUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Batch Transaction Update Failure Callback description: This callback communicates the information regarding a failure to update a transaction batch in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "transactionsBatchTransactionsUpdateFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /batchtransactions/{batchId}/rejections: get: tags: - Transactions summary: View Batch Rejections description: This endpoint returns rejected transactions for a specific batch" operationId: "batchtransactionsBatchIdRejectionsGET" parameters: - $ref: '#/components/parameters/batchId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represents a Batch Transaction Rejection response content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseBatchTransactionRejection" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /batchtransactions/{batchId}/completions: get: tags: - Transactions summary: View Batch Completions description: This endpoint returns completed transactions for a specific batch operationId: "batchtransactionsBatchIdCompletionsGET" parameters: - $ref: '#/components/parameters/batchId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represent a list of Batch Completions content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseBatchTransactionCompletion" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # Accounts APIs. These support creation, modification and viewing of account-related information. /accounts/{identityType}: post: tags: - Accounts summary: Create an Account description: Provided with a valid object representation, this endpoint allows for a new account to be created operationId: accountsPOST parameters: - $ref: '#/components/parameters/identityTypePath' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestAccount' callbacks: accountsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Success Callback description: This callback communicates the final representation of the account requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "accountsSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateAccount' # The callback consists of the same body as a synchronous /accounts response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability accountsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Failure Callback description: This callback communicates the information regarding an account creation failure in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "accountsFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents an Account creation response content: application/json: schema: $ref: "#/components/schemas/responseAccount" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Accounts summary: View an Account description: This endpoint returns details for a given account. This API accepts multiple account identifiers operationId: "accountsAccountIdGET" responses: 200: description: Represents an Account response content: application/json: schema: $ref: "#/components/schemas/responseAccount" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Accounts summary: Update an Account description: This endpoint updates an account. Currently, accountStatus and accountSubStatus fields can be updated. operationId: "accountsAccountIdPATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: accountsUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Update Success Callback description: This callback communicates a simple message to communicate that the Account update completed successfully. operationId: "accountsUpdateAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability accountsUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Update Failure Callback description: This callback communicates the information regarding a failure to update an account in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "accountsUpdateAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}: parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Accounts summary: View an Account description: This endpoint returns the details of an account. operationId: "accountsIdentifierTypeIdentifierGET" responses: 200: description: Represents an Account response content: application/json: schema: $ref: "#/components/schemas/responseAccount" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Accounts summary: Update an Account description: This endpoint updates an account. Currently, accountStatus and accountSubStatus fields can be updated. operationId: "accountsIdentifierTypeIdentifierPATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: accountsUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Update Success Callback description: This callback communicates a simple message to communicate that the Account update completed successfully. operationId: "accountsUpdateIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability accountsUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Update Failure Callback description: This callback communicates the information regarding a failure to update an account in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "accountsUpdateIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/identities/{identityId}: patch: tags: - Accounts summary: Update an Account Identity. description: This endpoint updates an account identity. identityStatus, kycVerificationStatus, kycVerificationEntity and kycLevel field updates are permitted. operationId: "accountIdentitiesAccountIdPATCH" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/identityIdPath' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: accountIdentitiesUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Identity Update Success Callback description: This callback communicates a simple message to communicate that the Account Identity update completed successfully. operationId: "accountIdentitiesUpdateAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability accountIdentitiesUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Identities Update Failure Callback description: This callback communicates the information regarding a failure to update an account identity in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "accountIdentitiesUpdateAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/identities/{identityId}: patch: tags: - Accounts summary: Update an Account Identity description: This endpoint updates an account identity. identityStatus, kycVerificationStatus, kycVerificationEntity and kycLevel field updates are permitted. operationId: "accountIdentitiesIdentifierTypeIdentifierPATCH" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/identityIdPath' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: accountsUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Identity Update Success Callback description: This callback communicates a simple message to communicate that the Account Identity update completed successfully. operationId: "accountIdentitiesUpdateIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability accountIdentitiesUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Identity Update Failure Callback description: This callback communicates the information regarding a failure to update an account identity in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "accountIdentitiesUpdateIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/status: get: tags: - Accounts summary: View Account Status description: This endpoint returns the current status of an account. This API accepts multiple identifiers operationId: "accountsAccountIdStatusGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents an Account Status response content: application/json: schema: $ref: "#/components/schemas/responseAccountStatus" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/status: get: tags: - Accounts summary: View Account Status description: This endpoint returns the current status of an account. operationId: "accountsIdentifierTypeIdentifierStatusGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents an Account Status response content: application/json: schema: $ref: "#/components/schemas/responseAccountStatus" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/accountname: get: tags: - Accounts summary: View Account Name description: This endpoint returns the status of a given account. operationId: "accountsAccountIdAccountnameGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents an Account Name response content: application/json: schema: $ref: "#/components/schemas/responseAccountName" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/accountname: get: tags: - Accounts summary: "View Account Name" description: This endpoint returns the name of an account holder. operationId: "accountsIdentifierTypeIdentifierAccountnameGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents an Account Name response content: application/json: schema: $ref: "#/components/schemas/responseAccountName" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/balance: get: tags: - Accounts summary: View Account Balance description: This endpoint returns the balance of an account operationId: "accountsAccountIdBalanceGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents an Account Balance response content: application/json: schema: $ref: "#/components/schemas/responseAccountBalance" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/balance: get: tags: - Accounts summary: View Account Balance description: This endpoint returns the balance of an account. operationId: "accountsIdentifierTypeIdentifierBalanceGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents an Account Balance response content: application/json: schema: $ref: "#/components/schemas/responseAccountBalance" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/balance: get: tags: - Accounts summary: View Account Balance description: This endpoint returns the balance of an account. As the account is not passed as a parameter, the account is assumed to be that of the calling client. operationId: "accountsBalanceGET" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents an Account Balance response content: application/json: schema: $ref: "#/components/schemas/responseAccountBalance" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/transactions: get: tags: - Accounts summary: View Account Specific Transaction description: This endpoint returns transactions linked to a specific account operationId: "accountsAccountIdTransactionsGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' - $ref: '#/components/parameters/transactionStatus' - $ref: '#/components/parameters/transactionTypeQuery' responses: 200: description: Represent a list of Transactions content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseTransaction" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/transactions: get: tags: - Accounts summary: View Account Specific Transaction description: This endpoint returns transactions linked to a specific account. operationId: "accountsIdentifierTypeIdentifierTransactionsGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' - $ref: '#/components/parameters/transactionStatus' - $ref: '#/components/parameters/transactionTypeQuery' responses: 200: description: Represent a list of Transactions content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseTransaction" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/statemententries: get: tags: - Accounts summary: View Account Statements description: The Statement Entries API enables generic representations of transactions to be returned. Typically, the returned representations are used for the purposes of presenting a statement to the account holder. In order to return a statement, an account must be specified. operationId: "accountsAccountIdStatemententriesGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' - $ref: '#/components/parameters/transactionStatus' - $ref: '#/components/parameters/displayType' responses: 200: description: Represent a list of Statement Entries content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseStatementEntries" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/statemententries: get: tags: - Accounts summary: View Account Statements description: The Statement Entries API enables generic representations of transactions to be returned. Typically, the returned representations are used for the purposes of presenting a statement to the account holder. In order to return a statement, an account must be specified. operationId: "accountsIdentifierTypeIdentifierStatemententriesGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' - $ref: '#/components/parameters/transactionStatus' - $ref: '#/components/parameters/displayType' responses: 200: description: Represent a list of Statement Entries content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseStatementEntries" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /statemententries/{transactionReference}: get: tags: - Accounts summary: View Specific Statement description: The Statement Entries API enables generic representations of transactions to be returned. Typically, the returned representations are used for the purposes of presenting a statement to the account holder. In order to return a statement, a transaction reference must be specified. operationId: "statemententriesTransactionReferenceGET" parameters: - $ref: '#/components/parameters/transactionReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represent a list of Statement Entries content: application/json: schema: $ref: "#/components/schemas/responseStatementEntries" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # Bills APIs. These APIs allow the viewing of bill payment companies, viewing of bills and the creation and viewing of bill payments. /billcompanies: get: tags: - Bills summary: View Bill Companies description: The Bill Companies API is used to return a list of Service Providers that accept Bill Payments. operationId: "billCompaniesGET" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: 200: description: Represent a list of Bill Companies content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseBillCompanies" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /billcompanies/{serviceProvider}: get: tags: - Bills summary: View a Specific Bill Company description: This Bill Companies API is used to return a information for a specific Service Providers that accepts Bill Payments. operationId: "billCompaniesServiceProviderGET" parameters: - $ref: '#/components/parameters/serviceProvider' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Returns a specific Bill Payment Service Provider content: application/json: schema: $ref: "#/components/schemas/responseBillCompanies" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/billcompanies: get: tags: - Bills summary: View Bill Companies description: This Bill Companies API is used to return a list of Service Providers that accept Bill Payments for a given account. operationId: "accountsAccountIdBillCompaniesGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: 200: description: Represent a list of Bill Companies content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseBillCompanies" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/billcompanies: get: tags: - Bills summary: View Bill Companies description: This Bill Companies API is used to return a list of Service Providers that accept Bill Payments for a given account. operationId: "accountsIdentifierTypeIdentifierBillCompaniesGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: 200: description: Represent a list of Bill Companies content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseBillCompanies" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/bills: get: tags: - Bills summary: View Account Bills description: This endpoint returns bills linked to an account operationId: "accountsAccountIdBillsGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represent a list of Bills content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseBills" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/bills: get: tags: - Bills summary: View Account Bills description: This endpoint returns bills linked to an account. operationId: "accountsIdentifierTypeIdentifierBillsGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represent a list of Bills content: application/json: schema: type: "array" items: $ref: "#/components/schemas/responseBills" minItems: 0 headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/bills/{billReference}/payments: post: tags: - Bills summary: Create A Bill Payment description: Provided with a valid object representation, this endpoint allows for a new bill payment to be created for a specific account operationId: "accountsAccountIdBillsBillReferencePaymentsPOST" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/billReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestBillPayment' callbacks: billsPaymentsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Success Callback description: This callback communicates the final representation of the Bill Payment requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateBillPayment' # The callback consists of the same body as a synchronous /bills/payments response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability billsPaymentsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Failure Callback description: This callback communicates the information regarding a failure to receive a bill payment in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Bill Payment response content: application/json: schema: $ref: "#/components/schemas/responseBillPayment" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' get: tags: - Bills summary: "View Payments for a Bill" description: This endpoint allows for bill payments for a specific account to be returned operationId: "accountsAccountIdBillsBillReferencePaymentsGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/billReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represents a list of Bill Payments content: application/json: schema: $ref: "#/components/schemas/responseBillPayment" headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/bills/{billReference}/payments: post: tags: - Bills summary: Create A Bill Payment description: Provided with a valid object representation, this endpoint allows for a new bill payment to be created for a specific account. operationId: "accountsIdentifierTypeIdentifierBillsBillReferencePaymentsPOST" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/billReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestBillPayment' callbacks: billsPaymentsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Success Callback description: This callback communicates the final representation of the Bill Payment requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateBillPayment' # The callback consists of the same body as a synchronous /bills/payments response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability billsPaymentsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Failure Callback description: This callback communicates the information regarding a failure to receive a bill payment in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Bill Payment response content: application/json: schema: $ref: "#/components/schemas/responseBillPayment" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' get: tags: - Bills summary: "View Payments for a Bill" description: This endpoint allows for bill payments for a specific account to be returned operationId: "accountsIdentifierTypeIdentifierBillsBillReferencePaymentsGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/billReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represents a list of Bill Payments content: application/json: schema: $ref: "#/components/schemas/responseBillPayment" headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /bills/{billReference}/payments: post: tags: - Bills summary: Create A Bill Payment description: Provided with a valid object representation, this endpoint allows for a new bill payment to be created. operationId: "billsBillReferencePaymentsPOST" parameters: - $ref: '#/components/parameters/billReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestBillPayment' callbacks: billsPaymentsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Success Callback description: This callback communicates the final representation of the Bill Payment requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsReferenceSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateBillPayment' # The callback consists of the same body as a synchronous /bills/payments response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability billsPaymentsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Failure Callback description: This callback communicates the information regarding a failure to receive a bill payment in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsReferenceFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Bill Payment response content: application/json: schema: $ref: "#/components/schemas/responseBillPayment" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' get: tags: - Bills summary: "View Payments for a Bill" description: This endpoint allows for bill payments for a given bill reference to be returned operationId: "abillsBillReferencePaymentsGET" parameters: - $ref: '#/components/parameters/billReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represents a list of Bill Payments content: application/json: schema: $ref: "#/components/schemas/responseBillPayment" headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/bills/payments: post: tags: - Bills summary: Create A Bill Payment without a Bill Reference description: Provided with a valid object representation, this endpoint allows for a new bill payment to be created for a specific account operationId: "accountsAccountIdBillsBillPaymentsPOST" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestBillPayment2' callbacks: billsPaymentsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Success Callback description: This callback communicates the final representation of the Bill Payment requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateBillPayment2' # The callback consists of the same body as a synchronous /bills/payments response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability billsPaymentsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Failure Callback description: This callback communicates the information regarding a failure to receive a bill payment in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Bill Payment response content: application/json: schema: $ref: "#/components/schemas/responseBillPayment2" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' get: tags: - Bills summary: "View Payments for a Bill without a Bill Reference" description: This endpoint allows for bill payments for a specific account to be returned operationId: "accountsAccountIdBillsBillPaymentsGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represents a list of Bill Payments content: application/json: schema: $ref: "#/components/schemas/responseBillPayment2" headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/bills/payments: post: tags: - Bills summary: Create A Bill Payment without a Bill Reference description: Provided with a valid object representation, this endpoint allows for a new bill payment to be created for a specific account. operationId: "accountsIdentifierTypeIdentifierBillsBillPaymentsPOST" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestBillPayment2' callbacks: billsPaymentsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Success Callback description: This callback communicates the final representation of the Bill Payment requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateBillPayment2' # The callback consists of the same body as a synchronous /bills/payments response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability billsPaymentsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Bill Payments Failure Callback description: This callback communicates the information regarding a failure to receive a bill payment in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "billsPaymentsIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Bill Payment response content: application/json: schema: $ref: "#/components/schemas/responseBillPayment2" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' get: tags: - Bills summary: "View Payments for a Bill without a Bill Reference" description: This endpoint allows for bill payments for a specific account to be returned operationId: "accountsIdentifierTypeIdentifierBillsBillPaymentsGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' responses: 200: description: Represents a list of Bill Payments content: application/json: schema: $ref: "#/components/schemas/responseBillPayment2" headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # Debit Mandates APIs. These support creation, modification and viewing of debit mandates. /accounts/{accountId}/debitmandates: post: tags: - Debit Mandates summary: Create A Debit Mandate description: Provided with a valid object representation, this endpoint allows for a new debit mandate to be created for a specific account. operationId: "accountsAccountIdDebitmandatesPOST" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestDebitMandate' callbacks: debitMandatesSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandates Success Callback description: This callback communicates the final representation of the Debit Mandate requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "debitMandatesAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateDebitMandate' # The callback consists of the same body as a synchronous /debitmandates response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability debitMandatesFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandates Failure Callback description: This callback communicates the information regarding a failure to receive a debit mandate in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "debitMandatesAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Debit Mandate response content: application/json: schema: $ref: "#/components/schemas/responseDebitMandate" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/debitmandates: post: tags: - Debit Mandates summary: Create A Debit Mandate description: Provided with a valid object representation, this endpoint allows for a new debit mandate to be created for a specific account. operationId: "accountsIdentifierTypeIdentifierDebitmandatesPOST" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestDebitMandate' callbacks: debitMandatesSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandates Success Callback description: This callback communicates the final representation of the Debit Mandate requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "debitMandatesIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateDebitMandate' # The callback consists of the same body as a synchronous /debitmandates response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability debitMandatesFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandates Failure Callback description: This callback communicates the information regarding a failure to receive a debit mandate in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "debitMandatesIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Debit Mandate response content: application/json: schema: $ref: "#/components/schemas/responseDebitMandate" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/debitmandates/{debitMandateReference}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/debitMandateReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Debit Mandates summary: View A Debit Mandate description: This endpoint returns a specific debit mandate linked to an account operationId: "accountsAccountIdDebitmandatesDebitMandateReferenceGET" responses: 200: description: Represents a Debit Mandate response content: application/json: schema: $ref: "#/components/schemas/responseDebitMandate" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Debit Mandates summary: Update A Debit Mandate description: This endpoint updates a specific debit mandate linked to an account. The following fields are modifiable] mandateStatus, startDate, endDate, frequencyType, numberOfPayments. operationId: "accountsAccountIdDebitmandatesDebitMandateReferencePATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: debitMandatesUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandate Update Success Callback description: This callback communicates a simple message to communicate that the Debit Mandate update completed successfully. operationId: "debitMandateUpdateAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability debitMandateUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandate Update Failure Callback description: This callback communicates the information regarding a failure to update a debit mandate in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "debitMandateUpdateAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/debitmandates/{debitMandateReference}: parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/debitMandateReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Debit Mandates summary: View A Debit Mandate description: This endpoint returns a specific debit mandate linked to an account. operationId: "accountsIdentifierTypeIdentifierDebitmandatesDebitMandateReferenceGET" responses: 200: description: Represents a Debit Mandate response content: application/json: schema: $ref: "#/components/schemas/responseDebitMandate" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Debit Mandates summary: Update A Debit Mandate description: This endpoint updates a specific debit mandate linked to an account. The following fields are modifiable] mandateStatus, startDate, endDate, frequencyType, numberOfPayments. operationId: "accountsIdentifierTypeIdentifierDebitmandatesDebitMandateReferencePATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: debitMandatesUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandate Update Success Callback description: This callback communicates a simple message to communicate that the Debit Mandate update completed successfully. operationId: "debitMandateUpdateIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability debitMandateUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Debit Mandate Update Failure Callback description: This callback communicates the information regarding a failure to update a debit mandate in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "debitMandateUpdateIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # Links APIs. These support creation, modification and viewing of links. /accounts/{accountId}/links: post: tags: - Links summary: Create A Link description: Provided with a valid object representation, this endpoint allows a new link to be created for a specific account operationId: "accountsAccountIdLinksPOST" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestLink' callbacks: linksSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Links Success Callback description: This callback communicates the final representation of the Account Link requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "linksAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateLink' # The callback consists of the same body as a synchronous /links response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability linksFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Links Failure Callback description: This callback communicates the information regarding a failure to receive an account link in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "linksAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Link response content: application/json: schema: $ref: "#/components/schemas/responseLink" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/links: post: tags: - Links summary: Create A Link description: Provided with a valid object representation, this endpoint allows a new link to be created for a specific account. operationId: "accountsIdentifierTypeIdentifierLinksPOST" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestLink' callbacks: linksSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Links Success Callback description: This callback communicates the final representation of the Account Link requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "linksIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateLink' # The callback consists of the same body as a synchronous /links response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability linksFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Links Failure Callback description: This callback communicates the information regarding a failure to receive an account link in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "linksIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Link response content: application/json: schema: $ref: "#/components/schemas/responseLink" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/links/{linkReference}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/linkReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Links summary: View A Link description: This endpoint returns a specific link operationId: "accountsAccountIdLinksLinkReferenceGET" responses: 200: description: Represents a Link response" content: application/json: schema: $ref: "#/components/schemas/responseLink" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Links summary: Update A Link description: This endpoint updates a specific link. mode and status fields are modifiable. operationId: "accountsAccountIdLinksLinkReferencePATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: linksUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Link Update Success Callback description: This callback communicates a simple message to communicate that the Account Link update completed successfully. operationId: "linkUpdateAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability linkUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Link Update Failure Callback description: This callback communicates the information regarding a failure to update an account link in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "linkUpdateAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/links/{linkReference}: parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/linkReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Links summary: View A Link description: This endpoint returns a specific link for a given account. operationId: "accountsIdentifierTypeIdentifierLinksLinkReferenceGET" responses: 200: description: Represents a Link response content: application/json: schema: $ref: "#/components/schemas/responseLink" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Links summary: Update A Link description: This endpoint updates a specific link. mode and status fields are modifiable. operationId: "accountsIdentifierTypeIdentifierLinksLinkReferencePATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: linksUpdateSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Link Update Success Callback description: This callback communicates a simple message to communicate that the Account Link update completed successfully. operationId: "linkUpdateIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability linkUpdateFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Account Link Update Failure Callback description: This callback communicates the information regarding a failure to update an account link in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "linkUpdateIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # Quotations APIs. These support creation and viewing of quotations which can contain one or multiple quotes. /quotations: post: tags: - Quotations summary: Create A New Quotation description: Provided with a valid object representation, this endpoint allows for a new quotation to be created. operationId: "quotationsPOST" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestQuotation' callbacks: quotationsSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Quotations Success Callback description: This callback communicates the final representation of the Quotation requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "quotationsSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateQuotation' # The callback consists of the same body as a synchronous /quotations response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability quotationsFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Quotations Failure Callback description: This callback communicates the information regarding a failure to receive a quotation in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "quotationsFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents a Quotation response content: application/json: schema: $ref: "#/components/schemas/responseQuotation" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /quotations/{quotationReference}: get: tags: - Quotations summary: View A Quotation description: This endpoint returns a specific quotation operationId: "quotationsQuotationReferenceGET" parameters: - $ref: '#/components/parameters/quotationReference' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' responses: 200: description: Represents a Quotation response content: application/json: schema: $ref: "#/components/schemas/responseQuotation" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # Authorisation Codes APIs. These support creation, modification and viewing of authorisation codes. /accounts/{accountId}/authorisationcodes: post: tags: - Authorisation Codes summary: Create an Authorisation Code description: this endpoint allows allows a mobile money payer or payee to generate a code which when presented to the other party, can be redeemed for an amount set by the payer or payee, depending upon the use case operationId: "accountsAccountIdAuthorisationcodesPOST" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestAuthorisationCode' callbacks: authorisationCodesSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Codes Success Callback description: This callback communicates the final representation of the Authorisation Code requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "authorisationCodesAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateAuthorisationCode' # The callback consists of the same body as a synchronous /authorisationcodes response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability authorisationCodesFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Codes Failure Callback description: This callback communicates the information regarding a failure to receive an authorisation code in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "authorisationCodesAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents an Authorisation Code response content: application/json: schema: $ref: "#/components/schemas/responseAuthorisationCode" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' get: tags: - Authorisation Codes summary: View Authorisation Codes for a given account description: This endpoint allows allows a mobile money payer or payee to view authorisation codes for a given account. operationId: "accountsAccountIdAuthorisationcodesGET" parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' - $ref: '#/components/parameters/codeState' responses: 200: description: Represents an authorisation codes response content: application/json: schema: $ref: "#/components/schemas/responseAuthorisationCode" headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/authorisationcodes: post: tags: - Authorisation Codes summary: Create an Authorisation Code via an account identifier. description: This endpoint allows allows a mobile money payer or payee to generate a code which when presented to the other party, can be redeemed for an amount set by the payer or payee, depending upon the use case. operationId: "accountsIdentifierTypeIdentifierAuthorisationCodesPOST" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Callback-URL' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' requestBody: $ref: '#/components/requestBodies/requestAuthorisationCode' callbacks: authorisationCodesSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Codes Success Callback description: This callback communicates the final representation of the Authorisation Code requested by the client. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "authorisationCodesIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateAuthorisationCode' # The callback consists of the same body as a synchronous /authorisationcodes response responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability authorisationCodesFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Codes Failure Callback description: This callback communicates the information regarding a failure to receive an authorisation code in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "authorisationCodesIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 201: description: Represents an Authorisation Code response content: application/json: schema: $ref: "#/components/schemas/responseAuthorisationCode" headers: 'X-Date': $ref: '#/components/headers/X-Date' 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' get: tags: - Authorisation Codes summary: View Authorisation Codes for a given account description: This endpoint allows allows a mobile money payer or payee to view authorisation codes for a given account. operationId: "accountsIdentifierTypeIdentifierAuthorisationCodesGET" parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/fromDateTime' - $ref: '#/components/parameters/toDateTime' - $ref: '#/components/parameters/codeState' responses: 200: description: Represents an authorisation codes response content: application/json: schema: $ref: "#/components/schemas/responseAuthorisationCode" headers: 'X-Date': $ref: '#/components/headers/X-Date' 'X-Records-Available-Count': $ref: '#/components/headers/X-Records-Available-Count' 'X-Records-Returned-Count': $ref: '#/components/headers/X-Records-Returned-Count' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{accountId}/authorisationcodes/{authorisationCode}: parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/authorisationCode' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Authorisation Codes summary: View an Authorisation Code description: This endpoint returns a specific Authorisation Code linked to an account operationId: "accountsAccountIdAuthorisationCodeAuthorisationCodeGET" responses: 200: description: Represents an Authorisation Code response content: application/json: schema: $ref: "#/components/schemas/responseAuthorisationCode" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Authorisation Codes summary: Update an Authorisation Code description: This endpoint updates a specific Authorisation Code linked to an account. The only permissable modification is to set codeState to cancelled. operationId: "accountsAccountIdAuthorisationCodesAuthorisationCodePATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: authorisationCodesSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Code Update Success Callback description: This callback communicates a simple message to communicate that the Authorisation Code update completed successfully. operationId: "authorisationCodeUpdateAccountIdSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability authorisationCodesFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Code Update Failure Callback description: This callback communicates the information regarding a failure to update an authorisaton code in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "authorisationCodeAccountIdFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /accounts/{identifierType}/{identifier}/authorisationcodes/{authorisationCode}: parameters: - $ref: '#/components/parameters/identifierType' - $ref: '#/components/parameters/identifier' - $ref: '#/components/parameters/authorisationCode' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier-Type' - $ref: '#/components/parameters/X-Account-Holding-Institution-Identifier' get: tags: - Authorisation Codes summary: View an Authorisation Code description: This endpoint returns a specific Authorisation Code linked to an account. operationId: "accountsIdentifierTypeIdentifierAuthorisationCodesAuthorisationCodeGET" responses: 200: description: Represents an Authorisation Code response content: application/json: schema: $ref: "#/components/schemas/responseAuthorisationCode" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: tags: - Authorisation Codes summary: Cancel an Authorisation Code description: This endpoint updates a specific Authorisation Code linked to an account. The only permissable modification is to set codeState to cancelled. operationId: "accountsIdentifierTypeIdentifierAuthorisationCodesAuthorisationCodePATCH" parameters: - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Callback-URL' requestBody: $ref: '#/components/requestBodies/genericPatch' callbacks: authorisationCodesSuccessEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Code Update Success Callback description: This callback communicates a simple message to communicate that the Authorisation Code update completed successfully. operationId: "authorisationCodeUpdateIdentifierTypeIdentifierSuccessPUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/genericUpdateSuccess' responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability authorisationCodesFailureEvent: '{$request.header.X-Callback-URL}': # This is the callback URL provided by the client in the request header put: summary: Authorisation Code Update Failure Callback description: This callback communicates the information regarding a failure to update an authorisaton code in the form of an error object. The client endpoint is identified from the X-Callback-URL supplied in the POST request header. operationId: "authorisationCodeIdentifierTypeIdentifierFailurePUT" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-User-Bearer' - $ref: '#/components/parameters/X-Client-Id' requestBody: $ref: '#/components/requestBodies/updateError' # The callback returns the error object in the event of failure responses: 204: description: Your server returns this code if it accepts the callback 400: description: Your server returns this code if it rejects the callback due to a violation of a business rule 401: description: Your server returns this code if it rejects the callback due to an authorisation failure 404: description: Your server returns this code if it rejects the callback due to a failure to identify the target resource 500: description: Your server returns this code if it rejects the callback due to general server-side issue 503: description: Your server returns this code if it rejects the callback due to systems unavailability responses: 202: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # Support APIs. These support checking for server health, request state polling and missing response retrieval. /heartbeat: get: tags: - Supporting summary: Check API availability description: This endpoint returns the current status of the API operationId: "heartbeatGET" parameters: - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-Client-Id' responses: 200: description: Represents a Heartbeat response content: application/json: schema: $ref: "#/components/schemas/responseHeartbeat" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /requeststates/{serverCorrelationId}: get: tags: - Supporting summary: View A Request State description: This endpoint returns a specific request state operationId: "requeststatesServerCorrelationIdGET" parameters: - $ref: '#/components/parameters/serverCorrelationId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' responses: 200: description: Represents an Asynchronous response content: application/json: schema: $ref: "#/components/schemas/requestStateObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' patch: deprecated: true # This Patch operation is to be deprecated as asynchronous callbacks will be handled by Swagger Callback definitions using PUT. tags: - Supporting summary: Update A Request State description: This endpoint updates a specific request state. This operation is to be deprecated. Please refer to Callback definitions for the revised approach to implementing asynchronous callbacks. operationId: "requeststatesServerCorrelationIdPATCH" parameters: - $ref: '#/components/parameters/serverCorrelationId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-CorrelationID' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' requestBody: $ref: '#/components/requestBodies/genericPatch' responses: 204: description: An empty response is returned for a synchronous successful patch. 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' /responses/{clientCorrelationId}: get: tags: - Supporting summary: View A Response description: This endpoint returns a specific response. operationId: "responsesClientCorrelationIdGET" parameters: - $ref: '#/components/parameters/clientCorrelationId' - $ref: '#/components/parameters/X-Date' - $ref: '#/components/parameters/X-API-Key' - $ref: '#/components/parameters/X-Client-Id' - $ref: '#/components/parameters/X-Content-Hash' - $ref: '#/components/parameters/X-User-Credential-1' - $ref: '#/components/parameters/X-User-Credential-2' - $ref: '#/components/parameters/X-Channel' responses: 200: description: Represents an Response object response content: application/json: schema: $ref: "#/components/schemas/responseResponse" headers: 'X-Date': $ref: '#/components/headers/X-Date' 400: description: Represents an Error Caused by the Violation of a Business Rule content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 401: description: Represents an Error Caused by an Authorisation Failure content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 404: description: Represents an Error Caused by a Failure to Identify the Target Resource content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 500: description: Represents an Error Caused by a General Server-Side Issue content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' 503: description: Represents an Error Caused by System Unavailability content: application/json: schema: $ref: "#/components/schemas/errorObject" headers: 'X-Date': $ref: '#/components/headers/X-Date' # All the GSMA Mobile Money API Objects and Fields are defined here. components: schemas: amount: type: "string" minLength: 1 maxLength: 23 pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[0-9])?$ example: "15.21" currency: type: "string" enum: - "AED" - "AFN" - "ALL" - "AMD" - "ANG" - "AOA" - "ARS" - "AUD" - "AWG" - "AZN" - "BAM" - "BBD" - "BDT" - "BGN" - "BHD" - "BIF" - "BMD" - "BND" - "BOB" - "BOV" - "BRL" - "BSD" - "BTN" - "BWP" - "BYN" - "BZD" - "CAD" - "CDF" - "CHE" - "CHF" - "CHW" - "CLF" - "CLP" - "CNY" - "COP" - "COU" - "CRC" - "CUC" - "CUP" - "CVE" - "CZK" - "DJF" - "DKK" - "DOP" - "DZD" - "EGP" - "ERN" - "ETB" - "EUR" - "FJD" - "FKP" - "GBP" - "GEL" - "GHS" - "GIP" - "GMD" - "GNF" - "GTQ" - "GYD" - "HKD" - "HNL" - "HRK" - "HTG" - "HUF" - "IDR" - "ILS" - "INR" - "IQD" - "IRR" - "ISK" - "JMD" - "JOD" - "JPY" - "KES" - "KGS" - "KHR" - "KMF" - "KPW" - "KRW" - "KWD" - "KYD" - "KZT" - "LAK" - "LBP" - "LKR" - "LRD" - "LSL" - "LYD" - "MAD" - "MDL" - "MGA" - "MKD" - "MMK" - "MNT" - "MOP" - "MRO" - "MUR" - "MVR" - "MWK" - "MXN" - "MXV" - "MYR" - "MZN" - "NAD" - "NGN" - "NIO" - "NOK" - "NPR" - "NZD" - "OMR" - "PAB" - "PEN" - "PGK" - "PHP" - "PKR" - "PLN" - "PYG" - "QAR" - "RON" - "RSD" - "RUB" - "RWF" - "SAR" - "SBD" - "SCR" - "SDG" - "SEK" - "SGD" - "SHP" - "SLL" - "SOS" - "SRD" - "SSP" - "STD" - "SVC" - "SYP" - "SZL" - "THB" - "TJS" - "TMT" - "TND" - "TOP" - "TRY" - "TTD" - "TWD" - "TZS" - "UAH" - "UGX" - "USD" - "USN" - "UYI" - "UYU" - "UZS" - "VEF" - "VND" - "VUV" - "WST" - "XAF" - "XAG" - "XAU" - "XBA" - "XBB" - "XBC" - "XBD" - "XCD" - "XDR" - "XOF" - "XPD" - "XPF" - "XPT" - "XSU" - "XTS" - "XUA" - "XXX" - "YER" - "ZAR" - "ZMW" - "ZWL" type: type: "string" description: The harmonised Transaction Type. enum: - "billpay" - "deposit" - "disbursement" - "transfer" - "merchantpay" - "inttransfer" - "adjustment" - "reversal" - "withdrawal" typeReversal: type: "string" description: The harmonised Transaction Type. enum: - "adjustment" - "reversal" example: "reversal" subType: type: "string" description: A non-harmonised sub-classification of the type of transaction. Values are not fixed, and usage will vary according to Provider. minLength: 0 maxLength: 256 descriptionText: type: "string" description: Free format text description of the transaction provided by the client. This can be provided as a reference for the receiver on a notification SMS and on an account statement. minLength: 0 maxLength: 160 requestDate: type: "string" format: "date-time" description: The date and time of the request as supplied by the client. requestingOrganisationTransactionReference: type: "string" description: A reference provided by the requesting organisation that is to be associated with the transaction. minLength: 0 maxLength: 256 oneTimeCode: type: "string" description: A one-time code that can be supplied in the request or can be generated in the response depending upon the use case. An authorisation code can be supplied in this field for requests that have been pre-authorised. minLength: 0 maxLength: 256 geoCode: type: "string" description: Indicates the geographic location from where the transaction was initiated. minLength: 0 maxLength: 256 pattern: "^(-?(90|(\\d|[1-8]\\d)(\\.\\d{1,6}){0,1}))\\,{1}(-?(180|(\\d|\\d\\d|1[0-7]\\d)(\\.\\d{1,6}){0,1}))$" example: "37.423825,-122.082900" originalTransactionReference: type: "string" description: For reversals and refunds, this field indicates the transaction which is the subject of the reversal. minLength: 0 maxLength: 256 servicingIdentity: type: "string" description: The field is used to identify the servicing identity for transactions, e.g. till, POS ID, assistant ID. minLength: 0 maxLength: 256 requestingLei: type: "string" description: Legal Entity Identifier of the organisation that is requesting the transaction. minLength: 0 maxLength: 20 pattern: "^[A-Z0-9]{4}00[A-Z0-9]{12}\\d{2}$" deprecated: true receivingLei: type: "string" description: Legal Entity Identifier of the organisation that is receiving the transaction. minLength: 0 maxLength: 20 pattern: "^[A-Z0-9]{4}00[A-Z0-9]{12}\\d{2}$" deprecated: true transactionStatus: type: "string" description: Indicates the status of the transaction as stored by the API provider. minLength: 1 maxLength: 256 dateCreated: type: "string" format: "date-time" deprecated: true # this field is replaced by creationDate description: Date and time when the object was created by the API Provider. creationDate: type: "string" format: "date-time" description: Date and time when the object was created by the API Provider. dateModified: type: "string" format: "date-time" deprecated: true # this field is replaced by modificationDate description: Date and time when the object was modified by the API Provider. modificationDate: type: "string" format: "date-time" description: Date and time when the object was modified by the API Provider. transactionReference: type: "string" description: Unique reference for the transaction. This is returned in the response by API provider. minLength: 1 maxLength: 256 transactionReceipt: type: "string" description: Transaction receipt number as notified to the parties. This may differ from the Transaction Reference. minLength: 0 maxLength: 256 quotationReference: type: "string" description: Reference for the quotation that was provided to the sender. minLength: 1 maxLength: 256 quoteId: type: "string" description: The specific quote associated with the quotation. minLength: 1 maxLength: 256 remittancePurpose: type: "string" description: Field providing a description of the reason for the international remittance. minLength: 0 maxLength: 256 relationshipSender: type: "string" description: Indicates the relationship (if any) between the sender and the receiver. minLength: 0 maxLength: 256 deliveryMethod: type: "string" enum: - "directtoaccount" - "agent" - "personaldelivery" party: type: "object" required: - "key" - "value" properties: key: type: "string" description: Provides the account identifier type. minLength: 1 maxLength: 256 example: "msisdn" value: type: "string" description: Provides the account identifier type value. minLength: 1 maxLength: 256 example: "+33555123456" creditPartyArray: type: "array" description: A collection of key/value pairs that enable the party to be identified. Keys include MSISDN and Wallet Identifier. items: $ref: "#/components/schemas/party" maxItems: 10 minItems: 1 debitPartyArray: type: "array" description: A collection of key/value pairs that enable the party to be identified. Keys include MSISDN and Wallet Identifier. items: $ref: "#/components/schemas/party" maxItems: 10 minItems: 1 payee: type: "array" description: A collection of key/value pairs that enable the payee to be identified. Keys include MSISDN and Wallet Identifier. items: $ref: "#/components/schemas/party" maxItems: 10 minItems: 1 feesArray: type: "array" description: Returns all fees that are applicable to the object. items: $ref: "#/components/schemas/fees" maxItems: 20 minItems: 1 metadataArray: type: "array" description: A collection of key/value pairs. These can be used to populate additional properties that describe administrative information regarding the resource. items: $ref: "#/components/schemas/metadata" maxItems: 20 customDataArray: type: "array" description: A collection of key/value pairs. These can be used to populate provider specific fields. items: $ref: "#/components/schemas/customData" maxItems: 20 fees: type: "object" required: - "feeType" - "feeCurrency" - "feeAmount" properties: feeType: type: "string" description: Defines the type of fee. minLength: 1 maxLength: 256 feeAmount: description: Defines the amount of the fee. allOf: - $ref: '#/components/schemas/amount' example: "5.46" feeCurrency: description: Defines the currency for the given fee. allOf: - $ref: '#/components/schemas/currency' metadata: type: "object" required: - "key" - "value" properties: key: type: "string" description: Identifies the type of additional field. minLength: 1 maxLength: 256 value: type: "string" description: Identifies the value of the additional field. minLength: 1 maxLength: 256 customData: type: "object" required: - "key" - "value" properties: key: type: "string" description: Identifies the type of additional field. minLength: 1 maxLength: 256 value: type: "string" description: Identifies the value of the additional field. minLength: 1 maxLength: 256 nationality: type: "string" enum: - "AD" - "AE" - "AF" - "AG" - "AI" - "AL" - "AM" - "AO" - "AQ" - "AR" - "AS" - "AT" - "AU" - "AW" - "AX" - "AZ" - "BA" - "BB" - "BD" - "BE" - "BF" - "BG" - "BH" - "BI" - "BJ" - "BL" - "BM" - "BN" - "BO" - "BQ" - "BR" - "BS" - "BT" - "BV" - "BW" - "BY" - "BZ" - "CA" - "CC" - "CD" - "CF" - "CG" - "CH" - "CI" - "CK" - "CL" - "CM" - "CN" - "CO" - "CR" - "CU" - "CV" - "CW" - "CX" - "CY" - "CZ" - "DE" - "DJ" - "DK" - "DM" - "DO" - "DZ" - "EC" - "EE" - "EG" - "EH" - "ER" - "ES" - "ET" - "FI" - "FJ" - "FK" - "FM" - "FO" - "FR" - "GA" - "GB" - "GD" - "GE" - "GF" - "GG" - "GH" - "GI" - "GL" - "GM" - "GN" - "GP" - "GQ" - "GR" - "GS" - "GT" - "GU" - "GW" - "GY" - "HK" - "HM" - "HN" - "HR" - "HT" - "HU" - "ID" - "IE" - "IL" - "IM" - "IN" - "IO" - "IQ" - "IR" - "IS" - "IT" - "JE" - "JM" - "JO" - "JP" - "KE" - "KG" - "KH" - "KI" - "KM" - "KN" - "KP" - "KR" - "KW" - "KY" - "KZ" - "LA" - "LB" - "LC" - "LI" - "LK" - "LR" - "LS" - "LT" - "LU" - "LV" - "LY" - "MA" - "MC" - "MD" - "ME" - "MF" - "MG" - "MH" - "MK" - "ML" - "MM" - "MN" - "MO" - "MP" - "MQ" - "MR" - "MS" - "MT" - "MU" - "MV" - "MW" - "MX" - "MY" - "MZ" - "NA" - "NC" - "NE" - "NF" - "NG" - "NI" - "NL" - "NO" - "NP" - "NR" - "NU" - "NZ" - "OM" - "PA" - "PE" - "PF" - "PG" - "PH" - "PK" - "PL" - "PM" - "PN" - "PR" - "PS" - "PT" - "PW" - "PY" - "QA" - "RE" - "RO" - "RS" - "RU" - "RW" - "SA" - "SB" - "SC" - "SD" - "SE" - "SG" - "SH" - "SI" - "SJ" - "SK" - "SL" - "SM" - "SN" - "SO" - "SR" - "SS" - "ST" - "SV" - "SX" - "SY" - "SZ" - "TC" - "TD" - "TF" - "TG" - "TH" - "TJ" - "TK" - "TL" - "TM" - "TN" - "TO" - "TR" - "TT" - "TV" - "TW" - "TZ" - "UA" - "UG" - "UM" - "US" - "UY" - "UZ" - "VA" - "VC" - "VE" - "VG" - "VI" - "VN" - "VU" - "WF" - "WS" - "YE" - "YT" - "ZA" - "ZM" - "ZW" dateOfBirth: type: "string" format: "date" description: Birth date of the KYC subject. example: "2000-11-20" occupation: type: "string" description: Occupation of the KYC subject. minLength: 0 maxLength: 256 employerName: type: "string" description: Employer name of the KYC subject. minLength: 0 maxLength: 256 contactPhone: type: "string" description: Contact phone number (mobile or landline) of the KYC subject. minLength: 0 maxLength: 256 gender: type: "string" enum: - "m" - "f" - "u" description: Gender of the KYC subject. emailAddress: type: "string" description: Email address of the KYC subject. minLength: 0 maxLength: 256 internationalTransferInformation: type: "object" description: A collection of properties detailing information specifically used for international transfers. required: - "originCountry" properties: quotationReference: $ref: '#/components/schemas/quotationReference' quoteId: $ref: '#/components/schemas/quoteId' originCountry: allOf: - $ref: '#/components/schemas/nationality' description: The originating country of the transaction, i.e. the country where the transaction was initiated. deliveryMethod: allOf: - $ref: '#/components/schemas/deliveryMethod' description: The recipient delivery method as chosen by the sender. receivingCountry: allOf: - $ref: '#/components/schemas/nationality' description: Destination Country of the international transfer. relationshipSender: $ref: '#/components/schemas/relationshipSender' remittancePurpose: $ref: '#/components/schemas/remittancePurpose' sendingServiceProviderCountry: allOf: - $ref: '#/components/schemas/nationality' description: The country of the sending service provider that holds the account of the sender. internationalTransferInformationResponse: type: "object" required: - "originCountry" properties: originCountry: allOf: - $ref: '#/components/schemas/nationality' description: The originating country of the transaction, i.e. the country where the transaction commenced. quotationReference: $ref: '#/components/schemas/quotationReference' quoteId: $ref: '#/components/schemas/quoteId' deliveryMethod: allOf: - $ref: '#/components/schemas/deliveryMethod' description: The recipient delivery method as chosen by the sender. receivingCountry: allOf: - $ref: '#/components/schemas/nationality' description: Destination country of the international transfer. relationshipSender: $ref: '#/components/schemas/relationshipSender' remittancePurpose: $ref: '#/components/schemas/remittancePurpose' recipientBlockingReason: $ref: '#/components/schemas/recipientBlockingReason' senderBlockingReason: $ref: '#/components/schemas/senderBlockingReason' sendingServiceProviderCountry: allOf: - $ref: '#/components/schemas/nationality' description: The country of the sending service provider that holds the account of the sender. idDocumentArray: type: "array" description: An array of properties containing the forms of identification that are associated with the subject. items: $ref: "#/components/schemas/idDocument" maxItems: 10 minItems: 0 idDocument: type: "object" required: - "idType" properties: idType: type: "string" enum: - "passport" - "nationalregistration" - "otherId" - "drivinglicence" - "socialsecurity" - "alienregistration" - "nationalidcard" - "employer" - "taxid" - "seniorcitizenscard" - "marriagecertificate" - "birthcertificate" - "healthcard" - "votersid" - "villageelderLetter" - "pancard" - "officialletter" description: Indicates the type of identification for the KYC subject, e.g. passport, driving licence etc. idNumber: type: "string" description: Reference pertaining to the type of identification for the KYC subject. minLength: 0 maxLength: 256 issueDate: type: "string" format: "date" description: Date of issue for the identification document. example: "2018-11-20" expiryDate: type: "string" format: "date" description: Date of expiry for the identification document. example: "2018-11-20" issuer: type: "string" description: Indicates the organisation/government entity that issued the ID document. minLength: 0 maxLength: 256 issuerPlace: type: "string" description: Place of issue for the identification type. minLength: 0 maxLength: 256 issuerCountry: description: Country where the identification type was issued. allOf: - $ref: '#/components/schemas/nationality' otherIddescription: type: "string" description: Where an ID Type of otherid is specified, a description of the type of identification can be provided in this field. minLength: 0 maxLength: 256 postalAddress: type: "object" required: - "country" properties: addressLine1: type: "string" description: First line of the address. minLength: 0 maxLength: 256 addressLine2: type: "string" description: Second line of the address. minLength: 0 maxLength: 256 addressLine3: type: "string" description: Third line of the address. minLength: 0 maxLength: 256 city: type: "string" description: City/Town minLength: 0 maxLength: 256 stateProvince: type: "string" description: State or Province minLength: 0 maxLength: 256 postalCode: type: "string" description: Postal Code minLength: 0 maxLength: 256 country: description: Country" allOf: - $ref: '#/components/schemas/nationality' subjectName: type: "object" properties: title: type: "string" description: The given title of the KYC subject, e.g. Mr, Mrs, Dr. minLength: 0 maxLength: 256 firstName: type: "string" description: First name (also referred to as given name) of the KYC subject. minLength: 0 maxLength: 256 middleName: type: "string" description: Middle Name of the KYC subject. minLength: 0 maxLength: 256 lastName: type: "string" description: Surname (also referred to as last or family name) of the KYC subject. minLength: 0 maxLength: 256 fullName: type: "string" description: The full name of the KYC subject. minLength: 0 maxLength: 256 nativeName: type: "string" description: The full name expressed as in the native language. minLength: 0 maxLength: 256 kyc: type: "object" properties: birthCountry: description: The country of birth of the KYC subject. allOf: - $ref: '#/components/schemas/nationality' contactPhone: $ref: '#/components/schemas/contactPhone' dateOfBirth: $ref: '#/components/schemas/dateOfBirth' emailAddress: $ref: '#/components/schemas/emailAddress' employerName: $ref: '#/components/schemas/employerName' gender: $ref: '#/components/schemas/gender' idDocument: $ref: '#/components/schemas/idDocumentArray' nationality: description: Nationality of the KYC subject. allOf: - $ref: '#/components/schemas/nationality' occupation: $ref: '#/components/schemas/occupation' postalAddress: $ref: '#/components/schemas/postalAddress' subjectName: $ref: '#/components/schemas/subjectName' batchTitle: type: "string" description: Client-provided title for the batch. minLength: 0 maxLength: 256 batchDescription: type: "string" description: Client-provided description of the batch. minLength: 0 maxLength: 256 processingFlag: type: "boolean" description: Indicates whether the batch is currently undergoing processing by the API Provider. scheduledStartDate: type: "string" format: "date-time" description: If the batch has been scheduled, the expected start time is provided here. batchStatus: type: "string" enum: - "created" - "approved" - "completed" approvalDate: type: "string" format: "date-time" description: Indicates when the batch was approved as recorded by the API. completionDate: type: "string" format: "date-time" description: Indicates when the batch was completed as recorded by the API. transactionCompletionDate: type: "string" format: "date-time" description: Date and time indicating when the transaction was completed. completedDate: type: "string" format: "date-time" deprecated: true # this field is replaced by completionDate description: Indicates when the batch was completed as recorded by the API. transactionCompletedDate: type: "string" format: "date-time" deprecated: true # this field is replaced by transactionCompletionDate description: Date and time indicating when the transaction was completed. rejectionCount: type: "number" format: "int32" description: Indicates the number of records that have been rejected, either during parsing or during final processing. minimum: 0 parsingSuccessCount: type: "number" format: "int32" description: Indicates the number of records that have been parsed successfully. minimum: 0 completedCount: type: "number" format: "int32" description: Indicates the number of records that have been successful completed. minimum: 0 batchId: type: "string" description: Identifier for the Batch that is assigned by the API provider. This ID is used by the client on subsequent GET or PATCH methods. minLength: 1 maxLength: 256 rejectionDate: type: "string" format: "date-time" description: Date and time of the rejection. dateRejected: type: "string" format: "date-time" deprecated: true # this field is replaced by rejectionDate description: Date and time of the rejection. rejectionReason: type: "string" description: The reason for the transaction request as indicated by the API provider. minLength: 1 maxLength: 256 link: type: "string" description: Provides a URL to the resource. minLength: 1 maxLength: 256 lei: type: "string" description: Legal Entity Identifier. minLength: 0 maxLength: 20 pattern: "^[A-Z0-9]{4}00[A-Z0-9]{12}\\d{2}$" example: "5493000IBP32UQZ0KL24" identityRequest: type: "object" required: - "identityKyc" - "accountRelationship" properties: identityKyc: $ref: '#/components/schemas/kyc' accountRelationship: $ref: '#/components/schemas/accountRelationship' kycVerificationStatus: $ref: '#/components/schemas/kycVerificationStatus' kycVerificationEntity: $ref: '#/components/schemas/kycVerificationEntity' kycLevel: $ref: '#/components/schemas/kycLevel' customData: $ref: '#/components/schemas/customDataArray' identityResponse: type: "object" required: - "identityId" - "identityType" - "identityKyc" - "accountRelationship" properties: identityId: $ref: '#/components/schemas/identityId' identityType: $ref: '#/components/schemas/identityType' identityStatus: $ref: '#/components/schemas/identityStatus' identityKyc: $ref: '#/components/schemas/kyc' accountRelationship: $ref: '#/components/schemas/accountRelationship' kycVerificationStatus: $ref: '#/components/schemas/kycVerificationStatus' kycVerificationEntity: $ref: '#/components/schemas/kycVerificationEntity' kycLevel: $ref: '#/components/schemas/kycLevel' customData: $ref: '#/components/schemas/customDataArray' accountIdentifiersArray: type: "array" description: A collection of key/value pairs that enable the account to be identified. Keys include MSISDN and Wallet Identifier. items: $ref: "#/components/schemas/party" maxItems: 10 minItems: 1 identityRequestArray: type: "array" description: An array containing the details of each identity associated with an account. items: $ref: "#/components/schemas/identityRequest" maxItems: 20 minItems: 1 identityResponseArray: type: "array" description: An array containing the details of each identity associated with an account. items: $ref: "#/components/schemas/identityResponse" maxItems: 20 minItems: 1 accountType: type: "string" description: A non-harmonised field that indicates the type of the account. minLength: 0 maxLength: 256 accountSubStatus: type: "string" description: Field can be used to return a provider-specific status for the account. minLength: 0 maxLength: 256 commissionEarnedArray: type: "array" description: Returns all commission earned by the registering entity for the creation of the account. items: $ref: "#/components/schemas/commissionEarned" maxItems: 20 minItems: 1 commissionEarned: type: "object" required: - "commissionType" - "commissionCurrency" - "commissionAmount" properties: commissionType: type: "string" description: Defines the type of commission. minLength: 1 maxLength: 256 commissionAmount: description: Defines the amount of the commission. allOf: - $ref: '#/components/schemas/amount' example: "5.46" commissionCurrency: description: Defines the currency for the given commission. allOf: - $ref: '#/components/schemas/currency' registeringEntity: type: "string" description: The entity that registered the account, for example, a mobile money agent. minLength: 0 maxLength: 256 currentBalance: description: Current outstanding balance on the account. allOf: - $ref: '#/components/schemas/amount' example: "15.00" availableBalance: description: Indicates the balance that is able to be debited for an account. This balance is only provided on some API provider systems. allOf: - $ref: '#/components/schemas/amount' example: "15.00" reservedBalance: description: Indicates the portion of the balance that is reserved, i.e. intended to be debited. This balance is only provided on some API provider systems. allOf: - $ref: '#/components/schemas/amount' example: "15.00" unclearedBalance: description: Indicates the sum of uncleared funds in an account, i.e. the funds that are awaiting a credit confirmation. allOf: - $ref: '#/components/schemas/amount' example: "15.00" identityId: type: "string" description: A unique id for the identity as assigned by the API Provider. minLength: 1 maxLength: 256 identityType: type: "string" enum: - "individual" description: Indicates the type of the identity. Currently, only ‘individual’ is supported. identityStatus: type: "string" description: A unique id for the identity as assigned by the API Provider. minLength: 0 maxLength: 256 accountRelationship: type: "string" enum: - "accountholder" description: Describes the relationship that the identity holds with the account. kycVerificationStatus: type: "string" enum: - "verified" - "unverified" - "rejected" description: Indicates the status of the identity’s KYC verification. kycVerificationEntity: type: "string" description: Indicates the entity (e.g. mobile money agent) that has verified the KYC of the identity. minLength: 0 maxLength: 256 kycLevel: type: "integer" format: "int32" example: "1" description: Indicates the KYC level that the identity is associated with. accountStatus: type: "string" enum: - "available" - "unavailable" - "unregistered" description: Indicates a harmonised representation of the account status. This will be shown as available, unavailable or unregistered. minLength: 1 maxLength: 256 subStatus: type: "string" description: Can be used to return a provider-specific status for the account. minLength: 0 maxLength: 256 displayType: type: "string" description: The transaction type that is to be used for presentation to the account holder as determined by the API provider. This is not necessarily the actual transaction type. minLength: 0 maxLength: 256 companyName: type: "string" description: Display Name for the Service Provider. maxLength: 256 serviceProvider: type: "string" description: Service Provider Reference Code. maxLength: 256 serviceProviderType: type: "string" description: Type of Service Provider that accepts payments. maxLength: 256 serviceProviderSubType: type: "string" description: Sub-Type of Service Provider. maxLength: 256 serviceProviderPaymentReference: type: "string" description: Reference for the payment generated by the service provider. minLength: 0 maxLength: 256 billPaymentStatus: type: "string" description: Indicates the status of the bill payment as stored by the API provider. minLength: 0 maxLength: 256 requestingOrganisation: type: "object" description: An object that details the originating organisation of the request. required: - "requestingOrganisationIdentifierType" - "requestingOrganisationIdentifier" properties: requestingOrganisationIdentifierType: type: "string" description: Identifies the identifier type of the requesting organisation. enum: - "lei" - "swiftbic" - "organisationid" requestingOrganisationIdentifier: type: "string" description: Contains the requesting organisation identifier. minLength: 1 maxLength: 256 requestingOrganisationBillPay: type: "string" description: The originating mobile money provider or financial institution that holds the wallet/account of the payer. minLength: 0 maxLength: 256 serviceProviderComment: type: "string" description: Allows the Service Provider to include specific information regarding the bill payment. minLength: 0 maxLength: 256 serviceProviderNotification: type: "string" description: Allows the Service Provider to include specific information that will be included on the notification to the customer by the mobile money provider. minLength: 0 maxLength: 256 customerReference: type: "string" description: Textual reference provided by the customer paying the bill. minLength: 0 maxLength: 256 paymentType: type: "string" enum: - "partialpayment" - "fullpayment" supplementaryBillReferenceDetailsArray: type: "array" description: In some cases, a single reference is not sufficient to identify a bill. This key-value collection enables further reference information to be supplied. items: $ref: "#/components/schemas/supplementaryBillReferenceDetails" maxItems: 20 supplementaryBillReferenceDetails: type: "object" required: - "paymentReferenceType" - "paymentReferenceValue" properties: paymentReferenceType: type: "string" description: Identifies the type of the additional payment reference. minLength: 1 maxLength: 256 paymentReferenceValue: type: "string" description: Identifies the value of the additional payment reference. minLength: 1 maxLength: 256 dueDate: type: "string" format: "date" description: Date on which the Bill is due to be paid. example: "2018-11-20" billReference: type: "string" description: Reference number for the Bill that the payer can use when making a payment. minLength: 0 maxLength: 256 billDescription: type: "string" description: Description of the bill that is to be paid minLength: 0 maxLength: 256 billStatus: type: "string" enum: - "unpaid" - "paid" - "partialpaid" startDate: type: "string" format: "date" description: Date on which the mandate starts. If a frequencyType is specified, this will also be the date on which the first payment is to be taken. example: "2018-11-20" endDate: type: "string" format: "date" description: Date on which the mandate ends. example: "2018-11-20" numberOfPayments: type: "number" format: "int32" description: Indicates the number of consecutive payments that are to be taken. minimum: 0 exclusiveMinimum: false frequencyType: type: "string" enum: - "weekly" - "fortnight" - "monthspecificdate" - "twomonths" - "threemonths" - "fourmonths" - "sixmonths" - "yearly" - "lastdaymonth" - "lastdaymonthworking" - "lastmonday" - "lasttuesday" - "lastwednesday" - "lastthursday" - "lastfriday" - "lastsaturday" - "lastsunday" - "specificdaymonthly" mandateStatus: type: "string" enum: - "active" - "inactive" mandateReference: type: "string" description: Unique reference provided by the API Provider for the mandate. minLength: 0 maxLength: 256 status: type: "string" enum: - "active" - "inactive" mode: type: "string" enum: - "push" - "pull" - "both" linkReference: type: "string" description: Indicates the Link reference. This enables a linked account to be uniquely identified. minLength: 1 maxLength: 256 quoteArray: type: "array" description: A collection of quotes. A quote can be received from a single financial service provider or from multiple providers. items: $ref: "#/components/schemas/quotes" maxItems: 10 minItems: 1 quotes: type: "object" required: - "quoteId" - "receivingAmount" - "receivingCurrency" - "sendingAmount" - "sendingCurrency" properties: quoteId: $ref: '#/components/schemas/quoteId' receivingAmount: description: The total amount as it will be received by the receiving end-user. allOf: - $ref: '#/components/schemas/amount' example: "15.00" receivingCurrency: description: The currency of the quote. allOf: - $ref: '#/components/schemas/currency' sendingAmount: description: The requested quotation amount as supplied by the sender. allOf: - $ref: '#/components/schemas/amount' example: "15.00" sendingCurrency: description: Currency of the requested quotation amount. allOf: - $ref: '#/components/schemas/currency' deliveryMethod: description: The delivery method that is applicable to the quotation. allOf: - $ref: '#/components/schemas/deliveryMethod' fees: $ref: '#/components/schemas/feesArray' fxRate: $ref: '#/components/schemas/fxRate' quoteExpiryTime: $ref: '#/components/schemas/quoteExpiryTime' receivingServiceProvider: $ref: '#/components/schemas/receivingServiceProvider' quoteExpiryTime: type: "string" format: "date-time" description: The timestamp when the quote will expire. receivingServiceProvider: type: "string" description: The name of the receiving service provider, i.e. the provider that the quote is associated with. minLength: 0 maxLength: 256 fxRate: type: "string" description: The conversion rate applicable between the sending and the receiving currency for the requested transaction. minLength: 4 maxLength: 256 pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,10}[1-9])?$ example: "1.3436" senderBlockingReason: type: "string" description: The reason for blocking the quotation, based on AML checks on the sender. minLength: 0 maxLength: 256 recipientBlockingReason: type: "string" description: The reason for blocking the quotation, based on AML checks on the recipient. minLength: 0 maxLength: 256 quotationStatus: description: Indicates the creation state of the Quotation. type: "string" enum: - "pending" - "rejected" - "completed" authorisationCode: type: "string" description: The code that will be presented to the other party for redemption. maxLength: 256 codeState: type: "string" description: Indicates the state of the Authorisation Code. enum: - "active" - "expired" - "cancelled" codeLifetime: type: "number" format: "int32" minimum: 1 example: "600" description: Indicates the expiry time in seconds of the code. amountType: type: "string" description: The amount for the authorisation can be an exact amount or can be a maximum amount. enum: - "exact" - "maximum" holdFundsIndicator: type: "boolean" description: Indicates whether funds should be reserved against the payers account where the payer is the requestor. redemptionChannels: type: "array" description: Indicates the channel(s) that the code can be redeemed against, e.g. ATM, Merchant, etc. items: type: "object" properties: channelType: type: "string" description: Identifies the channel type. minLength: 1 maxLength: 256 required: - "channelType" maxItems: 50 redemptionTransactionTypes: type: "array" description: Indicates the Transaction Types(s) that the code can be redeemed against. items: type: "object" properties: transactionType: $ref: '#/components/schemas/type' transactionSubtype: $ref: '#/components/schemas/subType' required: - "transactionType" maxItems: 50 redemptionAccountIdentifiers: type: "array" description: A collection of key/value pairs that enable the redemption account to be identified. Keys include MSISDN and Wallet Identifier. items: $ref: '#/components/schemas/party' maxItems: 50 serviceStatus: type: "string" description: Provides the status of the requested service. enum: - "available" - "unavailable" - "degraded" delay: type: "number" format: "int64" description: The anticipated processing delay in milliseconds. plannedRestorationTime: type: "string" format: "date-time" description: Where the planned restoration time is known (e.g. scheduled maintenance), it can be provided in this field. # All the GSMA Mobile Money API Request Schemas are defined here. requestStateObject: type: "object" required: - "notificationMethod" - "serverCorrelationId" - "status" properties: serverCorrelationId: type: "string" description: A unique identifier issued by the provider to enable the client to identify the RequestState resource on subsequent polling requests. Must be supplied as a UUID. minLength: 1 maxLength: 256 pattern: "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$" objectReference: type: "string" description: Provides a reference to the subject resource, e.g. transaction reference. minLength: 0 maxLength: 256 status: type: "string" enum: - "pending" - "completed" - "failed" description: Indicates the status of the request. notificationMethod: type: "string" enum: - "callback" - "polling" description: Indicates whether a callback will be issued or whether the client will need to poll. pendingReason: type: "string" description: A textual description that can be provided to describe the reason for a pending status. minLength: 0 maxLength: 256 expiryTime: type: "string" format: "date-time" description: Indicate the time by which the provider will fail the request if completion criteria have not been met. For an example, a debit party failing to authorise within the allowed period. pollLimit: type: "number" format: "int32" description: Indicates the number of poll attempts for the given requeststate resource that will be allowed by the provider. minimum: 0 exclusiveMinimum: true error: description: If the asynchronous processing failed, details of the error will be returned here. allOf: - $ref: '#/components/schemas/errorObject' genericUpdateSuccess: type: "object" required: - "result" properties: result: type: "string" description: The success message provided in a callback to communicate the success of an update operation. enum: - "success" errorObject: type: "object" required: - "errorCategory" - "errorCode" properties: errorCategory: type: "string" description: The category grouping for the error. enum: - "businessRule" - "validation" - "authorisation" - "identification" - "internal" - "serviceUnavailable" errorCode: type: "string" description: The harmonised error code identifying the reason for error. enum: - "genericError" - "dailyVolumeLimitExceeded" - "dailyValueLimitExceeded" - "weeklyVolumeLimitExceeded" - "weeklyValueLimitExceeded" - "monthlyVolumeLimitExceeded" - "monthlyValueLimitExceeded" - "accountMaxTotalVolumeExceeded" - "accountMaxTotalValueExceeded" - "lessThanTransactionMinValue" - "greaterThanTransactionMaxValue" - "maxBalanceExceeded" - "samePartiesError" - "duplicateRequest" - "insufficientFunds" - "incorrectState" - "underPaymentNotAllowed" - "overPaymentNotAllowed" - "rateLimitError" - "transactionTypeError" - "noMandateAuthority" - "linkViolation" - "countryofOriginNotPermitted" - "nationalityNotPermitted" - "idDocumentNotSupported" - "issuingCountryNotSupported" - "quoteHasExpired" - "identifierError" - "lengthError" - "formatError" - "negativeValue" - "currencyNotSupported" - "mandatoryValueNotSupplied" - "invalidOffset" - "clientAuthorisationError" - "requestDeclined" - "servicingPartyAuthorisationError" - "requestingPartyAuthorisationError" errordescription: type: "string" description: A textual description of the error. minLength: 0 maxLength: 256 errorDateTime: type: "string" format: "date-time" description: The timestamp indicating when the error occurred. errorParameters: description: Diagnostic information in the form of key/value pairs relating to the error. allOf: - $ref: '#/components/schemas/metadataArray' requestTransaction: type: "object" required: - "amount" - "currency" - "type" - "creditParty" - "debitParty" properties: requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' originalTransactionReference: $ref: '#/components/schemas/originalTransactionReference' creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' type: $ref: '#/components/schemas/type' subType: $ref: '#/components/schemas/subType' amount: description: The transaction amount. allOf: - $ref: '#/components/schemas/amount' example: "15.23" currency: description: Currency of the transaction amount. allOf: - $ref: '#/components/schemas/currency' example: "RWF" descriptionText: $ref: '#/components/schemas/descriptionText' fees: $ref: '#/components/schemas/feesArray' geoCode: $ref: '#/components/schemas/geoCode' internationalTransferInformation: $ref: '#/components/schemas/internationalTransferInformation' oneTimeCode: $ref: '#/components/schemas/oneTimeCode' recipientKyc: $ref: '#/components/schemas/kyc' senderKyc: $ref: '#/components/schemas/kyc' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' servicingIdentity: $ref: '#/components/schemas/servicingIdentity' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' receivingLei: $ref: '#/components/schemas/receivingLei' # This field is marked as deprecated - please use the X-Account-Holding-Institution-Identifier header requestingLei: $ref: '#/components/schemas/requestingLei' # This field is marked as deprecated - please use requestingOrganisation requestTransactionType: allOf: - type: "object" required: - "amount" - "currency" properties: requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' originalTransactionReference: $ref: '#/components/schemas/originalTransactionReference' subType: $ref: '#/components/schemas/subType' amount: description: The transaction amount. allOf: - $ref: '#/components/schemas/amount' example: "15.23" currency: description: Currency of the transaction amount. allOf: - $ref: '#/components/schemas/currency' example: "RWF" descriptionText: $ref: '#/components/schemas/descriptionText' fees: $ref: '#/components/schemas/feesArray' geoCode: $ref: '#/components/schemas/geoCode' internationalTransferInformation: $ref: '#/components/schemas/internationalTransferInformation' oneTimeCode: $ref: '#/components/schemas/oneTimeCode' recipientKyc: $ref: '#/components/schemas/kyc' senderKyc: $ref: '#/components/schemas/kyc' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' servicingIdentity: $ref: '#/components/schemas/servicingIdentity' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' receivingLei: $ref: '#/components/schemas/receivingLei' # This field is marked as deprecated - please use the X-Account-Holding-Institution-Identifier header requestingLei: $ref: '#/components/schemas/requestingLei' # This field is marked as deprecated - please use requestingOrganisation - anyOf: - type: object # This construct allows for conditionality on credit/debit party. Both can be supplied or one or the other can be supplied. required: - creditParty properties: creditParty: $ref: '#/components/schemas/creditPartyArray' - type: object required: - debitParty properties: debitParty: $ref: '#/components/schemas/debitPartyArray' - type: object required: - debitParty - creditParty properties: creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' requestReversal: type: "object" required: - "type" properties: requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' type: $ref: '#/components/schemas/typeReversal' subType: $ref: '#/components/schemas/subType' amount: description: The transaction amount. allOf: - $ref: '#/components/schemas/amount' example: "15.23" currency: description: Currency of the transaction amount. allOf: - $ref: '#/components/schemas/currency' example: "RWF" descriptionText: $ref: '#/components/schemas/descriptionText' fees: $ref: '#/components/schemas/feesArray' geoCode: $ref: '#/components/schemas/geoCode' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' servicingIdentity: $ref: '#/components/schemas/servicingIdentity' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' receivingLei: $ref: '#/components/schemas/receivingLei' # This field is marked as deprecated - please use the X-Account-Holding-Institution-Identifier header requestingLei: $ref: '#/components/schemas/requestingLei' # This field is marked as deprecated - please use requestingOrganisation requestBatchTransaction: type: "object" required: - "transactions" properties: batchStatus: $ref: '#/components/schemas/batchStatus' transactions: type: "array" description: Collection of Transactions that are to be processed. items: $ref: "#/components/schemas/requestTransaction" minItems: 1 maxItems: 999999 batchTitle: $ref: '#/components/schemas/batchTitle' batchdescription: $ref: '#/components/schemas/batchDescription' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' scheduledStartDate: $ref: '#/components/schemas/scheduledStartDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' requestAccount: type: "object" required: - "identity" properties: accountIdentifiers: $ref: '#/components/schemas/accountIdentifiersArray' identity: $ref: '#/components/schemas/identityRequestArray' accountType: $ref: '#/components/schemas/accountType' customData: $ref: '#/components/schemas/customDataArray' fees: $ref: '#/components/schemas/feesArray' registeringEntity: $ref: '#/components/schemas/registeringEntity' requestDate: $ref: '#/components/schemas/requestDate' requestBillPayment: type: "object" required: - "currency" - "amountPaid" properties: serviceProviderPaymentReference: $ref: '#/components/schemas/serviceProviderPaymentReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' paymentType: description: Describes the type of Bill Payment, i.e. whether a full or partial payment. allOf: - $ref: '#/components/schemas/paymentType' amountPaid: description: Amount of the Bill that is being paid. allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Currency of the amount that is being paid. allOf: - $ref: '#/components/schemas/currency' customerReference: $ref: '#/components/schemas/customerReference' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisationBillPay' supplementaryBillReferenceDetails: $ref: '#/components/schemas/supplementaryBillReferenceDetailsArray' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' paidAmount: description: Amount of the Bill that is being paid. allOf: - $ref: '#/components/schemas/amount' deprecated: true requestBillPayment2: type: "object" required: - "currency" - "amountPaid" properties: serviceProviderPaymentReference: $ref: '#/components/schemas/serviceProviderPaymentReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' paymentType: description: Describes the type of Bill Payment, i.e. whether a full or partial payment. allOf: - $ref: '#/components/schemas/paymentType' amountPaid: description: Amount of the Bill that is being paid. allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Currency of the amount that is being paid. allOf: - $ref: '#/components/schemas/currency' customerReference: $ref: '#/components/schemas/customerReference' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisationBillPay' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' paidAmount: description: Amount of the Bill that is being paid. allOf: - $ref: '#/components/schemas/amount' deprecated: true requestDebitMandate: type: "object" required: - "startDate" properties: payee: $ref: '#/components/schemas/payee' mandateStatus: description: Indicates the status of the Debit Mandate as held in the API Provider system. allOf: - $ref: '#/components/schemas/mandateStatus' amountLimit: description: The maximum amount that can be taken by the Payee on a payment request. currency: description: Currency of the amount limit. allOf: - $ref: '#/components/schemas/currency' startDate: $ref: '#/components/schemas/startDate' endDate: $ref: '#/components/schemas/endDate' frequencyType: description: Indicates the frequency for which payments will be taken from the payers account. allOf: - $ref: '#/components/schemas/frequencyType' numberOfPayments: $ref: '#/components/schemas/numberOfPayments' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' requestLink: type: "object" required: - "sourceAccountIdentifiers" - "mode" - "status" properties: sourceAccountIdentifiers: $ref: '#/components/schemas/debitPartyArray' mode: description: Indicates the mode of operation for the Link. allOf: - $ref: '#/components/schemas/mode' status: description: Indicates the status of the Link. allOf: - $ref: '#/components/schemas/status' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' requestQuotation: type: "object" required: - "creditParty" - "debitParty" - "requestAmount" - "requestCurrency" properties: creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' type: $ref: '#/components/schemas/type' subType: $ref: '#/components/schemas/subType' requestAmount: description: The requested quotation amount. allOf: - $ref: '#/components/schemas/amount' example: "15.00" requestCurrency: description: Currency of the requested quotation amount allOf: - $ref: '#/components/schemas/currency' chosenDeliveryMethod: description: The delivery method chosen by the sending end user as the specific delivery method to be used in the quotes received. allOf: - $ref: '#/components/schemas/deliveryMethod' originCountry: allOf: - $ref: '#/components/schemas/nationality' description: The originating country of the quotation request, i.e. the country where the request was initiated. receivingCountry: allOf: - $ref: '#/components/schemas/nationality' description: Destination country of the quotation request, i.e. the country that the sender wishes to send to. recipientKyc: $ref: '#/components/schemas/kyc' senderKyc: $ref: '#/components/schemas/kyc' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' sendingServiceProviderCountry: allOf: - $ref: '#/components/schemas/nationality' description: The country of the sending service provider that holds the account of the sender. requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' requestAuthorisationCode: type: "object" properties: amount: description: Indicates the amount associated with the authorisation code. allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Indicates the Amount Currency. Must be supplied when an amount is supplied. allOf: - $ref: '#/components/schemas/currency' amountType: $ref: '#/components/schemas/amountType' codeLifetime: $ref: '#/components/schemas/codeLifetime' holdFundsIndicator: $ref: '#/components/schemas/holdFundsIndicator' redemptionAccountIdentifiers: $ref: '#/components/schemas/redemptionAccountIdentifiers' redemptionChannels: $ref: '#/components/schemas/redemptionChannels' redemptionTransactionTypes: $ref: '#/components/schemas/redemptionTransactionTypes' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' requestGenericPatchArray: type: "array" description: Collection of updates that are to be processed. items: $ref: "#/components/schemas/requestGenericPatch" minItems: 1 maxItems: 10 requestGenericPatch: type: "object" required: - "op" - "path" - "value" properties: op: description: Indicates the Patch operation to be performed. 'replace' is used to update a field and 'add' is used to add a new field. type: "string" enum: - "replace" - "add" path: description: Specify the field to be updated or added preceded by '/'. type: "string" maxLength: 256 value: description: Specify the value of the field to be updated or added. type: "string" maxLength: 256 # All the GSMA Mobile Money API Response Schemas are defined here. responseTransaction: type: "object" required: - "amount" - "currency" - "type" - "transactionReference" - "transactionStatus" - "creditParty" - "debitParty" properties: transactionReference: $ref: '#/components/schemas/transactionReference' originalTransactionReference: $ref: '#/components/schemas/originalTransactionReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' type: $ref: '#/components/schemas/type' subType: $ref: '#/components/schemas/subType' transactionStatus: $ref: '#/components/schemas/transactionStatus' amount: description: The transaction amount. allOf: - $ref: '#/components/schemas/amount' example: "15.23" currency: description: Currency of the transaction amount. allOf: - $ref: '#/components/schemas/currency' example: "RWF" descriptionText: $ref: '#/components/schemas/descriptionText' fees: $ref: '#/components/schemas/feesArray' geoCode: $ref: '#/components/schemas/geoCode' internationalTransferInformation: $ref: '#/components/schemas/internationalTransferInformationResponse' oneTimeCode: $ref: '#/components/schemas/oneTimeCode' recipientKyc: $ref: '#/components/schemas/kyc' senderKyc: $ref: '#/components/schemas/kyc' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' servicingIdentity: $ref: '#/components/schemas/servicingIdentity' transactionReceipt: $ref: '#/components/schemas/transactionReceipt' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' dateCreated: $ref: '#/components/schemas/dateCreated' # this field is replaced by creationDate dateModified: $ref: '#/components/schemas/dateModified' # this field is replaced by modificationDate receivingLei: $ref: '#/components/schemas/receivingLei' # This field is marked as deprecated - please use the X-Account-Holding-Institution-Identifier header requestingLei: $ref: '#/components/schemas/requestingLei' # This field is marked as deprecated - please use requestingOrganisation responseTransactionType: allOf: - type: "object" required: - "amount" - "currency" - "type" - "transactionReference" - "transactionStatus" properties: transactionReference: $ref: '#/components/schemas/transactionReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' originalTransactionReference: $ref: '#/components/schemas/originalTransactionReference' type: $ref: '#/components/schemas/type' subType: $ref: '#/components/schemas/subType' transactionStatus: $ref: '#/components/schemas/transactionStatus' amount: description: The transaction amount. allOf: - $ref: '#/components/schemas/amount' example: "15.23" currency: description: Currency of the transaction amount. allOf: - $ref: '#/components/schemas/currency' example: "RWF" descriptionText: $ref: '#/components/schemas/descriptionText' fees: $ref: '#/components/schemas/feesArray' geoCode: $ref: '#/components/schemas/geoCode' internationalTransferInformation: $ref: '#/components/schemas/internationalTransferInformationResponse' oneTimeCode: $ref: '#/components/schemas/oneTimeCode' recipientKyc: $ref: '#/components/schemas/kyc' senderKyc: $ref: '#/components/schemas/kyc' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' servicingIdentity: $ref: '#/components/schemas/servicingIdentity' transactionReceipt: $ref: '#/components/schemas/transactionReceipt' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' dateCreated: $ref: '#/components/schemas/dateCreated' # this field is replaced by creationDate dateModified: $ref: '#/components/schemas/dateModified' # this field is replaced by modificationDate receivingLei: $ref: '#/components/schemas/receivingLei' # This field is marked as deprecated - please use the X-Account-Holding-Institution-Identifier header requestingLei: $ref: '#/components/schemas/requestingLei' # This field is marked as deprecated - please use requestingOrganisation - anyOf: - type: object # This construct allows for conditionality on credit/debit party. Both can be supplied or one or the other can be supplied. required: - creditParty properties: creditParty: $ref: '#/components/schemas/creditPartyArray' - type: object required: - debitParty properties: debitParty: $ref: '#/components/schemas/debitPartyArray' - type: object required: - debitParty - creditParty properties: creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' responseReversal: type: "object" required: - "type" - "originalTransactionReference" - "transactionReference" - "transactionStatus" properties: transactionReference: $ref: '#/components/schemas/transactionReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' originalTransactionReference: $ref: '#/components/schemas/originalTransactionReference' creditParty: $ref: '#/components/schemas/debitPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' type: $ref: '#/components/schemas/typeReversal' subType: $ref: '#/components/schemas/subType' transactionStatus: $ref: '#/components/schemas/transactionStatus' amount: description: The transaction amount. allOf: - $ref: '#/components/schemas/amount' example: "15.23" currency: description: Currency of the transaction amount. allOf: - $ref: '#/components/schemas/currency' example: "RWF" descriptionText: $ref: '#/components/schemas/descriptionText' fees: $ref: '#/components/schemas/feesArray' geoCode: $ref: '#/components/schemas/geoCode' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' servicingIdentity: $ref: '#/components/schemas/servicingIdentity' transactionReceipt: $ref: '#/components/schemas/transactionReceipt' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' dateCreated: $ref: '#/components/schemas/dateCreated' # this field is replaced by creationDate dateModified: $ref: '#/components/schemas/dateModified' # this field is replaced by modificationDate receivingLei: $ref: '#/components/schemas/receivingLei' # This field is marked as deprecated - please use the X-Account-Holding-Institution-Identifier header requestingLei: $ref: '#/components/schemas/requestingLei' # This field is marked as deprecated - please use requestingOrganisation responseBatchTransaction: type: "object" required: - "approvalDate" - "batchId" - "batchStatus" - "completionDate" properties: batchId: $ref: '#/components/schemas/batchId' batchStatus: $ref: '#/components/schemas/batchStatus' approvalDate: $ref: '#/components/schemas/approvalDate' completionDate: $ref: '#/components/schemas/completionDate' batchTitle: $ref: '#/components/schemas/batchTitle' batchdescription: $ref: '#/components/schemas/batchDescription' processingFlag: $ref: '#/components/schemas/processingFlag' completedCount: $ref: '#/components/schemas/completedCount' rejectionCount: $ref: '#/components/schemas/rejectionCount' parsingSuccessCount: $ref: '#/components/schemas/parsingSuccessCount' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' scheduledStartDate: $ref: '#/components/schemas/scheduledStartDate' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' completedDate: $ref: '#/components/schemas/completedDate' # This field has been replaced by completionDate responseBatchTransactionRejection: type: "object" required: - "creditParty" - "debitParty" - "rejectionDate" - "rejectionReason" properties: transactionReference: $ref: '#/components/schemas/transactionReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' rejectionReason: $ref: '#/components/schemas/rejectionReason' rejectionDate: $ref: '#/components/schemas/rejectionDate' customData: $ref: '#/components/schemas/customDataArray' dateRejected: $ref: '#/components/schemas/dateRejected' # This field has been replaced by rejectionDate responseBatchTransactionCompletion: type: "object" required: - "transactionReference" - "creditParty" - "debitParty" - "completionDate" - "link" properties: transactionReference: $ref: '#/components/schemas/transactionReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' completionDate: $ref: '#/components/schemas/transactionCompletionDate' link: $ref: '#/components/schemas/link' customData: $ref: '#/components/schemas/customDataArray' completedDate: $ref: '#/components/schemas/transactionCompletedDate' # This field has been replaced by completionDate responseAccount: type: "object" required: - "accountIdentifiers" - "identity" - "accountStatus" properties: accountIdentifiers: $ref: '#/components/schemas/accountIdentifiersArray' identity: $ref: '#/components/schemas/identityResponseArray' accountType: $ref: '#/components/schemas/accountType' accountStatus: $ref: '#/components/schemas/accountStatus' accountSubStatus: $ref: '#/components/schemas/accountSubStatus' currentBalance: $ref: '#/components/schemas/currentBalance' availableBalance: $ref: '#/components/schemas/availableBalance' reservedBalance: $ref: '#/components/schemas/reservedBalance' unclearedBalance: $ref: '#/components/schemas/unclearedBalance' currency: description: Currency of the account. allOf: - $ref: '#/components/schemas/currency' example: "RWF" fees: $ref: '#/components/schemas/feesArray' commissionEarned: $ref: '#/components/schemas/commissionEarnedArray' registeringEntity: $ref: '#/components/schemas/registeringEntity' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' responseAccountStatus: type: "object" required: - "accountStatus" properties: accountStatus: $ref: '#/components/schemas/accountStatus' subStatus: $ref: '#/components/schemas/subStatus' lei: description: Indicates the Legal Entity Identifier of the organisation holding the account. allOf: - $ref: '#/components/schemas/lei' responseAccountName: type: "object" properties: name: $ref: '#/components/schemas/subjectName' lei: description: Indicates the Legal Entity Identifier of the organisation holding the account. allOf: - $ref: '#/components/schemas/lei' responseAccountBalance: type: "object" properties: accountStatus: $ref: '#/components/schemas/accountStatus' currentBalance: $ref: '#/components/schemas/currentBalance' availableBalance: $ref: '#/components/schemas/availableBalance' reservedBalance: $ref: '#/components/schemas/reservedBalance' unclearedBalance: $ref: '#/components/schemas/unclearedBalance' currency: description: Currency for all returned balances. allOf: - $ref: '#/components/schemas/currency' responseStatementEntries: type: "object" required: - "transactionReference" - "creditParty" - "debitParty" - "transactionStatus" - "amount" - "currency" properties: transactionReference: $ref: '#/components/schemas/transactionReference' creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' transactionStatus: $ref: '#/components/schemas/transactionStatus' amount: description: Amount of the transaction. allOf: - $ref: '#/components/schemas/amount' currency: description: Currency of the transaction. allOf: - $ref: '#/components/schemas/currency' descriptionText: $ref: '#/components/schemas/descriptionText' displayType: $ref: '#/components/schemas/displayType' transactionReceipt: $ref: '#/components/schemas/transactionReceipt' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' dateCreated: $ref: '#/components/schemas/dateCreated' # this field is replaced by creationDate dateModified: $ref: '#/components/schemas/dateModified' # this field is replaced by modificationDate responseBillCompanies: type: "object" required: - "companyName" - "serviceProvider" properties: serviceProvider: $ref: '#/components/schemas/serviceProvider' serviceProviderType: $ref: '#/components/schemas/serviceProviderType' serviceProviderSubType: $ref: '#/components/schemas/serviceProviderSubType' companyName: $ref: '#/components/schemas/companyName' supplementaryServiceProviderDetails: type: "array" items: $ref: '#/components/schemas/metadata' maxItems: 20 responseBillPayment: type: "object" required: - "currency" - "amountPaid" - "billPaymentStatus" properties: serviceProviderPaymentReference: $ref: '#/components/schemas/serviceProviderPaymentReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' customerReference: $ref: '#/components/schemas/customerReference' paymentType: description: Describes the type of Bill Payment, i.e. whether a full or partial payment. allOf: - $ref: '#/components/schemas/paymentType' billPaymentStatus: $ref: '#/components/schemas/billPaymentStatus' amountPaid: description: Amount of the Bill that is being paid allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Currency of the amount that is being paid. allOf: - $ref: '#/components/schemas/currency' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisationBillPay' supplementaryBillReferenceDetails: $ref: '#/components/schemas/supplementaryBillReferenceDetailsArray' serviceProviderComment: $ref: '#/components/schemas/serviceProviderComment' serviceProviderNotification: $ref: '#/components/schemas/serviceProviderNotification' requestDate: $ref: '#/components/schemas/requestDate' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' paidAmount: description: Amount of the Bill that is being paid allOf: - $ref: '#/components/schemas/amount' deprecated: true responseBillPayment2: type: "object" required: - "currency" - "amountPaid" - "billPaymentStatus" properties: serviceProviderPaymentReference: $ref: '#/components/schemas/serviceProviderPaymentReference' requestingOrganisationTransactionReference: $ref: '#/components/schemas/requestingOrganisationTransactionReference' customerReference: $ref: '#/components/schemas/customerReference' paymentType: description: Describes the type of Bill Payment, i.e. whether a full or partial payment. allOf: - $ref: '#/components/schemas/paymentType' billPaymentStatus: $ref: '#/components/schemas/billPaymentStatus' amountPaid: description: Amount of the Bill that is being paid allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Currency of the amount that is being paid. allOf: - $ref: '#/components/schemas/currency' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisationBillPay' serviceProviderComment: $ref: '#/components/schemas/serviceProviderComment' serviceProviderNotification: $ref: '#/components/schemas/serviceProviderNotification' requestDate: $ref: '#/components/schemas/requestDate' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' paidAmount: description: Amount of the Bill that is being paid allOf: - $ref: '#/components/schemas/amount' deprecated: true responseBills: type: "object" properties: billReference: $ref: '#/components/schemas/billReference' billStatus: description: Identifies the status of the Bill. allOf: - $ref: '#/components/schemas/billStatus' amountDue: description: Amount outstanding on the bill to be paid. allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Currency of the bill to be paid. allOf: - $ref: '#/components/schemas/currency' billdescription: $ref: '#/components/schemas/billDescription' dueDate: $ref: '#/components/schemas/dueDate' minimumAmountDue: description: The minimum amount that is outstanding on the bill to be paid. allOf: - $ref: '#/components/schemas/amount' example: "15.00" creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' responseDebitMandate: type: "object" required: - "mandateReference" properties: mandateReference: $ref: '#/components/schemas/mandateReference' payee: $ref: '#/components/schemas/payee' mandateStatus: description: Indicates the status of the Mandate as held in the API Provider system. allOf: - $ref: '#/components/schemas/mandateStatus' startDate: $ref: '#/components/schemas/startDate' amountLimit: description: The maximum amount that can be taken by the Payee on a payment request. allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Currency of the amount limit. allOf: - $ref: '#/components/schemas/currency' endDate: $ref: '#/components/schemas/endDate' frequencyType: description: Indicates the frequency for which payments will be taken from the payers account. allOf: - $ref: '#/components/schemas/frequencyType' numberOfPayments: $ref: '#/components/schemas/numberOfPayments' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' dateCreated: $ref: '#/components/schemas/dateCreated' # this field is replaced by creationDate dateModified: $ref: '#/components/schemas/dateModified' # this field is replaced by modificationDate responseLink: type: "object" required: - "linkReference" - "sourceAccountIdentifiers" - "status" - "mode" properties: linkReference: $ref: '#/components/schemas/linkReference' sourceAccountIdentifiers: $ref: '#/components/schemas/debitPartyArray' mode: description: Indicates the Link mode of operation. This can be set to 'pull' (The link can be used by the client to debit the target account held by the provider), 'push' (The link can be used by the client to credit the target account held by the provider) or 'both'. allOf: - $ref: '#/components/schemas/mode' status: description: Indicates the status of the Link. allOf: - $ref: '#/components/schemas/status' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' responseQuotation: type: "object" required: - "quotationReference" - "creditParty" - "debitParty" - "requestAmount" - "requestCurrency" properties: quotationReference: $ref: '#/components/schemas/quotationReference' creditParty: $ref: '#/components/schemas/creditPartyArray' debitParty: $ref: '#/components/schemas/debitPartyArray' type: $ref: '#/components/schemas/type' subType: $ref: '#/components/schemas/subType' quotationStatus: $ref: '#/components/schemas/quotationStatus' requestAmount: description: The requested quotation amount. allOf: - $ref: '#/components/schemas/amount' example: "15.00" requestCurrency: description: Currency of the requested quotation amount allOf: - $ref: '#/components/schemas/currency' availableDeliveryMethod: description: Delivery Method that is possible for the intended recipient. allOf: - $ref: '#/components/schemas/deliveryMethod' chosenDeliveryMethod: description: The delivery method chosen by the sending end user as the specific delivery method to be used in the quotes received. allOf: - $ref: '#/components/schemas/deliveryMethod' originCountry: allOf: - $ref: '#/components/schemas/nationality' description: The originating country of the quotation request, i.e. the country where the request was initiated. receivingCountry: allOf: - $ref: '#/components/schemas/nationality' description: Destination country of the quotation request, i.e. the country that the sender wishes to send to. quotes: $ref: '#/components/schemas/quoteArray' recipientKyc: $ref: '#/components/schemas/kyc' senderKyc: $ref: '#/components/schemas/kyc' recipientBlockingReason: $ref: '#/components/schemas/recipientBlockingReason' senderBlockingReason: $ref: '#/components/schemas/senderBlockingReason' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' sendingServiceProviderCountry: allOf: - $ref: '#/components/schemas/nationality' description: The country of the sending service provider that holds the account of the sender. creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' dateCreated: $ref: '#/components/schemas/dateCreated' # this field is replaced by creationDate dateModified: $ref: '#/components/schemas/dateModified' # this field is replaced by modificationDate customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' responseAuthorisationCode: type: "object" required: - "authorisationCode" - "codeState" properties: authorisationCode: $ref: '#/components/schemas/authorisationCode' codeState: $ref: '#/components/schemas/codeState' amount: description: Indicates the amount associated with the authorisation code. allOf: - $ref: '#/components/schemas/amount' example: "15.00" currency: description: Indicates the Amount Currency. Must be supplied when an amount is supplied. allOf: - $ref: '#/components/schemas/currency' amountType: $ref: '#/components/schemas/amountType' codeLifetime: $ref: '#/components/schemas/codeLifetime' holdFundsIndicator: $ref: '#/components/schemas/holdFundsIndicator' redemptionAccountIdentifiers: $ref: '#/components/schemas/redemptionAccountIdentifiers' redemptionChannels: $ref: '#/components/schemas/redemptionChannels' redemptionTransactionTypes: $ref: '#/components/schemas/redemptionTransactionTypes' requestingOrganisation: $ref: '#/components/schemas/requestingOrganisation' creationDate: $ref: '#/components/schemas/creationDate' modificationDate: $ref: '#/components/schemas/modificationDate' requestDate: $ref: '#/components/schemas/requestDate' customData: $ref: '#/components/schemas/customDataArray' metadata: $ref: '#/components/schemas/metadataArray' responseHeartbeat: type: "object" required: - "serviceStatus" properties: serviceStatus: $ref: '#/components/schemas/serviceStatus' delay: $ref: '#/components/schemas/delay' plannedRestorationTime: $ref: '#/components/schemas/plannedRestorationTime' responseResponse: type: "object" required: - "link" properties: link: $ref: '#/components/schemas/link' # All the GSMA Mobile Money API Request Bodies are defined here. requestBodies: updateError: required: true description: Represents the request body of error callback. content: application/json: schema: $ref: '#/components/schemas/errorObject' genericUpdateSuccess: required: true description: Represents the request body of a success message callback to an update event. content: application/json: schema: $ref: '#/components/schemas/genericUpdateSuccess' requestTransaction: required: true description: Represents the request body of a transaction. content: application/json: schema: $ref: '#/components/schemas/requestTransaction' requestTransactionType: required: true description: Represents the request body of a transaction without Type. content: application/json: schema: $ref: '#/components/schemas/requestTransactionType' updateTransaction: required: true description: Represents the request body of transaction callback. content: application/json: schema: $ref: '#/components/schemas/responseTransaction' requestReversal: required: true description: Represents the request body of a transaction reversal. content: application/json: schema: $ref: '#/components/schemas/requestReversal' updateReversal: required: true description: Represents the request body of a reversal callback. content: application/json: schema: $ref: '#/components/schemas/responseReversal' requestBatchTransaction: required: true description: Represents the request body of a batch of transactions. content: application/json: schema: $ref: '#/components/schemas/requestBatchTransaction' updateBatchTransaction: required: true description: Represents the request body of a batch of transactions callback. content: application/json: schema: $ref: '#/components/schemas/responseBatchTransaction' genericPatch: required: true description: Represents the request body of a batch of generic Patch operation. content: application/json: schema: $ref: '#/components/schemas/requestGenericPatchArray' requestAccount: required: true description: Represents the request body of an Account. content: application/json: schema: $ref: '#/components/schemas/requestAccount' updateAccount: required: true description: Represents the request body of an account callback. content: application/json: schema: $ref: '#/components/schemas/responseAccount' requestBillPayment: required: true description: Represents the request body of a bill payment. content: application/json: schema: $ref: '#/components/schemas/requestBillPayment' requestBillPayment2: required: true description: Represents the request body of a bill payment. content: application/json: schema: $ref: '#/components/schemas/requestBillPayment2' updateBillPayment: required: true description: Represents the request body of a bill payment callback. content: application/json: schema: $ref: '#/components/schemas/responseBillPayment' updateBillPayment2: required: true description: Represents the request body of a bill payment callback. content: application/json: schema: $ref: '#/components/schemas/responseBillPayment2' requestDebitMandate: required: true description: Represents the request body of a debit mandate. content: application/json: schema: $ref: '#/components/schemas/requestDebitMandate' updateDebitMandate: required: true description: Represents the request body of a debit mandate callback. content: application/json: schema: $ref: '#/components/schemas/responseDebitMandate' requestLink: required: true description: Represents the request body of a Link. content: application/json: schema: $ref: '#/components/schemas/requestLink' updateLink: required: true description: Represents the request body of a Link Callback. content: application/json: schema: $ref: '#/components/schemas/responseLink' requestQuotation: required: true description: Represents the request body of a Quotation. content: application/json: schema: $ref: '#/components/schemas/requestQuotation' updateQuotation: required: true description: Represents the request body of a Quotation Callback. content: application/json: schema: $ref: '#/components/schemas/responseQuotation' requestAuthorisationCode: required: true description: Represents the request body of an Authorisation Code. content: application/json: schema: $ref: '#/components/schemas/requestAuthorisationCode' updateAuthorisationCode: required: true description: Represents the request body of an Authorisation Code Callback. content: application/json: schema: $ref: '#/components/schemas/responseAuthorisationCode' # All the GSMA Mobile Money API Response Headers are defined here. headers: X-Date: required: false description: The date and time that the response message was sent. schema: type: "string" format: "date-time" X-Records-Available-Count: required: false description: Integer containing number of records that are available to be returned. schema: type: "integer" format: "int32" X-Records-Returned-Count: required: false description: Integer containing number of records that are returned. schema: type: "integer" format: "int32" parameters: # All the GSMA Mobile Money API Query String, Path and Header parameters are defined here. X-CorrelationID: name: "X-CorrelationID" in: "header" description: Header parameter to uniquely identify the request. Must be supplied as a UUID. required: false schema: type: "string" pattern: "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$" X-Date: name: "X-Date" in: "header" description: Header parameter to indicate the date and time that the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API. required: false schema: type: "string" format: "date-time" X-API-Key: name: "X-API-Key" in: "header" description: Used to pass pre-shared client's API key to the server. required: false schema: type: "string" X-User-Bearer: name: "X-User-Bearer" in: "header" description: Used to pass user’s access token when OAuth 2.0/OIDC authorisation framework is used for end-user authentication. required: false schema: type: "string" X-Client-Id: name: "X-Client-Id" in: "header" description: Used to pass pre-shared client's identifier to the server. required: false schema: type: "string" maxLength: 256 X-Content-Hash: name: "X-Content-Hash" in: "header" description: SHA-256 hex digest of the request content (encrypted or plain). Applicable only if basic data integrity checking is to be performed. required: false schema: type: "string" X-User-Credential-1: name: "X-User-Credential-1" in: "header" description: The end-users encrypted security credential. Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider. required: false schema: type: "string" X-User-Credential-2: name: "X-User-Credential-2" in: "header" description: The end-users encrypted security credential Should only be used when OAuth 2.0/OIDC authorisation framework has not been implemented by the API Provider. required: false schema: type: "string" X-Channel: name: "X-Channel" in: "header" description: String containing the channel that was used to originate the request. For example USSD, Web, App. required: false schema: type: "string" maxLength: 256 transactionTypePath: name: "transactionType" in: "path" required: true description: Identifies the type of transaction that is to be created. schema: type: "string" enum: - "billpay" - "deposit" - "disbursement" - "transfer" - "merchantpay" - "inttransfer" - "adjustment" - "reversal" - "withdrawal" transactionReference: name: "transactionReference" in: "path" description: Path variable to uniquely identify the transaction. required: true schema: type: "string" maxLength: 256 minLength: 1 batchId: name: "batchId" in: "path" description: Path variable to uniquely identify the transaction batch. required: true schema: type: "string" maxLength: 256 minLength: 1 limit: name: "limit" in: "query" description: Supports pagination. If this is not supplied, then the server will apply a limit of 50 records returned for each request. required: false schema: type: "integer" format: "int32" offset: name: "offset" in: "query" description: Supports pagination. This value will indicate the cursor position from where to retrieve the set of records. For example, a limit of 50 and offset of 10 will return records 11 to 60. required: false schema: type: "integer" format: "int32" fromDateTime: name: "fromDateTime" in: "query" description: Indicates the minimum creation date for which records should be returned. required: false schema: type: "string" format: "date-time" toDateTime: name: "toDateTime" in: "query" description: Indicates the maximum creation date for which records should be returned. required: false schema: type: "string" format: "date-time" codeState: name: "codeState" in: "query" description: Allows returned records to be filtered on state of the authorisation code. required: true schema: type: "string" maxLength: 256 accountId: name: "accountId" in: "path" description: "Path variable to uniquely identify an account. Up to three account identifiers can be supplied. Identifiers are delimited by $ and values are delimited by @. Example: organisationid@1234$accountid@3333. Valid account identifiers are accountcategory, bankaccountno, accountrank, identityalias, iban, accountid, msisdn, swiftbic, sortcode, organisationid, username, walletid, linkref, consumerno, serviceprovider, storeid, bankname, bankaccounttitle, emailaddress, mandatereference." required: true schema: type: "string" pattern: ^((accountcategory|bankaccountno|accountrank|identityalias|iban|accountid|msisdn|swiftbic|sortcode|organisationid|username|walletid|linkref|consumerno|serviceprovider|storeid|bankname|bankaccounttitle|emailaddress|mandatereference)@([^$\n]+))(\$(accountcategory|bankaccountno|accountrank|identityalias|iban|accountid|msisdn|swiftbic|sortcode|organisationid|username|walletid|linkref|consumerno|serviceprovider|storeid|bankname|bankaccounttitle|emailaddress|mandatereference)@([^$\n]+)){0,2}$ identityTypePath: name: "identityType" in: "path" required: true description: Identifies the type of identity that is associated with the Account. schema: type: "string" enum: - "individual" identityIdPath: name: "identityId" in: "path" required: true description: A unique id for the identity as assigned by the API Provider. schema: type: "string" transactionStatus: name: "transactionStatus" in: "query" description: Query variable to uniquely identify the transaction status. required: false schema: type: "string" maxLength: 256 transactionTypeQuery: name: "transactionType" in: "query" required: false description: Identifies the type of transaction. schema: type: "string" enum: - "billpay" - "deposit" - "disbursement" - "transfer" - "merchantpay" - "inttransfer" - "adjustment" - "reversal" - "withdrawal" displayType: name: "displayType" in: "query" description: Query parameter to to identify the display type of the statement entries to be returned. required: false schema: type: "string" maxLength: 256 serviceProvider: name: "serviceProvider" in: "path" description: The identifier for the Bill Payment Service Provider. required: true schema: type: "string" minLength: 1 maxLength: 256 billReference: name: "billReference" in: "path" description: Path variable to uniquely identify a bill. required: true schema: type: "string" maxLength: 256 minLength: 1 debitMandateReference: name: "debitMandateReference" in: "path" description: Path variable to uniquely identify a Debit Mandate Reference. required: true schema: type: "string" maxLength: 256 minLength: 1 linkReference: name: "linkReference" in: "path" description: Path variable to uniquely identify a link. required: true schema: type: "string" maxLength: 256 minLength: 1 quotationReference: name: "quotationReference" in: "path" description: Path variable to uniquely identify the quotation. required: true schema: type: "string" maxLength: 256 minLength: 1 authorisationCode: name: "authorisationCode" in: "path" description: Path variable to uniquely identify an authorisation code. required: true schema: type: "string" maxLength: 256 minLength: 1 serverCorrelationId: name: "serverCorrelationId" in: "path" description: Path variable to uniquely identify a request state. Must be supplied as a UUID. required: true schema: type: "string" pattern: "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$" clientCorrelationId: name: "clientCorrelationId" in: "path" description: Path variable to uniquely identify a response object. Must be supplied as a UUID. required: true schema: type: "string" pattern: "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$" X-Callback-URL: name: "X-Callback-URL" in: "header" description: The URL supplied by the client that will be used to return the callback in the form of a HTTP PUT. required: false schema: type: "string" format: uri paymentReference: name: "paymentReference" in: "path" description: Path variable to uniquely identify an instance of a bill payment. required: true schema: type: "string" maxLength: 256 minLength: 1 identifierType: name: "identifierType" in: "path" required: true description: Path variable to specify the type of the identifier that is used to identify the account. schema: type: "string" enum: - "accountid" - "msisdn" - "walletid" - "linkref" - "consumerno" - "serviceprovider" - "storeid" - "accountcategory" - "bankaccountno" - "accountrank" - "identityalias" - "iban" - "swiftbic" - "sortcode" - "organisationid" - "bankname" - "bankaccounttitle" - "username" - "emailaddress" - "mandatereference" identifier: name: "identifier" in: "path" description: Path variable that contains the account identifier. required: true schema: type: "string" maxLength: 256 minLength: 1 X-Account-Holding-Institution-Identifier-Type: name: "X-Account-Holding-Institution-Identifier-Type" in: "header" description: A header variable that identifies the type of the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier header. required: false schema: type: "string" enum: - "lei" - "swiftbic" - "organisationid" X-Account-Holding-Institution-Identifier: name: "X-Account-Holding-Institution-Identifier" in: "header" description: A header variable that identifies the account holding institution. This header is used to support request routing and should be used in conjunction with the X-Account-Holding-Institution-Identifier-Type header. required: false schema: type: "string"