Rivier/ Reference/ shop

Shop payment account connect

post/payments/accounts

Connect a payment account (the business's own Stripe through a connection, or Skerry).

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:admin
Sdk
shop.paymentAccount.connect
Cli
shop payment account connect

Request bodyapplication/json, required

  • providerstringrequired
    One of: skerry, stripe, mock.
  • modestring
    One of: test, live. Default: test.
  • labelstring
    Default: . At most 80 characters.
  • connectionIdstring
    At most 100 characters.
  • legalNamestring
    At most 200 characters.
  • emailstring (email)
    At most 254 characters.
  • countrystring
    Pattern: ^[A-Z]{2}$.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown