Auth-Service

Intro
token
- Request tokenpost
- Introspect tokenpost
certificate
- Realm certget

Entities

Entity
Entity Contact
- Modify contact information of an identified Entity.put
- Delete contact information of an identified Entity.delete
Entity Alias
- updates reference information of an entity object.put
Entity Children
- Retrieving an identified Entity childrens.get
Entity Status
- Retrieving status of an identified Entity.get
- Set the status of an entity with entityId.put
Entity User
Entity User Status
- Referenced user status retrieval.get
- Update user status .put
Entity User Credentials
- Modification of user credentials.post
- Resetting the user credentials.post
Entity Metadata Type
Entity ProfileData Type

Wallets

Wallets
Payment methods
- Creates a wallet for a payment method.post
- Get paymentsMethodsget
Transactions
- View Wallet Specific Transactionget

Payment Methods

Payment method types
- Retrieves payment method types and their attributes.get
- Retrieves a single payment method type and its attributes.get
Payment methods
Payment methods links
- Creates a link between a payment method and a wallet.post
- It obtains wallet links for a specific payment method.get

Quotations

Quotations
- Creating a quotation.post
- Get a quotation.get

Transactions

Transactions
Transactions Types
Metadatakeys

Hosted Checkout

Introduction
Checkout Request
- Use the POST method to create a checkout page.post

Service Providers

Service Providers
Bills
- Gets the bills using a payment reference for a specific billing company.get
- Gets the bills using a payment reference for a specific billing company.get
Products
- Obtains the products offfered by a Seller company.get
- Obtains the products offfered by a Seller company.get

Issuing

Cards
TenantProduct
- Get all products of a tenantget
MCC
Tokenization

Issuing - Tokenization Events (Client Side)

/tokenizationEvent
- Tokenization events receptionput

Issuing - External Auth (client side)

External Authorization
- Request authorization to clientpost
- Inform authorization updateput

Giftcards API

Cards

KYC (Know Your Customer)

Documents
- Upload a documentpost
- Download A Documentget
Faces
- Upload a photo or video as a face proofpost
- Download A face proof Documentget
Checks
- Create a Checkpost
Reports
- Retrieve a Report Objectget
- List Reports related to a Check Objectget

SUBSCRIPTIONS API

Subscriptions
Payment
PaymentAttempt
- Get all payment attemptsget
- Retries a paymentpost

Remittance API

Remittances
Catalogs

Recipients API

Recipients
Payout Methods

VIRTUAL-ACCOUNTS API

VirtualAccounts

Auth-Service

Intro
token
- Request tokenpost
- Introspect tokenpost
certificate
- Realm certget

Entities

Entity
Entity Contact
- Modify contact information of an identified Entity.put
- Delete contact information of an identified Entity.delete
Entity Alias
- updates reference information of an entity object.put
Entity Children
- Retrieving an identified Entity childrens.get
Entity Status
- Retrieving status of an identified Entity.get
- Set the status of an entity with entityId.put
Entity User
Entity User Status
- Referenced user status retrieval.get
- Update user status .put
Entity User Credentials
- Modification of user credentials.post
- Resetting the user credentials.post
Entity Metadata Type
Entity ProfileData Type

Wallets

Wallets
Payment methods
- Creates a wallet for a payment method.post
- Get paymentsMethodsget
Transactions
- View Wallet Specific Transactionget

Payment Methods

Payment method types
- Retrieves payment method types and their attributes.get
- Retrieves a single payment method type and its attributes.get
Payment methods
Payment methods links
- Creates a link between a payment method and a wallet.post
- It obtains wallet links for a specific payment method.get

Quotations

Quotations
- Creating a quotation.post
- Get a quotation.get

Transactions

Transactions
Transactions Types
Metadatakeys

Hosted Checkout

Introduction
Checkout Request
- Use the POST method to create a checkout page.post

Service Providers

Service Providers
Bills
- Gets the bills using a payment reference for a specific billing company.get
- Gets the bills using a payment reference for a specific billing company.get
Products
- Obtains the products offfered by a Seller company.get
- Obtains the products offfered by a Seller company.get

Issuing

Cards
TenantProduct
- Get all products of a tenantget
MCC
Tokenization

Issuing - Tokenization Events (Client Side)

/tokenizationEvent
- Tokenization events receptionput

Issuing - External Auth (client side)

External Authorization
- Request authorization to clientpost
- Inform authorization updateput

Giftcards API

Cards

KYC (Know Your Customer)

