Rivier/ Reference/ shop

Open the provider's set-up pages for an account

post/payments/accounts/{id}/setup-link

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:admin
Sdk
shop.paymentAccount.setupLink
Cli
shop payment account setup link

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • returnPathstring
    Default: /app. At most 300 characters. Pattern: ^/app(/[A-Za-z0-9_-]+)*$.

Responses

  • 200application/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