# paths./v1_0/account/balance/{currency}.get.description
Get the balance of the account. Currency parameter passed in GET

# paths./v1_0/account/balance/{currency}.get.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/account/balance/{currency}.get.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v1_0/account/balance/{currency}.get.responses.400.description
Bad request, e.g. invalid data was sent in the request.

# paths./v1_0/account/balance/{currency}.get.responses.500.description
Internal error. The returned response contains details.

# paths./v1_0/account/balance/{currency}.get.responses.500.content.Incorrect target environment.example.message
Access to target environment is forbidden.

# paths./v1_0/requesttowithdraw.post.description
This operation is used to request a withdrawal (cash-out) from a consumer (Payer). The payer will be asked to authorize the withdrawal. The transaction will be executed once the payer has authorized the withdrawal

# paths./v1_0/requesttowithdraw.post.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/requesttowithdraw.post.parameters[].description
POST Callback URL to the server where the callback should be sent.

# paths./v1_0/requesttowithdraw.post.parameters[].description
Format - UUID. Recource ID of the created request to pay transaction. This ID is used, for example, validating the status of the request. ‘Universal Unique ID’ for the transaction generated using UUID version 4.

# paths./v1_0/requesttowithdraw.post.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v1_0/requesttowithdraw.post.responses.400.description
Bad request, e.g. invalid data was sent in the request.

# paths./v1_0/requesttowithdraw.post.responses.409.content.ReferenceId already in use.example.message
Duplicated reference id. Creation of resource failed.

# paths./v1_0/requesttowithdraw.post.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v2_0/requesttowithdraw.post.description
This operation is used to request a withdrawal (cash-out) from a consumer (Payer). The payer will be asked to authorize the withdrawal. The transaction will be executed once the payer has authorized the withdrawal

# paths./v2_0/requesttowithdraw.post.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v2_0/requesttowithdraw.post.parameters[].description
PUT Callback URL to the server where the callback should be sent.

# paths./v2_0/requesttowithdraw.post.parameters[].description
Format - UUID. Recource ID of the created request to pay transaction. This ID is used, for example, validating the status of the request. ‘Universal Unique ID’ for the transaction generated using UUID version 4.

# paths./v2_0/requesttowithdraw.post.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v2_0/requesttowithdraw.post.responses.400.description
Bad request, e.g. invalid data was sent in the request.

# paths./v2_0/requesttowithdraw.post.responses.409.content.ReferenceId already in use.example.message
Duplicated reference id. Creation of resource failed.

# paths./v2_0/requesttowithdraw.post.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v1_0/requesttowithdraw/{referenceId}.get.description
This operation is used to get the status of a request to withdraw. X-Reference-Id that was passed in the post is used as reference to the request.

# paths./v1_0/requesttowithdraw/{referenceId}.get.parameters[].description
UUID of transaction to get result. Reference id  used when creating the requesttowithdraw.

# paths./v1_0/requesttowithdraw/{referenceId}.get.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/requesttowithdraw/{referenceId}.get.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v1_0/requesttowithdraw/{referenceId}.get.responses.200.description
OK. Note that a  failed request to pay will be returned with this status too. The 'status' of the RequestToPayResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.

# paths./v1_0/requesttowithdraw/{referenceId}.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v1_0/requesttowithdraw/{referenceId}.get.responses.500.description
Internal Error. Note that if the retrieved request to pay has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.

# paths./v1_0/requesttowithdraw/{referenceId}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v1_0/account/balance.get.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/account/balance.get.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v1_0/account/balance.get.responses.400.description
Bad request, e.g. invalid data was sent in the request.

# paths./v1_0/account/balance.get.responses.500.description
Internal error. The returned response contains details.

# paths./v1_0/account/balance.get.responses.500.content.Incorrect target environment.example.message
Access to target environment is forbidden.

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.description
Operation is used  to check if an account holder is registered and active in the system.

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.parameters[].description
The party number. Validated according to the party ID type (case Sensitive).
msisdn - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN
email - Validated to be a valid e-mail format. Validated with IsEmail
party_code - UUID of the party. Validated with IsUuid

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.parameters[].description
Specifies the type of the party ID. Allowed values [msisdn, email, party_code].  <br> accountHolderId should explicitly be in small letters.

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.responses.200.description
Ok. True if account holder is registered and active, false if the account holder is not active or not found

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.responses.400.description
Bad request, e.g. invalid data was sent in the request.

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.responses.500.description
Internal error. The returned response contains details.

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.responses.500.content.Incorrect target environment.example.message
Access to target environment is forbidden.