Documents
- Upload a documentpost
- Download A Documentget
Faces
- Upload a photo or video as a face proofpost
- Download A face proof Documentget
Checks
- Create a Checkpost
Reports
- Retrieve a Report Objectget
- List Reports related to a Check Objectget

SUBSCRIPTIONS API

Subscriptions
Payment
PaymentAttempt
- Get all payment attemptsget
- Retries a paymentpost

Remittance API

Remittances
Catalogs

Recipients API

Recipients
Payout Methods

VIRTUAL-ACCOUNTS API

VirtualAccounts

Creating a wallet.

post https://wallets:8081/wallets/

With a valid object representation, this endpoint allows creating a new wallet.

URL Expired

The URL for this request expired after 30 days.

Body Params

Represents the request body for the creation of a wallet.

entityId

string

Entity Id (either for a person or business).

walletStatus

string

Wallet status.

walletProfileData

array of objects

walletProfileData

metadata

array of objects

metadata

Headers

X-Date

date-time

Header parameter to inform the timestamp of the message creation. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.

X-CorrelationID

string

Header parameter to uniquely identify the request. Must be supplied as an UUID.

apikey

string

It is used to send the pre-shared client's API key to the server.

X-User-Bearer

string

required

It is used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

Responses

Response body

object

walletId

string

Wallet Id.

entityId

string

Entity Id (either for a person or a business).

walletStatus

string

Wallet status.

pre-active active blocked suspended deleted

lockReason

string

Blocking reason.

walletProfileData

array of objects

walletProfileData

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

metadata

array of objects

metadata

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

Headers

object

X-Date

date-time

Date and time when the response message was sent.

Response body

object

serverCorrelationId

string

required

length between 1 and 256

A unique identifier issued by the provider enabling the client to identify the RequestState resource on subsequent polling requests. Must be supplied as an UUID.

status

string

required

Informs the status of the request.

pending completed failed

pendingReason

string

length between 0 and 256

A text description that can be provided to describe the reason for a pending status.

notificationMethod

string

required

Indicates whether a callback will be issued or if the client will need to poll.

callback polling

objectReference

string

length between 0 and 256

Provides a reference for the subject resource, e.g. transaction reference.

expiryTime

date-time

Informs the time by which the provider will fail the request if completion criteria have not been met. For example, a debit party failing to authorize within the allocated time frame.

pollLimit

number

> 0

Indicates the number of polling attempts the provider will allow, for the given request status resource.

error

object

If the asynchronous processing failed, error details will be returned here.

errorCategory

string

required

Category that groups the error.

businessRule validation authorisation identification internal serviceUnavailable

errorCode

string

required

Harmonised error code identifying the error reason.

errordescription

string

length between 0 and 256

Text description of the error."

errorDateTime

date-time

Timestamp of the error.

errorParameters

array of objects

length ≤ 20

A collection of key/value pairs that can be used to populate additional object properties.

errorParameters

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

Headers

object

X-Date

date-time

Date and time when the response message was sent.

Response body

object

errorCategory

string

required

Category that groups the error.

businessRule validation authorisation identification internal serviceUnavailable

errorCode

string

required

Harmonised error code identifying the error reason.

errordescription

string

length between 0 and 256

Text description of the error."

errorDateTime

date-time

Timestamp of the error.

errorParameters

array of objects

length ≤ 20

A collection of key/value pairs that can be used to populate additional object properties.

errorParameters

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

Headers

object

X-Date

date-time

Date and time when the response message was sent.

Response body

object

errorCategory

string

required

Category that groups the error.

businessRule validation authorisation identification internal serviceUnavailable

errorCode

string

required

Harmonised error code identifying the error reason.

errordescription

string

length between 0 and 256

Text description of the error."

errorDateTime

date-time

Timestamp of the error.

errorParameters

array of objects

length ≤ 20

A collection of key/value pairs that can be used to populate additional object properties.

errorParameters

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

Headers

object

X-Date

date-time

Date and time when the response message was sent.

Response body

object

errorCategory

string

required

Category that groups the error.

businessRule validation authorisation identification internal serviceUnavailable

errorCode

string

required

Harmonised error code identifying the error reason.

errordescription

string

length between 0 and 256

Text description of the error."

errorDateTime

date-time

Timestamp of the error.

errorParameters

array of objects

length ≤ 20

A collection of key/value pairs that can be used to populate additional object properties.

errorParameters

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

Headers

object

X-Date

date-time

Date and time when the response message was sent.

Response body

object

errorCategory

