List all merchant accounts

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListMerchantAccountsResponse? res = await sdk.MerchantAccounts.ListAsync(limit: 20);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

{
  "items": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "account_updater_enabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": "merchant-account",
      "loon_client_key": "client-key-1234",
      "loon_secret_key": "key-12345",
      "loon_accepted_schemes": [
        "visa"
      ],
      "account_updater_request_encryption_key": "key-1234",
      "account_updater_request_encryption_key_id": "key-id-1234",
      "account_updater_response_decryption_key": "key-1234",
      "account_updater_response_decryption_key_id": "key-id-1234",
      "over_capture_amount": 1299,
      "over_capture_percentage": 25,
      "visa_network_tokens_requestor_id": "id-12345",
      "visa_network_tokens_app_id": "id-12345",
      "amex_network_tokens_requestor_id": "id-12345",
      "amex_network_tokens_app_id": "id-12345",
      "mastercard_network_tokens_requestor_id": "id-12345",
      "mastercard_network_tokens_app_id": "id-12345",
      "async_network_tokens_enabled": false
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

GET

merchant-accounts

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListMerchantAccountsResponse? res = await sdk.MerchantAccounts.ListAsync(limit: 20);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

{
  "items": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "account_updater_enabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": "merchant-account",
      "loon_client_key": "client-key-1234",
      "loon_secret_key": "key-12345",
      "loon_accepted_schemes": [
        "visa"
      ],
      "account_updater_request_encryption_key": "key-1234",
      "account_updater_request_encryption_key_id": "key-id-1234",
      "account_updater_response_decryption_key": "key-1234",
      "account_updater_response_decryption_key_id": "key-id-1234",
      "over_capture_amount": 1299,
      "over_capture_percentage": 25,
      "visa_network_tokens_requestor_id": "id-12345",
      "visa_network_tokens_app_id": "id-12345",
      "amex_network_tokens_requestor_id": "id-12345",
      "amex_network_tokens_app_id": "id-12345",
      "mastercard_network_tokens_requestor_id": "id-12345",
      "mastercard_network_tokens_app_id": "id-12345",
      "async_network_tokens_enabled": false
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

This endpoint requires the merchant-accounts.read scope.

Authorizations

Authorization

string

header

required

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

Query Parameters

cursor

string | null

A pointer to the page of results to return. A pointer to the page of results to return.

Example:

"ZXhhbXBsZTE"

limit

integer

default:20

The maximum number of items that are at returned. The maximum number of items that are at returned.

Required range: 1 <= x <= 100

string | null

The search term to filter merchant accounts by. The search term to filter merchant accounts by.

Example:

"merchant-12345"

Response

Successful Response

items

MerchantAccount · object[]

required

A list of items returned for this request.

Show child attributes

items.id

string

required

The ID for the merchant account.

Required string length: 1 - 50

items.display_name

string

required

The display name for the buyer.

Required string length: 1 - 255

items.account_updater_enabled

boolean

required

Whether the Real-Time Account Updater service is enabled for this merchant account. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to false, the Account Updater service doesn't get called if a payment fails with expired or invalid card details. If the field is set to true, the service is called. Please note that for this to work the other account_updater_* fields must be set as well.

items.created_at

string<date-time>

required

The date this merchant account was created at.

items.updated_at

string<date-time>

required

The date this merchant account was last updated at.

items.type

string

default:merchant-account

Always merchant-account.

Allowed value: "merchant-account"

items.loon_client_key

string | null

Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to null, the other loon_* fields must be set to null as well.

Example:

"client-key-1234"

items.loon_secret_key

string | null

Secret key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to null, the other loon_* fields must be set to null as well.

Example:

"key-12345"

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 we use and if the field is not set or if it's set to null, the Account Updater service doesn't get configured. If the field is set to null, the other loon_* fields must be set to null as well.

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

Example:

["visa"]

items.account_updater_request_encryption_key

string | null

The public key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to null, the Account Updater service doesn't get called. If the field is set, the other account_updater_* fields must be set as well.

Example:

"key-1234"

items.account_updater_request_encryption_key_id

string | null

The ID of the key used to encrypt the request to the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to null, the Account Updater service doesn't get called. If the field is set, the other account_updater_* fields must be set as well.

Example:

"key-id-1234"

items.account_updater_response_decryption_key

string | null

The key used to decrypt the response from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to null, the Account Updater service doesn't get called. If the field is set, the other account_updater_* fields must be set as well.

Example:

"key-1234"

items.account_updater_response_decryption_key_id

string | null

The ID of the key used to decrypt the request from the Real-Time Account Updater service. The Account Updater service is used to update card details when cards are lost, stolen or expired. If the field is not set or if it's set to null, the Account Updater service doesn't get called. If the field is set, the other account_updater_* fields must be set as well.

Example:

"key-id-1234"

items.over_capture_amount

integer | null

The maximum monetary amount allowed for over-capture, in the smallest currency unit, for example 1299 cents to allow for an over-capture of $12.99.

Example:

1299

items.over_capture_percentage

integer | null

The maximum percentage allowed for over-capture, for example 25 to allow for an over-capture of 25% of the original transaction amount.

Example:

25

items.visa_network_tokens_requestor_id

string | null

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

Example:

"id-12345"

items.visa_network_tokens_app_id

string | null

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

Example:

"id-12345"

items.amex_network_tokens_requestor_id

string | null

Requestor ID provided for American Express after onboarding to use Network Tokens.

Example:

"id-12345"

items.amex_network_tokens_app_id

string | null

Application ID provided for American Express after onboarding to use Network Tokens.

Example:

"id-12345"

items.mastercard_network_tokens_requestor_id

string | null

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

Example:

"id-12345"

items.mastercard_network_tokens_app_id

string | null

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

Example:

"id-12345"

items.async_network_tokens_enabled

boolean

default:false

When enabled network tokens will be generated asynchronously and only used on subsequent transactions to speed up transaction processing.

limit

integer

default:20

The number of items for this page.

Required range: 1 <= x <= 100

next_cursor

string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000

Example:

"ZXhhbXBsZTE"

previous_cursor

string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000

Example:

"Xkjss7asS"

List flow outcomes

Create a merchant account

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Payouts

Refunds

Sessions

Settlement records

Disputes

Instruments

Vault

Connections

Errors

Other

List all merchant accounts

Authorizations

Query Parameters

Response