# paths./v1_0/requesttopay.post.description
This operation is used to request a payment from a consumer (Payer). The payer will be asked to authorize the payment. The transaction will be executed once the payer has authorized the payment. The requesttopay will be in status PENDING until the transaction is authorized or declined by the payer or it is timed out by the system. 
 Status of the transaction can be validated by using the GET /requesttopay/\<resourceId\>

# paths./v1_0/requesttopay.post.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/requesttopay.post.parameters[].description
URL to the server where the callback should be sent.

# paths./v1_0/requesttopay.post.parameters[].description
Format - UUID. Recource ID of the created request to pay transaction. This ID is used, for example, validating the status of the request. ‘Universal Unique ID’ for the transaction generated using UUID version 4.

# paths./v1_0/requesttopay.post.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v1_0/requesttopay.post.responses.400.description
Bad request, e.g. invalid data was sent in the request.

# paths./v1_0/requesttopay.post.responses.409.content.ReferenceId already in use.example.message
Duplicated reference id. Creation of resource failed.

# paths./v1_0/requesttopay.post.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./token/.post.description
This operation is used to create an access token which can then be used to authorize and authenticate towards the other end-points of the API.

# paths./token/.post.parameters[].description
Basic authentication header containing API user ID and API key. Should be sent in as B64 encoded.

# paths./v1_0/requesttopay/{referenceId}.get.description
This operation is used to get the status of a request to pay. X-Reference-Id that was passed in the post is used as reference to the request.

# paths./v1_0/requesttopay/{referenceId}.get.parameters[].description
UUID of transaction to get result. Reference id  used when creating the request to pay.

# paths./v1_0/requesttopay/{referenceId}.get.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/requesttopay/{referenceId}.get.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# paths./v1_0/requesttopay/{referenceId}.get.responses.200.description
OK. Note that a  failed request to pay will be returned with this status too. The 'status' of the RequestToPayResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.

# paths./v1_0/requesttopay/{referenceId}.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v1_0/requesttopay/{referenceId}.get.responses.500.description
Internal Error. Note that if the retrieved request to pay has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.

# paths./v1_0/requesttopay/{referenceId}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v1_0/accountholder/msisdn/{accountHolderMSISDN}/basicuserinfo.get.description
This operation returns personal information of the account holder. The operation does not need any consent by the account holder.

# paths./v1_0/accountholder/msisdn/{accountHolderMSISDN}/basicuserinfo.get.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/accountholder/msisdn/{accountHolderMSISDN}/basicuserinfo.get.parameters[].description
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.

# paths./v1_0/accountholder/msisdn/{accountHolderMSISDN}/basicuserinfo.get.parameters[].description
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.

# components.schemas.BasicUserInfoJsonResponse.properties.given_name.description
Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

# components.schemas.BasicUserInfoJsonResponse.properties.family_name.description
Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

# components.schemas.BasicUserInfoJsonResponse.properties.locale.description
End-User's locale, represented as a  BCP47 [RFC5646] language tag. This is typically an  ISO 639-1 Alpha-2 [ISO639�|�1] language code in lowercase and an  ISO 3166-1 Alpha-2 [ISO3166�|�1] country code in uppercase, separated by a dash. For example,  en-US or  fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example,  en_US; Relying Parties may choose to accept this locale syntax as well.

# components.schemas.BasicUserInfoJsonResponse.properties.gender.description
End-User's gender. Values defined by this specification are female and male. Other values may be used when neither of the defined values are applicable.

# components.schemas.bcauthorize.properties.consent_valid_in.description
The validity time of the consent in secondsThis parameter can only be used together with access type offline.

# components.schemas.bcauthorize.properties.client_notification_token.description
This token is required when the client is using Ping or Push mode.

# components.schemas.bcauthorize.properties.scope_instruction.description
Base64 encoded Instrcution of the financial transaction.

# components.schemas.bcauthorizeResponse.properties.interval.description
Indicates how long time the client should wait between retries towards the endpoint /oauth2/token.

# components.schemas.bcauthorizeResponse.properties.expires_in.description
Shows when the authentication request ID expires, in seconds.