string

required

Category that groups the error.

businessRule validation authorisation identification internal serviceUnavailable

errorCode

string

required

Harmonised error code identifying the error reason.

errordescription

string

length between 0 and 256

Text description of the error."

errorDateTime

date-time

Timestamp of the error.

errorParameters

array of objects

length ≤ 20

A collection of key/value pairs that can be used to populate additional object properties.

errorParameters

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

Headers

object

X-Date

date-time

Date and time when the response message was sent.

Response body

object

errorCategory

string

required

Category that groups the error.

businessRule validation authorisation identification internal serviceUnavailable

errorCode

string

required

Harmonised error code identifying the error reason.

errordescription

string

length between 0 and 256

Text description of the error."

errorDateTime

date-time

Timestamp of the error.

errorParameters

array of objects

length ≤ 20

A collection of key/value pairs that can be used to populate additional object properties.

errorParameters

object

key

string

required

length between 1 and 256

Identifies the type of additional property.

value

string

required

length between 1 and 256

Identifies the value of the additional property.

Headers

object

X-Date

date-time

Date and time when the response message was sent.

Updated over 1 year ago

ProfileData deletion.

View Wallet Information

Did this page help you?

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://wallets:8081/wallets/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

ProfileData deletion.

View Wallet Information

Did this page help you?

Auth-Service
Intro
token
Introspect tokenpost
Request tokenpost
certificate
Realm certget

Entities
Entity
Updating properties of an Entity.patch
Entity deletion.delete
Modify an identified Entity.put
Retrieving an identified Entity.get
Creating a new Entity.post
Retrieving Entities.get
Entity Contact
Delete contact information of an identified Entity.delete
Modify contact information of an identified Entity.put
Entity Alias
updates reference information of an entity object.put
Entity Children
Retrieving an identified Entity childrens.get
Entity Status
Set the status of an entity with entityId.put
Retrieving status of an identified Entity.get
Entity User
Deletion of a referenced user.delete
Referenced user retrieval.get
New user associated with an Entity.post
Users associated with an Entity.get
Entity User Status
Update user status .put
Referenced user status retrieval.get
Entity User Credentials
Resetting the user credentials.post
Modification of user credentials.post
Entity Metadata Type
Metadata deletion.delete
Modify an identified Metadata.put
Retrieve the metadata type.get
New metadata type associated with an Entity.post
Get all metadata type associated with an Entity.get
Entity ProfileData Type
ProfileData deletion.delete
Modify an identified ProfileData.put
Retrieve the ProfileData type.get
New ProfileData type associated with an Entity.post
Get all ProfileData type associated with an Entity.get

Wallets
Wallets
Creates a list of alias for a wallet.put
View Wallet Balanceget
View Wallet Entityget
Update a Walletpatch
View Wallet Informationget
Creating a wallet.post
Payment methods
Get paymentsMethodsget
Creates a wallet for a payment method.post
Transactions
View Wallet Specific Transactionget

Payment Methods
Payment method types
Retrieves a single payment method type and its attributes.get
Retrieves payment method types and their attributes.get
Payment methods
Creates a list of alias for a payment method.put
Deletes a payment method.delete
Returns the balance of a payment method.get
Payment methods links
It obtains wallet links for a specific payment method.get
Creates a link between a payment method and a wallet.post

Quotations
Quotations
Get a quotation.get
Creating a quotation.post

Transactions
Transactions
Get all enabled currenciesget
Creating a refundpost
Creating a disputepost
Creating an annulmentpost
Creating a reversalpost
Update a Transaction:patch
View a transactionget
Creating a transaction.post
Transactions Types
Add Transaction Subtypes for a given Typepost
Get all Transaction Subtypes for a given typeget
Get all Transaction Typesget
Metadatakeys
Delete a Transaction Metadata Keydelete
Add a Transaction Metadata Keyput
Get all Transaction Metadata Keysget

Hosted Checkout
Introduction
Checkout Request
Use the POST method to create a checkout page.post

Service Providers
Service Providers
View Service Providers Companiesget
View Products configurationget
View Pay Bill configurationget
Bills
Gets the bills using a payment reference for a specific billing company.get
Gets the bills using a payment reference for a specific billing company.get
Products
Obtains the products offfered by a Seller company.get
Obtains the products offfered by a Seller company.get

Issuing
Cards
Enable a printed digitalFirst card for POSput
Print a virtual card if the product is digitalFirstput
Set profile to a cardput
Unblock a Cardput
Block a card (it is reversible)put
Deactivate the card identified by cardReferenceput
Assign a physical card identified by cardReferenceput
Set a new CVV to a cardput
Reset Card PINpost
Assign Card PINput
Activcate the card identified by cardReferenceput
Patch a card datapatch
Retrieve a card object identified by cardReferenceget
returns a list of cards matching with the filtering criteria.get
Create a nominated cardpost
TenantProduct
Get all products of a tenantget
MCC
Retrieve a MCC category nameget
Retrieve a MCC category infoget
Get all MCC categoriesget
Tokenization
Delete a token of a cardpost
Unstop a token of a cardpost
Stop a token of a cardpost
Activate a token of a cardpost
List tokensget

Issuing - Tokenization Events (Client Side)
/tokenizationEvent
Tokenization events receptionput

Issuing - External Auth (client side)
External Authorization
Inform authorization updateput
Request authorization to clientpost

Giftcards API
Cards
Put Giftcard for card deactivationput
Put Giftcard for card activationput
Patch Giftcardpatch
Get Giftcard Info by IDget
Post Giftcardpost
Get Giftcard Info filtered listget

KYC (Know Your Customer)
Documents
Download A Documentget
Upload a documentpost
Faces
Download A face proof Documentget
Upload a photo or video as a face proofpost
Checks
Create a Checkpost
Reports
List Reports related to a Check Objectget
Retrieve a Report Objectget

SUBSCRIPTIONS API
Subscriptions
Get Subscription Info by IDget
Post Subscriptionpost
Get Subscription Info filtered listget
Payment
Manually creates or modifies a paymentput
Get payment dataget
Get payments by filtersget
PaymentAttempt
Retries a paymentpost
Get all payment attemptsget

Remittance API
Remittances
Refund a remittanceput
Cancels a remittancepost
Get a remittanceget
Get remittancesget
Create a remittancepost
Create a quotepost
Execute a quote previewpost
Catalogs
Get states for a specific countryget
Get payout methodsget
Get list of available countriesget
Get Payment Agent Branchesget
Get Payment Agent Regionsget
Get Payment Agentsget

Recipients API
Recipients
Partially update recipient informationpatch
Delete recipient by IDdelete
Get recipient by IDget
Get all recipientsget
Create a new remittance recipientpost
Payout Methods
Partially update payout method information using JSON Patchpatch
Get a payout method by ID for a recipientdelete
Get a payout method by ID for a recipientget
Get all payout methods for a recipientget
Add a payout method for a recipientpost

VIRTUAL-ACCOUNTS API
VirtualAccounts
Patch VirtualAccountpatch
Delete VirtualAccountdelete
Get VirtualAccount Info by RequestReferenceget
Post VirtualAccountpost
Get VirtualAccount Info filtered listget

Auth-Service
Intro
token
Introspect tokenpost
Request tokenpost
certificate
Realm certget

Entities
Entity
Updating properties of an Entity.patch
Entity deletion.delete
Modify an identified Entity.put
Retrieving an identified Entity.get
Creating a new Entity.post
Retrieving Entities.get
Entity Contact
Delete contact information of an identified Entity.delete
Modify contact information of an identified Entity.put
Entity Alias
updates reference information of an entity object.put
Entity Children
Retrieving an identified Entity childrens.get
Entity Status
Set the status of an entity with entityId.put
Retrieving status of an identified Entity.get
Entity User
Deletion of a referenced user.delete
Referenced user retrieval.get
New user associated with an Entity.post
Users associated with an Entity.get
Entity User Status
Update user status .put
Referenced user status retrieval.get
Entity User Credentials
Resetting the user credentials.post
Modification of user credentials.post
Entity Metadata Type
Metadata deletion.delete
Modify an identified Metadata.put
Retrieve the metadata type.get
New metadata type associated with an Entity.post
Get all metadata type associated with an Entity.get
Entity ProfileData Type
ProfileData deletion.delete
Modify an identified ProfileData.put
Retrieve the ProfileData type.get
New ProfileData type associated with an Entity.post
Get all ProfileData type associated with an Entity.get

Wallets
Wallets
Creates a list of alias for a wallet.put
View Wallet Balanceget
View Wallet Entityget
Update a Walletpatch
View Wallet Informationget
Creating a wallet.post
Payment methods
Get paymentsMethodsget
Creates a wallet for a payment method.post
Transactions
View Wallet Specific Transactionget

