Metadata

Search payers (Thrivory Payer IDs)

Changed on

Returns payer directory entries. Use system=internal to filter to Thrivory payer identifiers.

get/v1/metadata/payers

Request

  • Base URL
    https://api.sandbox.thrivory.com
  • URL
    https://api.sandbox.thrivory.com/v1/metadata/payers
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.thrivory.com/v1/oauth/token scopes: claims:read, claims:write, settlements:write, metadata:read, webhooks:manage, imports:write, payouts:write

Query parameters

qstring

Search by name, alias, or ID

system'Thrivory'

Identifier system (currently 'internal')

limitinteger

Max results to return

cursorstring

Opaque pagination cursor

Response

List of payers

idstring required

Payer ID in the specified system (e.g., 'thrivoryid:123456')

system'Thrivory' required

Identifier system

namestring required
aliasesstring[]

Changes

    • breaking

      removed the enum value stedi from the query request parameter system

    • warning

      added the new Thrivory enum value to the / response property for the response status

    • info

      added the new enum value Thrivory to the query request parameter system

    • info

      removed the stedi enum value from the / response property for the response status

    • info

      endpoint added