Marketplace API

The Marketplace API is used with our marketplace solution.

This API call is available if you are a Viva Wallet marketplace owner. Please speak to your Viva Wallet sales representative to request access. Alternatively, you can contact us directly via our live chat facility. Simply click on the live chat icon in the bottom right-hand corner of this page.

API calls

The Viva Wallet Marketplace API consists of the following API calls:

Create a seller account

This API will be available soon. Please reach out via our Live Chat feature if you have any questions

This API call is used to create a seller account, the building block of this API that allows you to onboard sellers of goods in a marketplace platform scenario.

A valid call will result in HTTP status code 200 and generation of a unique sellerId.

Find out more about the Create a seller account API call and its parameters

Sale funds transfer

This API will be available soon. Please reach out via our Live Chat feature if you have any questions

This API call is used to transfer money to a seller account for a sale made earlier.

A valid call will result in HTTP status code 200 and generation of a unique transferId.

Find out more about the Sale funds transfer API call and its parameters

Direct funds transfer

This API will be available soon. Please reach out via our Live Chat feature if you have any questions

This API call is used to transfer funds directly to a seller account.

A valid call will result in HTTP status code 200 and generation of a unique transferId.

Find out more about the Direct funds transfer API call and its parameters

Reverse funds transfer

This API will be available soon. Please reach out via our Live Chat feature if you have any questions

This API call is used to reverse all or a part of the amount of a transfer made earlier.

A valid call will result in HTTP status code 200 and generation of a unique transferId.

Find out more about the Reverse funds transfer API call and its parameters

Create payment obligation

Enables marketplace owner to place an obligation to a seller, in order to request funds from the seller, for example in case of a customer refund. When the obligation is captured, Viva Wallet will transfer money from the seller account to the platform account. The identity of the transfer recipient (platform account) is implied in the credentials used for the API call’s authentication. The identity of the sender (seller) is acquired from the personID (Viva Wallet Merchant ID) defined as a body parameter in the API call.

A valid obligation API call will result in HTTP status code 200, "statusId": "A" and generation of a unique obligation ID. Obligations are captured within an hour. Obligations can be captured only if the account has enough funds (the entire amount), otherwise the obligation remains in a status of pending. A check is performed several times a day until the account has sufficient funds. The obligation is transformed into a transaction once it is captured. You can use a webhook to be notified of the capture and perform a subsequent action.

The obligation will not be visible on the marketplace seller dashboard until it is captured and becomes a transaction. However, the total balance will include the value of the obligation

Find out more about the Obligation API call and its parameters

Further information

Check out the related tutorials below for more details on the topics already covered:

Get Support

If you would like to integrate with Viva Wallet, or if you have any queries about our products and solutions, please see our Get Support page to see how we can help!