Payment Methods
Payment method types
Retrieves a single payment method type and its attributes.get
Retrieves payment method types and their attributes.get
Payment methods
Creates a list of alias for a payment method.put
Deletes a payment method.delete
Returns the balance of a payment method.get
Payment methods links
It obtains wallet links for a specific payment method.get
Creates a link between a payment method and a wallet.post

Quotations
Quotations
Get a quotation.get
Creating a quotation.post

Transactions
Transactions
Get all enabled currenciesget
Creating a refundpost
Creating a disputepost
Creating an annulmentpost
Creating a reversalpost
Update a Transaction:patch
View a transactionget
Creating a transaction.post
Transactions Types
Add Transaction Subtypes for a given Typepost
Get all Transaction Subtypes for a given typeget
Get all Transaction Typesget
Metadatakeys
Delete a Transaction Metadata Keydelete
Add a Transaction Metadata Keyput
Get all Transaction Metadata Keysget

Hosted Checkout
Introduction
Checkout Request
Use the POST method to create a checkout page.post

Service Providers
Service Providers
View Service Providers Companiesget
View Products configurationget
View Pay Bill configurationget
Bills
Gets the bills using a payment reference for a specific billing company.get
Gets the bills using a payment reference for a specific billing company.get
Products
Obtains the products offfered by a Seller company.get
Obtains the products offfered by a Seller company.get

Issuing
Cards
Enable a printed digitalFirst card for POSput
Print a virtual card if the product is digitalFirstput
Set profile to a cardput
Unblock a Cardput
Block a card (it is reversible)put
Deactivate the card identified by cardReferenceput
Assign a physical card identified by cardReferenceput
Set a new CVV to a cardput
Reset Card PINpost
Assign Card PINput
Activcate the card identified by cardReferenceput
Patch a card datapatch
Retrieve a card object identified by cardReferenceget
returns a list of cards matching with the filtering criteria.get
Create a nominated cardpost
TenantProduct
Get all products of a tenantget
MCC
Retrieve a MCC category nameget
Retrieve a MCC category infoget
Get all MCC categoriesget
Tokenization
Delete a token of a cardpost
Unstop a token of a cardpost
Stop a token of a cardpost
Activate a token of a cardpost
List tokensget

Issuing - Tokenization Events (Client Side)
/tokenizationEvent
Tokenization events receptionput

Issuing - External Auth (client side)
External Authorization
Inform authorization updateput
Request authorization to clientpost

Giftcards API
Cards
Put Giftcard for card deactivationput
Put Giftcard for card activationput
Patch Giftcardpatch
Get Giftcard Info by IDget
Post Giftcardpost
Get Giftcard Info filtered listget

KYC (Know Your Customer)
Documents
Download A Documentget
Upload a documentpost
Faces
Download A face proof Documentget
Upload a photo or video as a face proofpost
Checks
Create a Checkpost
Reports
List Reports related to a Check Objectget
Retrieve a Report Objectget

SUBSCRIPTIONS API
Subscriptions
Get Subscription Info by IDget
Post Subscriptionpost
Get Subscription Info filtered listget
Payment
Manually creates or modifies a paymentput
Get payment dataget
Get payments by filtersget
PaymentAttempt
Retries a paymentpost
Get all payment attemptsget

Remittance API
Remittances
Refund a remittanceput
Cancels a remittancepost
Get a remittanceget
Get remittancesget
Create a remittancepost
Create a quotepost
Execute a quote previewpost
Catalogs
Get states for a specific countryget
Get payout methodsget
Get list of available countriesget
Get Payment Agent Branchesget
Get Payment Agent Regionsget
Get Payment Agentsget

Recipients API
Recipients
Partially update recipient informationpatch
Delete recipient by IDdelete
Get recipient by IDget
Get all recipientsget
Create a new remittance recipientpost
Payout Methods
Partially update payout method information using JSON Patchpatch
Get a payout method by ID for a recipientdelete
Get a payout method by ID for a recipientget
Get all payout methods for a recipientget
Add a payout method for a recipientpost

VIRTUAL-ACCOUNTS API
VirtualAccounts
Patch VirtualAccountpatch
Delete VirtualAccountdelete
Get VirtualAccount Info by RequestReferenceget
Post VirtualAccountpost
Get VirtualAccount Info filtered listget

201Represents a transaction response.

202Represents an asynchronous response.

400Represents an error caused by a business rule violation.

401Represents an error caused by an authorization failure.

404Represents an error caused by a failure to identify the target resource.

500Represents an error caused by a general server-side issue.

503Represents an error caused by system unavailability.