Marketplace API

Information about our Marketplace API.

• Overview
  • 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
  • Create a connected account
  • Retrieve information about a connected account
  • Update connected account attributes
  • Send funds to a connected account
  • Create a transfer reversal
  • Create marketplace payment order
  • Cancel marketplace transaction
• Get Support

Overview

The below use cases relate to our marketplace solution.

Managing connected accounts

• Create a connected account - used to create a connected (seller) account
• Retrieve information about a connected account - optionally used to retrieve information about a connected (seller) account
• Update connected account attributes - optionally used to update information for a connected (seller) account

Manual transfers (online customer payments)

• Create payment order - used to generate an online payment order for the customer
• Send funds to a connected account - used to manually transfer funds to the seller(s) and marketplace owner

Automatic transfers (online customer payments)

• Create marketplace payment order - used to generate an online marketplace payment order for the customer (and perform automatic seller transfers)
• Send funds to a connected account - used to manually transfer funds to the marketplace owner

Manual transfers (in-store customer payments)

• Sale request (Android inter-app integration) - if using an Android inter-app integration, used to send a sale request to the POS
• Sale request (iOS inter-app integration) - if using an iOS inter-app integration, used to send a sale request to the POS
• Sale request (Cloud Terminal API integration) - if using a Cloud REST API integration, used to send a sale request to the POS
• Send funds to a connected account - used to manually transfer funds to the seller(s) and marketplace owner

Manual transfers (online customer refunds)

• Cancel transaction - used to cancel/refund a transaction
• Create a transfer reversal - used to retrieve funds back from the seller account(s)

Automatic transfers (online customer refunds)

• Cancel marketplace transaction - used to cancel/refund a marketplace transaction (and perform automatic seller transfer reversals)

Manual transfers (in-store customer refunds)

• Cancel request (Android inter-app integration) - if using an Android inter-app integration, used to send a cancel request to the POS
• Cancel request (iOS inter-app integration) - if using an iOS inter-app integration, used to send a cancel request to the POS
• Refund request (Cloud REST API integration) - if using a Cloud REST API integration, used to send a refund request to the POS
• Create a transfer reversal - used to retrieve funds back from the seller account(s)

Marketplace API calls

The Viva Marketplace API consists of the following API calls:

• Create a connected account
• Retrieve information about a connected account
• Update connected account attributes
• Send funds to a connected account
• Create a transfer reversal
• Create marketplace payment order
• Cancel marketplace transaction

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.

• This call will trigger the Account Connected webhook, if this has been set up
• Additionally, the Account Verification Status Changed webhook will be triggered when the verification status of the connected account changes

Retrieve information about a connected account

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

Update connected account attributes

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

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.

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.

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.

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.

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!