# info.description
Enable remote automatic collection of bills, fees or taxes

# paths./v2_0/invoice.post.description
A merchant may use this in order to create an invoice that can be paid by an intended payer via any channel at a later stage.

# paths./v2_0/invoice.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/invoice.post.parameters[].description
PUT Callback URL to send callback to once the invoice is completed.

# paths./v2_0/invoice.post.parameters[].description
Format - UUID. An id to uniquely identify the making of an invoice

# paths./v2_0/invoice.post.parameters[].description
The desired target environment to use that is allowed for the API user.

# paths./v2_0/invoice.post.requestBody.content.application/json.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/invoice.post.requestBody.content.application/json.example.validityDuration
string(The duration that the invoice is valid in seconds.)

# paths./v2_0/invoice.post.requestBody.content.application/json.example.description
string (An optional description of the invoice.)

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

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

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

# paths./v2_0/invoice/{x-referenceId}.get.description
This operation is used to get the status of an invoice. X-Reference-Id that was passed in the post is used as reference to the request

# paths./v2_0/invoice/{x-referenceId}.get.parameters[].description
UUID of transaction to get result. Reference id  used when creating the Invoice.

# paths./v2_0/invoice/{x-referenceId}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/invoice/{x-referenceId}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

# paths./v2_0/invoice/{x-referenceId}.get.responses.200.description
OK. Note that a  failed CreateInvoice will be returned with this status too. The 'status' of the CreateInvoice can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v2_0/invoice/{x-referenceId}.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v2_0/invoice/{x-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./v2_0/invoice/{x-referenceId}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v2_0/invoice/{referenceId}.delete.description
This operation is used to delete an invoice. The ReferenceId is associated with the invoice to be cancelled

# paths./v2_0/invoice/{referenceId}.delete.parameters[].description
UUID of transaction to get result. An id to uniquely identify the cancelling an Invoice

# paths./v2_0/invoice/{referenceId}.delete.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/invoice/{referenceId}.delete.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. The desired target environment to use that is allowed for the API user.

# paths./v2_0/invoice/{referenceId}.delete.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/invoice/{referenceId}.delete.parameters[].description
PUT Callback URL to send callback to once the invoice is completed.

# paths./v2_0/invoice/{referenceId}.delete.responses.200.description
OK. Note that a  failed CreateInvoice will be returned with this status too. The 'status' of the CreateInvoice can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v2_0/invoice/{referenceId}.delete.responses.200.content.Successful Invoice Deleted.schema.properties.externalId.description
An external transaction id to tie to the cancelling of an invoice.

# paths./v2_0/invoice/{referenceId}.delete.responses.200.content.Successful Invoice Deleted.schema.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/invoice/{referenceId}.delete.responses.200.content.application/json.schema.properties.externalId.description
An external transaction id to tie to the cancelling of an invoice.

# paths./v2_0/invoice/{referenceId}.delete.responses.200.content.application/json.schema.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/invoice/{referenceId}.delete.responses.200.content.application/json.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/invoice/{referenceId}.delete.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v2_0/invoice/{referenceId}.delete.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./v2_0/invoice/{referenceId}.delete.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v2_0/preapproval.post.description
Preapproval operation is used to create a pre-approval.

# paths./v2_0/preapproval.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/preapproval.post.parameters[].description
PUT Callback URL to send callback to once the invoice is completed.

# paths./v2_0/preapproval.post.parameters[].description
Format - UUID. An id to uniquely identify the making of an invoice

# paths./v2_0/preapproval.post.parameters[].description
The desired target environment to use that is allowed for the API user.

# paths./v2_0/preapproval.post.requestBody.content.application/json.example.payerCurrency
string(The currency code of the sending account. Amount to be paid.)

# paths./v2_0/preapproval.post.requestBody.content.application/json.example.validityTime
integer (The time duration in seconds that the pre-approval is valid once it is accepted.)

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

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

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

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

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

# paths./v2_0/preapproval/{referenceId}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

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

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

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

# paths./v2_0/preapproval/{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./v2_0/preapproval/{referenceId}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v2_0/payment.post.description
Making it possible to perform payments via the partner gateway. This may be used to pay for external bills or to perform air-time top-ups.

# paths./v2_0/payment.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/payment.post.parameters[].description
PUT Callback URL to send callback to once the invoice is completed.

# paths./v2_0/payment.post.parameters[].description
Format - UUID. An id to uniquely identify the making of an invoice

# paths./v2_0/payment.post.parameters[].description
The desired target environment to use that is allowed for the API user.

# paths./v2_0/payment.post.requestBody.content.application/json.example.externalTransactionId
string (An external transaction id to tie to the payment.)

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

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

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

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

# paths./v2_0/payment/{x-referenceId}.get.parameters[].description
UUID of transaction to get result. Reference id  used when creating the Payment.

# paths./v2_0/payment/{x-referenceId}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/payment/{x-referenceId}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

# paths./v2_0/payment/{x-referenceId}.get.responses.200.description
OK. Note that a  failed CreateInvoice will be returned with this status too. The 'status' of the CreateInvoice can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v2_0/payment/{x-referenceId}.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v2_0/payment/{x-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./v2_0/payment/{x-referenceId}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v1_0/account/balance.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1_0/account/balance.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform 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 AccountHolder number. Validated according to the AccountHolder 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

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

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/acti.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform 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
Bearer Authentication Token generated using CreateAccessToken API Call

# 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 Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform 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./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/basi.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/{accountHolderIdType}/{accountHolderId}/basi.get.parameters[].description
Type of account holder identity passed in accountHolderId path param.

Possible values:
MSISDN

Email

Alias

ID (account ID)

# paths./v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/basi.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

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

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.description
This operation is used to send delivery notifications for successfully completed transfers. The X-Reference-Id that was passed in the POST is used as reference to the request.

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

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.parameters[].description
An ISO 639-1 or ISO 639-3 language code. The language is used to select the best matching notification template when sending the delivery notification to the end-user. A default value is used if not specified.

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

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

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.responses.400.description
Bad request. Invalid data was sent in the request.

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.responses.404.description
Resource not found. The reference ID does not exist, or the calling user is not the owner of the financial transaction.

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.responses.409.description
Conflict. The transaction is not successfully completed.

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.responses.410.description
Gone. The delivery notification opportunity has expired.

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.responses.429.description
Too many requests. Too many attempts for the same ID has been made recently. This will only occur if a successful attempt has previously been performed.

# paths./v1_0/requesttopay/{referenceId}/deliverynotification.post.responses.500.description
Internal server error. An unexpected error occurred.

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

# paths./v1_0/account/balance/{currency}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1_0/account/balance/{currency}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform 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
Bearer Authentication Token generated using CreateAccessToken API Call

# 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 Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform 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.put.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.put.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

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

# paths./v2_0/requesttowithdraw.put.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.put.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

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

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

# paths./v2_0/requesttowithdraw.put.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
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1_0/requesttowithdraw/{referenceId}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform 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./v2_0/voucher.post.description
Voucher operation is used to create a voucher. Status of a voucher can be validated

# paths./v2_0/voucher.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/voucher.post.parameters[].description
PUT Callback URL to send callback to once the invoice is completed.

# paths./v2_0/voucher.post.parameters[].description
Format - UUID. An id to uniquely identify the making of an invoice

# paths./v2_0/voucher.post.parameters[].description
The desired target environment to use that is allowed for the API user.

# paths./v2_0/voucher.post.requestBody.content.application/json.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/voucher.post.requestBody.content.application/json.example.receiver.identificationType
string (PASS | CPFA | SRSA | NRIN | OTHR | DRLC | SOCS | AREG |IDCD | EMID)

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

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

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

# paths./v2_0/voucher/{voucherToken}/otp.get.description
This operation is used to generate voucher one time password

# paths./v2_0/voucher/{voucherToken}/otp.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/voucher/{voucherToken}/otp.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

# paths./v2_0/voucher/{voucherToken}/otp.get.responses.200.description
OK. Note that a  failed GetVoucherOTP will be returned with this status too. The 'status' of the GetVoucherOTP can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v2_0/voucher/{voucherToken}/otp.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v2_0/voucher/{voucherToken}/otp.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./v2_0/voucher/{voucherToken}/otp.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v2_0/voucher/{voucherToken}.delete.description
This operation is used to delete an voucher

# paths./v2_0/voucher/{voucherToken}.delete.parameters[].description
An id to uniquely identify the voucherToken

# paths./v2_0/voucher/{voucherToken}.delete.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/voucher/{voucherToken}.delete.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. The desired target environment to use that is allowed for the API user.

# paths./v2_0/voucher/{voucherToken}.delete.parameters[].description
Format - UUID. An id to uniquely identify the making of an invoice

# paths./v2_0/voucher/{voucherToken}.delete.parameters[].description
PUT Callback URL to send callback to once the invoice is completed.

# paths./v2_0/voucher/{voucherToken}.delete.responses.200.description
OK. Note that a  failed CreateInvoice will be returned with this status too. The 'status' of the CreateInvoice can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v2_0/voucher/{voucherToken}.delete.responses.200.content.Successful Invoice Deleted.schema.properties.externalId.description
An external transaction id to tie to the cancelling of an invoice.

# paths./v2_0/voucher/{voucherToken}.delete.responses.200.content.Successful Invoice Deleted.schema.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/voucher/{voucherToken}.delete.responses.200.content.application/json.schema.properties.externalId.description
An external transaction id to tie to the cancelling of an invoice.

# paths./v2_0/voucher/{voucherToken}.delete.responses.200.content.application/json.schema.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/voucher/{voucherToken}.delete.responses.200.content.application/json.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/voucher/{voucherToken}.delete.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v2_0/voucher/{voucherToken}.delete.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./v2_0/voucher/{voucherToken}.delete.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v2_0/voucher/{voucherToken}/redeem.post.description
This operation is used to redeem a voucher.

# paths./v2_0/voucher/{voucherToken}/redeem.post.parameters[].description
An id to uniquely identify the voucherToken

# paths./v2_0/voucher/{voucherToken}/redeem.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v2_0/voucher/{voucherToken}/redeem.post.parameters[].description
PUT Callback URL to send callback to once the invoice is completed.

# paths./v2_0/voucher/{voucherToken}/redeem.post.parameters[].description
Format - UUID. An id to uniquely identify the making of an invoice

# paths./v2_0/voucher/{voucherToken}/redeem.post.parameters[].description
The desired target environment to use that is allowed for the API user.

# paths./v2_0/voucher/{voucherToken}/redeem.post.requestBody.content.application/json.example.externalId
string (An external transaction id to tie to the payment.)

# paths./v2_0/voucher/{voucherToken}/redeem.post.requestBody.content.application/json.example.receiver.identificationType
string (PASS | CPFA | SRSA | NRIN | OTHR | DRLC | SOCS | AREG |IDCD | EMID)

# paths./v2_0/voucher/{voucherToken}/redeem.post.responses.400.description
Bad request, e.g. invalid data was sent in the request.

# paths./v2_0/voucher/{voucherToken}/redeem.post.responses.409.content.ReferenceId already in use.example.message
Duplicated reference id. Creation of resource failed.

# paths./v2_0/voucher/{voucherToken}/redeem.post.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

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

# paths./v2_0/voucher/{referenceId}.get.parameters[].description
UUID of transaction to get result. 	An id to uniquely identify the cancelling an invoice

# paths./v2_0/voucher/{referenceId}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

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

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

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

# paths./v2_0/voucher/{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./v2_0/voucher/{referenceId}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v2_0/voucher/{referenceId}.get.responses.500.content.Server Error.example.message
An internal error occurred while processing.

# paths./v3_0/voucher/{voucherToken}/otp/redeem.get.description
This operation is used to generate voucher one time password

# paths./v3_0/voucher/{voucherToken}/otp/redeem.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v3_0/voucher/{voucherToken}/otp/redeem.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

# paths./v3_0/voucher/{voucherToken}/otp/redeem.get.responses.200.description
OK. Note that a  failed GetVoucherOTP will be returned with this status too. The 'status' of the GetVoucherOTP can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v3_0/voucher/{voucherToken}/otp/redeem.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v3_0/voucher/{voucherToken}/otp/redeem.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./v3_0/voucher/{voucherToken}/otp/redeem.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v3_0/voucher/{voucherToken}/otp/redeem/{msisdn}.get.description
This operation is used to generate redeem voucher one time password, msisdn is the actual redeemer in case it differs from the intended redeemer which is validated using IsMSISDN.

# paths./v3_0/voucher/{voucherToken}/otp/redeem/{msisdn}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v3_0/voucher/{voucherToken}/otp/redeem/{msisdn}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

# paths./v3_0/voucher/{voucherToken}/otp/redeem/{msisdn}.get.responses.200.description
OK. Note that a  failed GetVoucherOTP will be returned with this status too. The 'status' of the GetVoucherOTP can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v3_0/voucher/{voucherToken}/otp/redeem/{msisdn}.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v3_0/voucher/{voucherToken}/otp/redeem/{msisdn}.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./v3_0/voucher/{voucherToken}/otp/redeem/{msisdn}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v3_0/voucher/{voucherToken}/otp/cancel.get.description
This operation is used to generate voucher one time password

# paths./v3_0/voucher/{voucherToken}/otp/cancel.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v3_0/voucher/{voucherToken}/otp/cancel.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

# paths./v3_0/voucher/{voucherToken}/otp/cancel.get.responses.200.description
OK. Note that a  failed GetVoucherOTP will be returned with this status too. The 'status' of the GetVoucherOTP can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v3_0/voucher/{voucherToken}/otp/cancel.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v3_0/voucher/{voucherToken}/otp/cancel.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./v3_0/voucher/{voucherToken}/otp/cancel.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v3_0/voucher/{voucherToken}/otp/cancel/{msisdn}.get.description
This operation is used to generate cancel voucher one time password, msisdn is the actual redeemer in case it differs from the intended redeemer which is validated using IsMSISDN.

# paths./v3_0/voucher/{voucherToken}/otp/cancel/{msisdn}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v3_0/voucher/{voucherToken}/otp/cancel/{msisdn}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.

# paths./v3_0/voucher/{voucherToken}/otp/cancel/{msisdn}.get.responses.200.description
OK. Note that a  failed GetVoucherOTP will be returned with this status too. The 'status' of the GetVoucherOTP can be used to determine the outcome of the request. The 'errorReason' field can be used to retrieve a cause in case of failure.

# paths./v3_0/voucher/{voucherToken}/otp/cancel/{msisdn}.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v3_0/voucher/{voucherToken}/otp/cancel/{msisdn}.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./v3_0/voucher/{voucherToken}/otp/cancel/{msisdn}.get.responses.500.content.Unspecified internal error.example.message
An internal error occurred while processing.

# paths./v1_0/bc-authorize.post.description
This operation is used to claim a consent by the account holder for the requested scopes.

# paths./v1_0/bc-authorize.post.parameters[].description
Value: Bearer JWT
Replace JWT with a valid token received from token endpoint in Wallet Platform.

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

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

# paths./oauth2/token/.post.description
This operation is used to claim a consent by the account holder for the requested scopes.

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

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

# paths./oauth2/v1_0/userinfo.get.description
This operation is used to claim a consent by the account holder for the requested scopes.

# paths./oauth2/v1_0/userinfo.get.parameters[].description
Bearer Token. Replace with a valid oauth2 token received from oauth2 token endpoint in Wallet Platform.

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

# 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 RequesttoPay.

# paths./v1_0/requesttopay/{referenceId}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1_0/requesttopay/{referenceId}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform 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.2/mm/Transactions/Type/Merchantpay.post.description
This operation is used by a merchant to request a payment from a consumer.This is an alternative interface to POST /v1_0/requesttopay. The financial transaction is in status pending until one of the following conditions occurs:
The transaction is authorized, or
The transaction is declined by the payer, or
The transaction is timed out by the system.
 Status of the transaction can be validated using GET /v1.2/mm/Transactions/{TransactionReference}

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.parameters[].description
PUT Callback URL to the server where the callback should be sent.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.parameters[].description
Format - UUID. Used to uniquely identify the transaction. This correlation id can be used in GET /transaction/\{transactionReference\} to get the result or status of the transaction.\nThis parameter corresponds to the X-Reference-Id parameter in a requesttopay request

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed.
This parameter is used to route the request to the Wallet Platform system that initiates the transaction.This parameter corresponds to X-Target-Environment parameter

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.requestingOrganisationTransactionReference.description
External transaction id in Wallet Platform. Included in transaction history.This parameter corresponds to externalId parameter in, for example, a requesttopay request.Validated with IsRestrictedString Max length: 256.If omitted this parameter populates for you with a generated UUID.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.creditParty.description
The account holder that the funds are sent to\nThis parameter corresponds to the payee parameter in a requesttopay request\nTransaction is rejected if a creditParty is provided and the party is not the same as the API user\n Only account identifiers of type accountid are allowed.Min list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.debitParty.description
The account holder that the funds are withdrawn from.\nThis parameter corresponds to the payer parameter in a requesttopay request.\nMin list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.amount.description
The monetary amount of the transaction.\nValidated with IsAmount Min length = 1, max = 23.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.currency.description
The currency of the transaction. A three letter currency code. For supported currencies, see the GSMA MM API specification

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.descriptionText.description
A description text which is visible for the creditParty.\nThis parameter corresponds to the payerMessage parameter in a requesttopay request.\nValidated with IsRestrictedString. Max length: 160.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.customData.items.properties.key.description
A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.customData.items.properties.value.description
The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.requestBody.content.application/json.schema.properties.customData.description
A list of key and value custom data for the transaction. Only an entry with "ownnote" as key is used. All other entries are ignored and have no impact on the transaction. The ownnote entry corresponds to the payeeNote parameter in a requesttopay request. Max list size: 20

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.202.content.application/json.schema.properties.serverCorrelationId.description
The correlation ID which was provided in the X-CorrelationID header in the request. Validated with IsUUID Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.202.content.application/json.schema.properties.status.description
The status of the transaction. At this stage, this value is always pending

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.202.content.application/json.schema.properties.notificationMethod.description
The notification method of the transaction. This is decided by whether X-Callback-Url was provided in the request or not. If a callback URL was provided this value is callback otherwise it is polling. Valid values: callback, polling

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.404.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.404.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.404.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.500.description
Internal Error. Note that if the retrieved request has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Merchantpay.post.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Transfer.post.description
This operation is used to transfer an amount from the owner of an account to a payee account. This is an alternative interface to POST /v1_0/transfer

# paths./v1.2/mm/Transactions/Type/Transfer.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1.2/mm/Transactions/Type/Transfer.post.parameters[].description
PUT Callback URL to the server where the callback should be sent.

# paths./v1.2/mm/Transactions/Type/Transfer.post.parameters[].description
Format - UUID. Used to uniquely identify the transaction. This correlation id can be used in GET /transaction/\{transactionReference\} to get the result or status of the transaction.\nThis parameter corresponds to the X-Reference-Id parameter in a requesttopay request

# paths./v1.2/mm/Transactions/Type/Transfer.post.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed.
This parameter is used to route the request to the Wallet Platform system that initiates the transaction.This parameter corresponds to X-Target-Environment parameter

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.requestingOrganisationTransactionReference.description
External transaction id in Wallet Platform. Included in transaction history.This parameter corresponds to externalId parameter in, for example, a requesttopay request.Validated with IsRestrictedString Max length: 256.If omitted this parameter populates for you with a generated UUID.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.creditParty.description
The account holder that the funds are sent to\nThis parameter corresponds to the payee parameter in a requesttopay request\nTransaction is rejected if a creditParty is provided and the party is not the same as the API user\n Only account identifiers of type accountid are allowed.Min list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.debitParty.description
The account holder that the funds are withdrawn from.\nThis parameter corresponds to the payer parameter in a requesttopay request.\nMin list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.amount.description
The monetary amount of the transaction.\nValidated with IsAmount Min length = 1, max = 23.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.currency.description
The currency of the transaction. A three letter currency code. For supported currencies, see the GSMA MM API specification

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.descriptionText.description
A description text which is visible for the creditParty.\nThis parameter corresponds to the payerMessage parameter in a requesttopay request.\nValidated with IsRestrictedString. Max length: 160.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.customData.items.properties.key.description
A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.customData.items.properties.value.description
The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256.

# paths./v1.2/mm/Transactions/Type/Transfer.post.requestBody.content.application/json.schema.properties.customData.description
A list of key and value custom data for the transaction. Only an entry with "ownnote" as key is used. All other entries are ignored and have no impact on the transaction. The ownnote entry corresponds to the payeeNote parameter in a requesttopay request. Max list size: 20

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.202.content.application/json.schema.properties.serverCorrelationId.description
The correlation ID which was provided in the X-CorrelationID header in the request. Validated with IsUUID Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.202.content.application/json.schema.properties.status.description
The status of the transaction. At this stage, this value is always pending

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.202.content.application/json.schema.properties.notificationMethod.description
The notification method of the transaction. This is decided by whether X-Callback-Url was provided in the request or not. If a callback URL was provided this value is callback otherwise it is polling. Valid values: callback, polling

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.404.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.404.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.404.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.500.description
Internal Error. Note that if the retrieved request has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Transfer.post.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Disbursement.post.description
This operation is used to transfer an amount from the owner of an account to a payee account. This is an alternative interface to POST /v1_0/transfer

# paths./v1.2/mm/Transactions/Type/Disbursement.post.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1.2/mm/Transactions/Type/Disbursement.post.parameters[].description
PUT Callback URL to the server where the callback should be sent.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.parameters[].description
Format - UUID. Used to uniquely identify the transaction. This correlation id can be used in GET /transaction/\{transactionReference\} to get the result or status of the transaction.\nThis parameter corresponds to the X-Reference-Id parameter in a requesttopay request

# paths./v1.2/mm/Transactions/Type/Disbursement.post.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed.
This parameter is used to route the request to the Wallet Platform system that initiates the transaction.This parameter corresponds to X-Target-Environment parameter

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.requestingOrganisationTransactionReference.description
External transaction id in Wallet Platform. Included in transaction history.This parameter corresponds to externalId parameter in, for example, a requesttopay request.Validated with IsRestrictedString Max length: 256.If omitted this parameter populates for you with a generated UUID.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.creditParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.creditParty.description
The account holder that the funds are sent to\nThis parameter corresponds to the payee parameter in a requesttopay request\nTransaction is rejected if a creditParty is provided and the party is not the same as the API user\n Only account identifiers of type accountid are allowed.Min list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.debitParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.debitParty.description
The account holder that the funds are withdrawn from.\nThis parameter corresponds to the payer parameter in a requesttopay request.\nMin list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.amount.description
The monetary amount of the transaction.\nValidated with IsAmount Min length = 1, max = 23.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.currency.description
The currency of the transaction. A three letter currency code. For supported currencies, see the GSMA MM API specification

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.descriptionText.description
A description text which is visible for the creditParty.\nThis parameter corresponds to the payerMessage parameter in a requesttopay request.\nValidated with IsRestrictedString. Max length: 160.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.customData.items.properties.key.description
A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.customData.items.properties.value.description
The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.requestBody.content.application/json.schema.properties.customData.description
A list of key and value custom data for the transaction. Only an entry with "ownnote" as key is used. All other entries are ignored and have no impact on the transaction. The ownnote entry corresponds to the payeeNote parameter in a requesttopay request. Max list size: 20

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.202.content.application/json.schema.properties.serverCorrelationId.description
The correlation ID which was provided in the X-CorrelationID header in the request. Validated with IsUUID Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.202.content.application/json.schema.properties.status.description
The status of the transaction. At this stage, this value is always pending

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.202.content.application/json.schema.properties.notificationMethod.description
The notification method of the transaction. This is decided by whether X-Callback-Url was provided in the request or not. If a callback URL was provided this value is callback otherwise it is polling. Valid values: callback, polling

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.404.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.404.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.404.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.500.description
Internal Error. Note that if the retrieved request has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/Type/Disbursement.post.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/{TransactionReference}.get.description
This operation is used to get the status of a transaction. 
 This is an alternative interface toGET /v1_0/transfer/{referenceId} and GET /v1_0/merchantPay/{referenceId}

# paths./v1.2/mm/Transactions/{TransactionReference}.get.parameters[].description
A reference to the transaction. This can either be the reference id which was provided in the X-CorrelationID header of the POST transaction request or the financial transaction id. Is either a UUID or a number. Min length: 1, Max length: 256.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1.2/mm/Transactions/{TransactionReference}.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed.
This parameter is used to route the request to the Wallet Platform system that initiates the transaction.This parameter corresponds to X-Target-Environment parameter

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.description
OK. Note that a  failed request 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.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.transactionReference.description
Unique reference for the transaction.Validated with IsRestrictedString. Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.transactionStatus.description
The status of the transaction. One of pending, successful, failed. Validated with IsRestrictedString. Min length: 1, Max length: 25

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.amount.description
The monetary amount of the transaction.\nValidated with IsAmount Min length = 1, max = 23.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.currency.description
The currency of the transaction. A three letter currency code. For supported currencies, see the GSMA MM API specification

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.creditParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.creditParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.creditParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.creditParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.creditParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.creditParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.creditParty.description
The account holder that the funds are sent to\nThis parameter corresponds to the payee parameter in a requesttopay request\nTransaction is rejected if a creditParty is provided and the party is not the same as the API user\n Only account identifiers of type accountid are allowed.Min list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.debitParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.debitParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.debitParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.debitParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.debitParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.debitParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.debitParty.description
The account holder that the funds are withdrawn from.\nThis parameter corresponds to the payer parameter in a requesttopay request.\nMin list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.type.description
The transaction type. Valid values: merchantpay, disbursement, transfer

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.descriptionText.description
A description text which is visible for the creditParty. This parameter corresponds to the payerMessage parameter in a requesttopay result. This parameter corresponds to the payeeNote parameter in a transfer result. Validated with IsRestrictedString. Max length: 16

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.customData.items.properties.key.description
A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.customData.items.properties.value.description
The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.customData.description
A list of key and value custom data for the transaction. Only an entry with "ownnote" as key is used. All other entries are ignored and have no impact on the transaction. The ownnote entry corresponds to the payeeNote parameter in a requesttopay request. Max list size: 20

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.200.content.application/json.schema.properties.requestingOrganisationTransactionReference.description
External transaction id in Wallet Platform. Included in transaction history. This parameter corresponds to the externalId parameter in, for example, a requesttopay result. This parameter corresponds to the externalId parameter in a transfer result. Validated with IsRestrictedString, Max length: 256

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.400.description
Bad request, e.g. an incorrectly formatted reference id was provided.

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.404.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.404.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.404.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Transactions/{TransactionReference}.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.2/mm/Transactions/{TransactionReference}.get.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Transactions/{TransactionReference}.get.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1_2/mm/accounts/balance.get.description
This operation is used to retrieve the balance of the owner of the user account

# paths./v1_2/mm/accounts/balance.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1_2/mm/accounts/balance.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed.
This parameter is used to route the request to the Wallet Platform system that initiates the transaction.This parameter corresponds to X-Target-Environment parameter

# paths./v1_2/mm/accounts/balance.get.responses.200.description
OK. Note that a  failed request will be returned with this status too

# paths./v1_2/mm/accounts/balance.get.responses.200.content.application/json.schema.properties.availableBalance.description
The available balance of the account.Validated with IsAmount, Min length = 1, = 23

# paths./v1_2/mm/accounts/balance.get.responses.200.content.application/json.schema.properties.currency.description
The currency of the account. A three letter currency code. For supported currencies, see the GSMA MM API specification

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

# paths./v1_2/mm/accounts/balance.get.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1_2/mm/accounts/balance.get.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1_2/mm/accounts/balance.get.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1_2/mm/accounts/balance.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_2/mm/accounts/balance.get.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1_2/mm/accounts/balance.get.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1_2/mm/accounts/balance.get.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.description
This operation is used to check the status of an account in the system. This is an alternative interface to GET /v1_0/accountholder/{accountHolderIdType}/{accountHolderId}/active

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.parameters[].description
The account identifier id. valid values: accountid, msisdn, identityalias, emailaddress. Other identifier specified in the GSMS MM API specification are not supported

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.parameters[].description
The account identifier id. Validated with IsRestricted key, Min length: 1, Max length: 256.Further validation based on identifier type:
accountid: IsUUID
msisdn: IsMsisdn.
identityalias: ISAlias
emailaddress: IsEmail

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.parameters[].description
The identifier of the Wallet Platform system where the transaction shall be processed.
This parameter is used to route the request to the Wallet Platform system that initiates the transaction.This parameter corresponds to X-Target-Environment parameter

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.200.description
OK. Note that a  failed request will be returned with this status too

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.200.content.application/json.schema.properties.accountStatus.description
The status of the account. Valid values: available, unavailable

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.400.description
Bad request, e.g invalid data was sent in the request

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.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_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1_2/mm/accounts/{identifierType}/{Identifier}/status.get.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Heartbeat.get.description
This operation is used to check the availability of the Partner Gateway service

# paths./v1.2/mm/Heartbeat.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1.2/mm/Heartbeat.get.responses.200.description
OK. Note that a  failed request will be returned with this status too

# paths./v1.2/mm/Heartbeat.get.responses.200.content.application/json.schema.properties.serviceStatus.description
The status of the service. Since the service is always considered available when this API is reached and the request is successful this value is always available

# paths./v1.2/mm/Heartbeat.get.responses.400.description
Bad request, e.g invalid data was sent in the request

# paths./v1.2/mm/Heartbeat.get.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Heartbeat.get.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Heartbeat.get.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Heartbeat.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.2/mm/Heartbeat.get.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Heartbeat.get.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Heartbeat.get.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.description
This operation is used to get poll the status of a transaction.This operation only supports transactions that have been created with the GSMA POST transaction API

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.parameters[].description
This can either be the correlation id which was provided in the X-CorrelationID header of the POST transaction request. Validated with IsUuid

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.parameters[].description
Bearer Authentication Token generated using CreateAccessToken API Call

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.200.description
OK. Note that a  failed request will be returned with this status too

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.200.content.application/json.schema.properties.serviceStatus.description
The status of the service. Since the service is always considered available when this API is reached and the request is successful this value is always available

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.400.description
Bad request, e.g invalid data was sent in the request

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.400.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.400.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.400.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.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.2/mm/Requeststates/{serverCorrelationId}.get.responses.500.content.application/json.schema.properties.errorCode.description
The harmonized error code identifying the reason for error

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.500.content.application/json.schema.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# paths./v1.2/mm/Requeststates/{serverCorrelationId}.get.responses.500.content.application/json.schema.properties.errorDateTime.description
The time stamp indicating when the error occurred

# 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.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.

# components.schemas.PaymentResult.properties.financialTransactionId.description
A transaction id associated with this payment.

# components.schemas.GSMAMerchantPay.properties.requestingOrganisationTransactionReference.description
External transaction id in Wallet Platform. Included in transaction history.This parameter corresponds to externalId parameter in, for example, a requesttopay request.Validated with IsRestrictedString Max length: 256.If omitted this parameter populates for you with a generated UUID.

# components.schemas.GSMAMerchantPay.properties.creditParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# components.schemas.GSMAMerchantPay.properties.creditParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# components.schemas.GSMAMerchantPay.properties.creditParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# components.schemas.GSMAMerchantPay.properties.creditParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# components.schemas.GSMAMerchantPay.properties.creditParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# components.schemas.GSMAMerchantPay.properties.creditParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# components.schemas.GSMAMerchantPay.properties.creditParty.description
The account holder that the funds are sent to\nThis parameter corresponds to the payee parameter in a requesttopay request\nTransaction is rejected if a creditParty is provided and the party is not the same as the API user\n Only account identifiers of type accountid are allowed.Min list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# components.schemas.GSMAMerchantPay.properties.debitParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# components.schemas.GSMAMerchantPay.properties.debitParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# components.schemas.GSMAMerchantPay.properties.debitParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# components.schemas.GSMAMerchantPay.properties.debitParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# components.schemas.GSMAMerchantPay.properties.debitParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# components.schemas.GSMAMerchantPay.properties.debitParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# components.schemas.GSMAMerchantPay.properties.debitParty.description
The account holder that the funds are withdrawn from.\nThis parameter corresponds to the payer parameter in a requesttopay request.\nMin list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# components.schemas.GSMAMerchantPay.properties.amount.description
The monetary amount of the transaction.\nValidated with IsAmount Min length = 1, max = 23.

# components.schemas.GSMAMerchantPay.properties.currency.description
The currency of the transaction. A three letter currency code. For supported currencies, see the GSMA MM API specification

# components.schemas.GSMAMerchantPay.properties.descriptionText.description
A description text which is visible for the creditParty.\nThis parameter corresponds to the payerMessage parameter in a requesttopay request.\nValidated with IsRestrictedString. Max length: 160.

# components.schemas.GSMAMerchantPay.properties.customData.items.properties.key.description
A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256

# components.schemas.GSMAMerchantPay.properties.customData.items.properties.value.description
The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256.

# components.schemas.GSMAMerchantPay.properties.customData.description
A list of key and value custom data for the transaction. Only an entry with "ownnote" as key is used. All other entries are ignored and have no impact on the transaction. The ownnote entry corresponds to the payeeNote parameter in a requesttopay request. Max list size: 20

# components.schemas.GSMATransaction202Response.properties.serverCorrelationId.description
The correlation ID which was provided in the X-CorrelationID header in the request. Validated with IsUUID Min length: 1, Max length: 256

# components.schemas.GSMATransaction202Response.properties.status.description
The status of the transaction. At this stage, this value is always pending

# components.schemas.GSMATransaction202Response.properties.notificationMethod.description
The notification method of the transaction. This is decided by whether X-Callback-Url was provided in the request or not. If a callback URL was provided this value is callback otherwise it is polling. Valid values: callback, polling

# components.schemas.GSMATransactionResponse.properties.transactionReference.description
Unique reference for the transaction.Validated with IsRestrictedString. Min length: 1, Max length: 256

# components.schemas.GSMATransactionResponse.properties.transactionStatus.description
The status of the transaction. One of pending, successful, failed. Validated with IsRestrictedString. Min length: 1, Max length: 25

# components.schemas.GSMATransactionResponse.properties.amount.description
The monetary amount of the transaction.\nValidated with IsAmount Min length = 1, max = 23.

# components.schemas.GSMATransactionResponse.properties.currency.description
The currency of the transaction. A three letter currency code. For supported currencies, see the GSMA MM API specification

# components.schemas.GSMATransactionResponse.properties.creditParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# components.schemas.GSMATransactionResponse.properties.creditParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# components.schemas.GSMATransactionResponse.properties.creditParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# components.schemas.GSMATransactionResponse.properties.creditParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# components.schemas.GSMATransactionResponse.properties.creditParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# components.schemas.GSMATransactionResponse.properties.creditParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# components.schemas.GSMATransactionResponse.properties.creditParty.description
The account holder that the funds are sent to\nThis parameter corresponds to the payee parameter in a requesttopay request\nTransaction is rejected if a creditParty is provided and the party is not the same as the API user\n Only account identifiers of type accountid are allowed.Min list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# components.schemas.GSMATransactionResponse.properties.debitParty.items.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# components.schemas.GSMATransactionResponse.properties.debitParty.items.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# components.schemas.GSMATransactionResponse.properties.debitParty.items.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# components.schemas.GSMATransactionResponse.properties.debitParty.items.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# components.schemas.GSMATransactionResponse.properties.debitParty.items.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# components.schemas.GSMATransactionResponse.properties.debitParty.items.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# components.schemas.GSMATransactionResponse.properties.debitParty.description
The account holder that the funds are withdrawn from.\nThis parameter corresponds to the payer parameter in a requesttopay request.\nMin list size: 1, Max list size: 10\nIf more than one entry is provided the first valid entry is used.

# components.schemas.GSMATransactionResponse.properties.type.description
The transaction type. Valid values: merchantpay, disbursement, transfer

# components.schemas.GSMATransactionResponse.properties.descriptionText.description
A description text which is visible for the creditParty. This parameter corresponds to the payerMessage parameter in a requesttopay result. This parameter corresponds to the payeeNote parameter in a transfer result. Validated with IsRestrictedString. Max length: 16

# components.schemas.GSMATransactionResponse.properties.customData.items.properties.key.description
A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256

# components.schemas.GSMATransactionResponse.properties.customData.items.properties.value.description
The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256.

# components.schemas.GSMATransactionResponse.properties.customData.description
A list of key and value custom data for the transaction. Only an entry with "ownnote" as key is used. All other entries are ignored and have no impact on the transaction. The ownnote entry corresponds to the payeeNote parameter in a requesttopay request. Max list size: 20

# components.schemas.GSMATransactionResponse.properties.requestingOrganisationTransactionReference.description
External transaction id in Wallet Platform. Included in transaction history. This parameter corresponds to the externalId parameter in, for example, a requesttopay result. This parameter corresponds to the externalId parameter in a transfer result. Validated with IsRestrictedString, Max length: 256

# components.schemas.GSMAAccountIdentifier.properties.value.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# components.schemas.GSMAAccountIdentifier.properties.value.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# components.schemas.GSMAAccountIdentifier.properties.value.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# components.schemas.GSMAAccountIdentifier.properties.value.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# components.schemas.GSMAAccountIdentifier.properties.value.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# components.schemas.GSMAAccountIdentifier.properties.value.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# components.schemas.GSMAAccountIdentifierValue.properties.accountid.description
Equivalent of PARTY_CODE in Wallet Paltform.\nAn ID connected to a registered API user.

# components.schemas.GSMAAccountIdentifierValue.properties.msisdn.description
Equivalent of MSISDN in Wallet Paltform.\nThe MSISDN of an account holder.

# components.schemas.GSMAAccountIdentifierValue.properties.identityalias.description
Equivalent of ALIAS in Wallet Paltform.\nAn alias which is connected to an account holder.

# components.schemas.GSMAAccountIdentifierValue.properties.emailaddress.description
Equivalent of EMAIL in Wallet Paltform.\nThe email address of an account holder.

# components.schemas.GSMAAccountIdentifierValue.properties.walletid.description
Equivalent of ACCOUNT_ID in Wallet Paltform.\nThe FRI ID of an MM account in Wallet Platform.\nExample: Given FRI: 123456789/MM, the walletid is 123456789.

# components.schemas.GSMAAccountIdentifierValue.properties.consumerno.description
Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\nThe ID of an account holder in Wallet Platform.\nExample: Given ID: 987654321/ID, the consumerno is 987654321.

# components.schemas.GSMACustomData.properties.key.description
A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256

# components.schemas.GSMACustomData.properties.value.description
The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256.

# components.schemas.GSMAError.properties.errorCode.description
The harmonized error code identifying the reason for error

# components.schemas.GSMAError.properties.errorDescription.description
A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256

# components.schemas.GSMAError.properties.errorDateTime.description
The time stamp indicating when the error occurred

# components.schemas.CreatePayments.properties.externalTransactionId.description
An external transaction id to tie to the payment.

# components.schemas.CreatePayments.properties.customerReference.description
A customer reference for a provider. Example: +46070911111

# components.schemas.CreatePayments.properties.serviceProviderUserName.description
A service provider name. Example: Electricity Inc.

# components.schemas.CreatePayments.properties.couponId.description
A coupon the user would like to redeem and use the reward as part of this payment.

# components.schemas.CreatePayments.properties.productId.description
Optional id of a product, used if paying for a product.

# components.schemas.CreatePayments.properties.productOfferingId.description
Optional id of a product offering, used when paying for a particular offering of a product.

# components.schemas.CreatePayments.properties.receiverMessage.description
A descriptive note for receiver transaction history.

# components.schemas.CreatePayments.properties.senderNote.description
A descriptive note for sender transaction history.

# components.schemas.CreatePayments.properties.includeSenderCharges.description
Specifies if sender charges, this is, fee and tax paid by the sender, should be included in the specified transaction amount. This means that the charges will be deducted from the transaction amount before the remaining amount is transferred to the receiver.True indicates that charges shall be included in the specified transaction amount. The default value is false, meaning that sender charges are charged on top of the transaction amount.