Skip to main content

Marketplace API

Download OpenAPI specification:Download

Symblepay Marketplace API makes it easy for you to setup secure payments on your marketplace.

Trades

Initiate new trade

Authorizations:
Admin ApiKey
header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Request Body schema: application/json
required
title
required
string [ 1 .. 64 ] characters

The title users will see for this item in Symblepay

description
required
string [ 1 .. 5000 ] characters

The description users will see for this item in Symblepay

amount
required
number <double> [ 5 .. 15000 ]

The amount of money the item is being sold for. The amount will be rounded to 2 decimals if more than two decimals are send.

payerFee
required
number <double> [ 0 .. 100 ]

The percentage used to calculate the payers fee on top of the amount. This fee is the total fee and the agreed Symblepay percentage fee will be taken from this value.

payeeFee
required
number <double> [ 0 .. 100 ]

The percentage used to calculate the payees fee taken before payouts. This fee is the total fee and the agreed Symblepay percentage fee will be taken from this value.

payerMarketplaceUserId
required
string [ 1 .. 64 ] characters

The marketplace user id for the payer in the trade

payeeMarketplaceUserId
required
string [ 1 .. 64 ] characters

The marketplace user id for the payee in the trade. This user should already be connected through the connect-flow

referenceId
string or null <= 64 characters

The reference id for this trade on the Marketplace side.

checkoutIdempotencyKey
required
string [ 1 .. 64 ] characters

The unique idempotency key for this trade. There will only be at most one successfull payment and checkout for this key

object (SubmitCheckoutCommand.Command.CheckoutBody.ShippingData)
object (SubmitCheckoutCommand.Command.CheckoutBody.ShippingData)
successUrl
required
string [ 1 .. 2048 ] characters

The uri users are forwarded to after a successful payment.

cancelUrl
required
string [ 1 .. 2048 ] characters

The uri users are returned to if they cancel the flow.

imageUrls
Array of strings or null

Optional list of image uris used to describe the item.

object (MarketplaceConstants.AppSwitchModel)

Responses

Request samples

Content type
application/json
{
  • "title": "Adidas Campus 00s",
  • "description": "Almost new Adidas Campus 00s. Used 3 times and still have the box and receipt.",
  • "amount": 1200.5,
  • "payerFee": 5,
  • "payeeFee": 3.5,
  • "payerMarketplaceUserId": "003dc3d2-dc30-4b37-a573-f664a03f5154",
  • "payeeMarketplaceUserId": "82f700bd-5789-4623-95e7-0d34fde4720c",
  • "referenceId": "971861ba-947a-4b54-9c3d-be3eaa16b113",
  • "checkoutIdempotencyKey": "e5e09423-1ebb-46ce-847c-24970479373a",
  • "shipping": {
    },
  • "returnShipping": null,
  • "appSwitch": null
}

Response samples

Content type
application/json
{}

Cancel ongoing trade

Authorizations:
Admin ApiKey
header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Request Body schema: application/json
required
state
required
string [ 1 .. 64 ] characters

The state id of the trade.

Responses

Request samples

Content type
application/json
{
  • "state": "string"
}

Response samples

Content type
application/json
{
  • "state": "string"
}

Get trades

Authorizations:
Admin ApiKey
path Parameters
marketplaceUserId
required
string [ 1 .. 64 ] characters

The unique user id. This should be the same id, that is used when using the connection-flow.

header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Responses

Response samples

Content type
application/json
{
  • "trades": [
    ],
  • "pagination": {
    }
}

Get trade details

Authorizations:
Admin ApiKey
path Parameters
marketplaceUserId
required
string [ 1 .. 64 ] characters

The unique user id. This should be the same id, that is used when using the connection-flow.

tradeId
required
string [ 1 .. 64 ] characters

The trade id to get details for

header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Responses

Response samples

Content type
application/json
{
  • "tradeId": "a95a1320-fce8-4838-9ff2-286501b45350",
  • "payer": {
    },
  • "payee": {
    },
  • "referenceId": "3811b9da-dd5b-4834-b266-2414e76276aa",
  • "title": "Adidas Campus 00s",
  • "description": "Campus 00s Crystal White / Core Black / Off White",
  • "price": 1050,
  • "phases": {
    },
  • "images": null
}

Get trade status link

Authorizations:
Admin ApiKey
path Parameters
marketplaceUserId
required
string [ 1 .. 64 ] characters

The unique user id. This should be the same id, that is used when using the connection-flow.

tradeId
required
string [ 1 .. 64 ] characters

The trade id to get details for

header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Request Body schema: application/json
required

Setup information for the status flow

returnUrl
required
string [ 1 .. 2048 ] characters
object (MarketplaceConstants.AppSwitchModel)

Responses

Request samples

Content type
application/json
{
  • "returnUrl": "string",
  • "appSwitch": {
    }
}

Response samples

Content type
application/json

Users

Initiate user connect

Authorizations:
Admin ApiKey
query Parameters
forceOnboarding
boolean
Default: false

Toggle to ensure users are forced through a MitID sign-in flow when they connect with Symblepay. This can be used to overwrite potential cookies set in a users session.

header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Request Body schema: application/json
required
successUrl
required
string [ 1 .. 2048 ] characters

The uri users are forwarded to after a successful flow.

cancelUrl
required
string [ 1 .. 2048 ] characters

The uri users are forwarded to after cancelling a flow.

object (MarketplaceConstants.AppSwitchModel)
marketplaceUserId
required
string [ 1 .. 64 ] characters

The marketplace user id to connect

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json

Initiate select payout account

Authorizations:
Admin ApiKey
path Parameters
marketplaceUserId
required
string [ 1 .. 64 ] characters

The marketplace user id

header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Request Body schema: application/json
returnUrl
string or null
object (MarketplaceConstants.AppSwitchModel)

Responses

Request samples

Content type
application/json
{
  • "returnUrl": "string",
  • "appSwitch": {
    }
}

Response samples

Content type
application/json

Get user details

Authorizations:
Admin ApiKey
path Parameters
marketplaceUserId
required
string [ 1 .. 64 ] characters

The marketplace user id

header Parameters
X-Correlation-Id
string <uuid> [ 20 .. 64 ] characters

Correlation ID used for logging.

Responses

Response samples

Content type
application/json
{
  • "symblepayUserId": "9a1d4a0c-9700-4e18-bc77-7bc7d4a32c66",
  • "bankAccount": {
    }
}