List all merchant accounts

List all merchant accounts in an instance.

GET /merchant-accounts

C#

C#

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(
    cursor: "ZXhhbXBsZTE",
    limit: 20,
    search: "merchant-12345"
);

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

    res = await res.Next!();
}

200

{
  "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.

Example:

"ZXhhbXBsZTE"

limit · integer · default: 20

The maximum number of items that are at returned.

Required range: 1 <= x <= 100

Example:

20

search · string | null

The search term to filter merchant accounts by.

Example:

"merchant-12345"

Response

200

application/json

Successful Response

items · MerchantAccount · object[] · required

A list of items returned for this request.

Show child attributes

limit · integer · default: 20

The number of items for this page.

Required range: 1 <= x <= 100

Example:

20

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"