functions

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

More information: https://openapi-generator.tech

Contact Info: team@openapitools.org

Version: 1-alpha

BasePath:/v1

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

Default

post /merchants

(createMerchant)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

merchantInput MerchantInput (required)

Body Parameter —

Return type

MerchantOutput

Example data

Content-Type: application/json

{
  "stripeAcctId" : "stripeAcctId",
  "connectedAccountWebhookUrl" : "connectedAccountWebhookUrl",
  "gatewayAccountId" : "gatewayAccountId",
  "gatewayCredentials" : "gatewayCredentials",
  "transactionWebhookUrl" : "transactionWebhookUrl",
  "shopifyDomain" : "shopifyDomain",
  "stripeOnConnectionRedirectURL" : "stripeOnConnectionRedirectURL",
  "enabled" : true,
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "stripeURLToConnectAccount" : "stripeURLToConnectAccount",
  "commissionPercentage" : 0.8008281904610115,
  "gatewayURL" : "gatewayURL",
  "drveUid" : "drveUid",
  "testMode" : true,
  "name" : "name",
  "id" : "id",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Ok MerchantOutput

put /merchants/{drveUid}

(editMerchant)

Path parameters

drveUid (required)

Path Parameter — default: null

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

merchantInput MerchantInputEdit (required)

Body Parameter —

Return type

MerchantOutput

Example data

Content-Type: application/json

{
  "stripeAcctId" : "stripeAcctId",
  "connectedAccountWebhookUrl" : "connectedAccountWebhookUrl",
  "gatewayAccountId" : "gatewayAccountId",
  "gatewayCredentials" : "gatewayCredentials",
  "transactionWebhookUrl" : "transactionWebhookUrl",
  "shopifyDomain" : "shopifyDomain",
  "stripeOnConnectionRedirectURL" : "stripeOnConnectionRedirectURL",
  "enabled" : true,
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "stripeURLToConnectAccount" : "stripeURLToConnectAccount",
  "commissionPercentage" : 0.8008281904610115,
  "gatewayURL" : "gatewayURL",
  "drveUid" : "drveUid",
  "testMode" : true,
  "name" : "name",
  "id" : "id",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Ok MerchantOutput

get /merchants/{drveUid}

(getMerchant)

Path parameters

drveUid (required)

Path Parameter — default: null

Return type

Partial_MerchantOutput_

Example data

Content-Type: application/json

{
  "stripeAcctId" : "stripeAcctId",
  "gatewayAccountId" : "gatewayAccountId",
  "connectedAccountWebhookUrl" : "connectedAccountWebhookUrl",
  "gatewayCredentials" : "gatewayCredentials",
  "transactionWebhookUrl" : "transactionWebhookUrl",
  "shopifyDomain" : "shopifyDomain",
  "stripeOnConnectionRedirectURL" : "stripeOnConnectionRedirectURL",
  "enabled" : true,
  "stripeURLToConnectAccount" : "stripeURLToConnectAccount",
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "gatewayURL" : "gatewayURL",
  "commissionPercentage" : 0.8008281904610115,
  "drveUid" : "drveUid",
  "testMode" : true,
  "name" : "name",
  "id" : "id",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Ok Partial_MerchantOutput_

get /merchants

(getMerchants)

Return type

array[MerchantOutput]

Example data

Content-Type: application/json

{
  "stripeAcctId" : "stripeAcctId",
  "connectedAccountWebhookUrl" : "connectedAccountWebhookUrl",
  "gatewayAccountId" : "gatewayAccountId",
  "gatewayCredentials" : "gatewayCredentials",
  "transactionWebhookUrl" : "transactionWebhookUrl",
  "shopifyDomain" : "shopifyDomain",
  "stripeOnConnectionRedirectURL" : "stripeOnConnectionRedirectURL",
  "enabled" : true,
  "createdAt" : "2000-01-23T04:56:07.000+00:00",
  "stripeURLToConnectAccount" : "stripeURLToConnectAccount",
  "commissionPercentage" : 0.8008281904610115,
  "gatewayURL" : "gatewayURL",
  "drveUid" : "drveUid",
  "testMode" : true,
  "name" : "name",
  "id" : "id",
  "updatedAt" : "2000-01-23T04:56:07.000+00:00"
}