# components.schemas.TokenPost200ApplicationJsonResponse.properties.access_token.description
A JWT token which can be used to authrize against the other API end-points. The format of the token follows the JWT standard format (see jwt.io for an example). This is the token that should be sent in in the Authorization header when calling the other API end-points.

# components.schemas.TokenPost200ApplicationJsonResponse.properties.expires_in.description
The validity time in seconds of the token.

# components.schemas.oauth2TokenRequest.properties.auth_req_id.description
Authentication request ID.Value is only mandatory if grant_type is "urn:openid:params:grant-type:ciba"

# components.schemas.oauth2TokenRequest.properties.refresh_token.description
UUID.Refresh token retrieved from oauth2 token endpoint for consents with grant_type offline. This parameter is only valid if grant_type is refresh_token.

# components.schemas.oauth2TokenResponse.properties.access_token.description
Oauth2 JWT access token.The generated token is valid 3600 seconds as default.

# components.schemas.oauth2TokenResponse.properties.expires_in.description
Shows when the authentication request ID expires, in seconds.

# components.schemas.oauth2TokenResponse.properties.scope.description
List of scopes that belongs to the authentication request ID.

# components.schemas.oauth2TokenResponse.properties.refresh_token_expired_in.description
The time in seconds until the consent can no longer be refreshed. Based on the default value for consent validity, or the value set to parameter consent_valid_in sent in the bc-authorize request.

# components.schemas.consentkycResponse.properties.sub.description
Subject - Identifier for the End-User at the Issuer.

# components.schemas.consentkycResponse.properties.name.description
End-User's full name in displayable form including all name parts.

# components.schemas.consentkycResponse.properties.given_name.description
Given name(s) or first name(s) of the End-User.

# components.schemas.consentkycResponse.properties.family_name.description
Surname(s) or last name(s) of the End-User.

# components.schemas.consentkycResponse.properties.email.description
End-User's preferred e-mail address. Its value MUST conform to the  RFC 5322 [RFC5322] address specification syntax.

# components.schemas.consentkycResponse.properties.email_verified.description
The response value is True if the End-User's e-mail address has been verified;otherwise false.

# components.schemas.consentkycResponse.properties.phone_number_verified.description
The response value is True if the End-User's phone number has been verified; otherwise false.

# components.schemas.consentkycResponse.properties.updated_at.description
The time the End-User's information was last updated.

# components.schemas.consentkycResponse.properties.city_of_birth.description
The city of birth for the account holder.

# components.schemas.consentkycResponse.properties.identification_type.description
Type of identification.The first non-expired identification is always chosen.

# components.schemas.address.properties.formatted.description
Full mailing address, formatted for display or use on a mailing label. This field may contain multiple lines, separated by newlines.

# components.schemas.address.properties.street_address.description
Full street address component, which may include house number, street name, Post Office Box, and multi-line extended street address information.

# components.schemas.address.properties.region.description
State, province, prefecture, or region component.

# components.schemas.Party.description
Party identifies a account holder in the wallet platform. Party consists of two parameters, type and partyId. Each type have its own validation of the partyId
MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN
EMAIL - Validated to be a valid e-mail format. Validated with IsEmail
PARTY_CODE - UUID of the party. Validated with IsUuid

# components.schemas.PreApproval.properties.payerMessage.description
The mesage that is shown to the approver.

# components.schemas.PreApproval.properties.validityTime.description
The request validity time of the pre-approval

# components.schemas.PreApprovalResult.properties.payerMessage.description
The mesage that is shown to the approver.

# components.schemas.PreApprovalResult.properties.expirationDateTime.description
The expiry date +time of the preapproval, in YYYY-MM-DDTHH:mm:SS format

# components.schemas.RequestToPay.properties.amount.description
Amount that will be debited from the payer account.

# components.schemas.RequestToPay.properties.externalId.description
External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.

# components.schemas.RequestToPay.properties.payerMessage.description
Message that will be written in the payer transaction history message field.

# components.schemas.RequestToPay.properties.payeeNote.description
Message that will be written in the payee transaction history note field.

# components.schemas.RequestToPayResult.properties.amount.description
Amount that will be debited from the payer account.

# components.schemas.RequestToPayResult.properties.financialTransactionId.description
Financial transactionIdd from mobile money manager.<br> Used to connect to the specific financial transaction made in the account

