Skip to content
Navigation

Revokes a grant of access.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/grants/{grant}/revoke

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • grant
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON required

  • reason
    string
    required
    maxLength: 500 · minLength: 1

Returns

200

Revokes a grant of access.

JSON
  • token_id
    required

    One of the following:

    • string
    • null
  • customer
    required

    One of the following:

    • object
    • null
  • product
    required

    One of the following:

    • object
    • null
  • tier
    required

    One of the following:

    • object
    • null
  • id
    string
    required
  • customer_id
    string
    required
  • product_id
    string
    required
  • tier_id
    required

    One of the following:

    • string
    • null
  • source_kind
    string
    required
  • source_ref
    required

    One of the following:

    • string
    • null
  • grant_reason
    required

    One of the following:

    • string
    • null
  • settlement_id
    required

    One of the following:

    • string
    • null
  • valid_from
    required

    One of the following:

    • string
    • null
  • ends_at
    required

    One of the following:

    • string
    • null
  • end_reason
    required

    One of the following:

    • string
    • null
  • status
    string
    required

    Where it stands now: not begun, standing, or how it ended.

  • revocable
    boolean
    required

    Whether revokeGrant may still end it.

  • granted_by
    required

    One of the following:

    • string
    • null
  • occurred_at
    required

    One of the following:

    • string
    • null
  • recorded_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close