Marketplace API

Information about our Marketplace API.

Overview

The below use cases relate to our marketplace solution.

Managing connected accounts

Manual transfers (online customer payments)

Automatic transfers (online customer payments)

Manual transfers (in-store customer payments)

Manual transfers (online customer refunds)

Automatic transfers (online customer refunds)

Manual transfers (in-store customer refunds)

Marketplace API calls

These API calls are available if you are a Viva marketplace owner. Please speak to your Viva sales representative to request access. Alternatively, you can contact us directly via our live chat facility at the bottom right-hand corner of this page

The Viva Marketplace API consists of the following API calls:

Create a connected account

This API call is used to create a connected 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 accountId.

Find out more about this call in our API Docs

Retrieve information about a connected account

This API call is used to retrieve information about a connected seller account.

Find out more about this call in our API Docs

Update connected account attributes

This API call is used to update information for a connected seller account.

Find out more about this call in our API Docs

Create marketplace payment order

This API call is used to create a marketplace payment order. A valid call will result in HTTP status code 200 and generation of a unique orderCode.

This call will also trigger the Transfer Created webhook (when transfers are triggered with the transfer parameter), if this has been set up.

Find out more about this call in our API Docs

Send funds to a connected account

This API call is used to send funds to a connected seller or marketplace owner account, with or without linking the transfer to an existing transactionId. A valid call will result in HTTP status code 200 and generation of a unique transferId.

This call will also trigger the Transfer Created webhook, if this has been set up.

Find out more about this call in our API Docs

Create a transfer reversal

This API call is used to reverse a transfer made to a connected seller account. A valid call will result in HTTP status code 200 and generation of a unique transferId.

This call will also trigger the Transfer Created webhook, if this has been set up.

Find out more about this call in our API Docs

Cancel marketplace transaction

This API call is used to cancel a marketplace transaction.

This call will trigger the Transaction Reversal Created webhook, if this has been set up.

It will also trigger the Transfer Created webhook (when transfers are triggered with the reverseTransfers or refundPlatformFee parameters), if this has been set up.

Find out more about this call in our API Docs

Get Support

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