# components.schemas.RequestToPayResult.properties.externalId.description
External id provided in the creation of the requestToPay transaction.

# components.schemas.RequestToPayResult.properties.payerMessage.description
Message that will be written in the payer transaction history message field.

# components.schemas.RequestToPayResult.properties.payeeNote.description
Message that will be written in the payee transaction history note field.

# components.schemas.Transfer.properties.amount.description
Amount that will be debited from the payer account.

# components.schemas.Transfer.properties.externalId.description
External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.

# components.schemas.Transfer.properties.payerMessage.description
Message that will be written in the payer transaction history message field.

# components.schemas.Transfer.properties.payeeNote.description
Message that will be written in the payee transaction history note field.

# components.schemas.TransferResult.properties.amount.description
Amount that will be debited from the payer account.

# components.schemas.TransferResult.properties.financialTransactionId.description
Financial transactionIdd from mobile money manager.<br> Used to connect to the specific financial transaction made in the account

# components.schemas.TransferResult.properties.externalId.description
External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.

# components.schemas.TransferResult.properties.payerMessage.description
Message that will be written in the payer transaction history message field.

# components.schemas.TransferResult.properties.payeeNote.description
Message that will be written in the payee transaction history note field.

# components.schemas.CreateInvoice.properties.externalId.description
External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique.

# components.schemas.CreateInvoice.properties.amount.description
Amount that will be debited from the payer account.

# components.schemas.CreateInvoice.properties.validityDuration.description
ValidityTime - The duration that the invoice is valid in seconds.

# components.schemas.CreateInvoice.properties.description.description
Message that will be written in the payer transaction history message field.

# components.schemas.InvoiceResult.properties.externalId.description
An external transaction id to tie to the payment.

# components.schemas.InvoiceResult.properties.currency.description
ISO4217 Currency - The currency used in this invoice.

# components.schemas.InvoiceResult.properties.paymentReference.description
A unique id that identifies a pending invoice.

# components.schemas.InvoiceResult.properties.expiryDateTime.description
DateTime for when invoice expires, in YYYY-MM-DD:THH:mm:ss format.

# components.schemas.InvoiceResult.properties.payeeFirstName.description
First name of the payee in this invoice.

# components.schemas.VoucherUser.properties.identificationType.description
Identification type for the voucher user.

# components.schemas.VoucherUser.properties.identification.description
A numeric string to identify the voucher user.

# components.schemas.VoucherUser.properties.msisdn.description
Msisdn of the voucher user. Needs to be set if alias, email, username nor externalId is set.

# components.schemas.VoucherUser.properties.alias.description
Alias of the voucher user. Needs to be set if msisdn, email, username nor externalId is set.

# components.schemas.VoucherUser.properties.email.description
Email of the voucher user. Needs to be set if msisdn, alias, username nor externalId is set.

# components.schemas.VoucherUser.properties.username.description
Username of the voucher user. Needs to be set if msisdn, alias, email nor externalId is set.

# components.schemas.VoucherUser.properties.externalId.description
ExternalId of the voucher user. Needs to be set if msisdn, alias, email nor username is set.

# components.schemas.CreateVoucher.properties.externalId.description
An external transaction id to tie to the voucher.

# components.schemas.CreateVoucher.properties.money.description
Amount to be payed with a specified currency.

# components.schemas.CreateVoucher.properties.secret.description
The secret (case insensitive) needed to redeem the voucher.

# components.schemas.VoucherStatus.properties.financialTransactionId.description
A transaction id associated with this voucher.

# components.schemas.VoucherOTP.properties.type.description
The type the one time password will represent REDEEM or CANCEL

# components.schemas.VoucherOTP.properties.msisdn.description
For the actual redeemer in case it differs from the intended redeemer.is validated using IsMSISDN

# components.schemas.VoucherDelete.properties.otp.description
The one time password (case insensitive) needed to cancel the voucher.

# components.schemas.VoucherDelete.properties.secret.description
The secret (case insensitive) needed to cancel the voucher.

# components.schemas.VoucherRedeem.properties.externalId.description
An external transaction id to tie to the voucher.

# components.schemas.VoucherRedeem.properties.otp.description
The one time password (case insensitive) needed to redeem the voucher.

# components.schemas.VoucherRedeem.properties.secret.description
The secret (case insensitive) needed to redeem the voucher.