List merchant accounts

This endpoint requires the merchant-accounts.read scope.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

items

object[]

A list of merchant accounts.

items.type

enum<string>

merchant-account.

Available options:

merchant-account

items.id

string

The ID for this merchant account.

items.display_name

string

The display name of this merchant account.

items.outbound_webhook_url

string | null

The optional URL where webhooks will be received.

items.outbound_webhook_username

string | null

The optional username to use when outbound_webhook_url is configured and requires basic authentication.

items.outbound_webhook_password

string | null

The optional password to use when outbound_webhook_url is configured and requires basic authentication.

If the field is not null, the value is masked to avoid exposing sensitive information.

items.visa_network_tokens_requestor_id

string | null

Requestor ID provided for Visa after onboarding to use Network Tokens.

items.visa_network_tokens_app_id

string | null

Application ID provided for Visa after onboarding to use Network Tokens.

items.amex_network_tokens_requestor_id

string | null

Requestor ID provided for Amex after onboarding to use Network Tokens.

items.amex_network_tokens_app_id

string | null

Application ID provided for Amex after onboarding to use Network Tokens.

items.mastercard_network_tokens_requestor_id

string | null

Requestor ID provided for Mastercard after onboarding to use Network Tokens.

items.mastercard_network_tokens_app_id

string | null

Application ID provided for Mastercard after onboarding to use Network Tokens.

items.loon_client_key

string | null

Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy.

items.loon_secret_key

string | null

Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy.

If the field is not null, the value is masked to avoid exposing sensitive information.

items.loon_accepted_schemes

enum<string>[] | null

Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service used by Gr4vy.

Available options:

accel,

amex,

bancontact,

carte-bancaire,

cirrus,

culiance,

dankort,

diners-club,

discover,

eftpos-australia,

elo,

hipercard,

jcb,

maestro,

mastercard,

mir,

nyce,

other,

pulse,

rupay,

star,

uatp,

unionpay,

visa

items.created_at

string

The date and time when this merchant account was created.

items.updated_at

string

The date and time when this merchant account was updated.

limit

integer

default: 20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

next_cursor

string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

previous_cursor

string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Payments

Instruments

Vault

Connections

Dashboard

Errors

List merchant accounts

Authorizations

Response