Payments
- Transactions
- Buyers
- Checkout Sessions
- Payment links
- Payment options
- Payouts
- Refunds
- Sessions
- Settlement records
Instruments
- Card schemes
- Digital wallets
- Gift cards
- Payment methods
- Payment method definitions
Vault
- Account updater
- Network tokens
- Payment service tokens
- Vault Forward
- Vault Forward endpoints
- Vault Forward authentication
Connections
- All services
- Payment services
- Digital wallets
- Anti-fraud services
- Gift-card services
Other
- Flow
- Merchant accounts
- Reports
- Report executions
- Webhook subscriptions
List merchant accounts
Lists all merchant accounts in an instance.
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/merchant-accounts \
--header 'Authorization: Bearer <token>'{
"items": [
{
"type": "merchant-account",
"id": "plantly-uk",
"display_name": "Plantly UK",
"outbound_webhook_url": "https://www.example.com/webhook",
"outbound_webhook_username": "gr4vy",
"outbound_webhook_password": "********",
"visa_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"visa_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"amex_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"amex_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"mastercard_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"mastercard_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"loon_client_key": "7DD771287D0024BA418F8F7ECC7DF1CD",
"loon_secret_key": "********",
"loon_accepted_schemes": [
"mastercard",
"visa"
],
"created_at": "2022-02-01T14:20:00.000+00:00",
"updated_at": "2022-02-01T14:20:00.000+00:00",
"over_capture_amount": 1000,
"over_capture_percentage": 20
}
],
"limit": 1,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": null
}This endpoint requires the merchant-accounts.read scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
A list of merchant accounts.
merchant-account.
merchant-account "merchant-account"
The ID for this merchant account.
"plantly-uk"
The display name of this merchant account.
"Plantly UK"
The optional URL where webhooks will be received.
"https://www.example.com/webhook"
The optional username to use when outbound_webhook_url is configured and
requires basic authentication.
"gr4vy"
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.
"********"
Requestor ID provided for Visa after onboarding to use Network Tokens.
"e50fa0da-903d-4d54-aacc-4cac57d48df2"
Application ID provided for Visa after onboarding to use Network Tokens.
"e50fa0da-903d-4d54-aacc-4cac57d48df2"
Requestor ID provided for Amex after onboarding to use Network Tokens.
"e50fa0da-903d-4d54-aacc-4cac57d48df2"
Application ID provided for Amex after onboarding to use Network Tokens.
"e50fa0da-903d-4d54-aacc-4cac57d48df2"
Requestor ID provided for Mastercard after onboarding to use Network Tokens.
"e50fa0da-903d-4d54-aacc-4cac57d48df2"
Application ID provided for Mastercard after onboarding to use Network Tokens.
"e50fa0da-903d-4d54-aacc-4cac57d48df2"
Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy.
"7DD771287D0024BA418F8F7ECC7DF1CD"
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.
"********"
Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service used by Gr4vy.
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 ["mastercard", "visa"]
The date and time when this merchant account was created.
"2022-02-01T14:20:00.000+00:00"
The date and time when this merchant account was updated.
"2022-02-01T14:20:00.000+00:00"
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.
1 <= x <= 999999991000
The maximum percentage allowed for over-capture, for example 25 to allow for an
over-capture of 25% of the original transaction amount.
1 <= x <= 9999999920
The limit applied to request. This represents the number of items that are at maximum returned by this request.
1 <= x <= 1001
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
1 - 1000"ZXhhbXBsZTE"
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
1 - 1000null
Was this page helpful?
curl --request GET \
--url https://api.{gr4vy_id}.gr4vy.app/merchant-accounts \
--header 'Authorization: Bearer <token>'{
"items": [
{
"type": "merchant-account",
"id": "plantly-uk",
"display_name": "Plantly UK",
"outbound_webhook_url": "https://www.example.com/webhook",
"outbound_webhook_username": "gr4vy",
"outbound_webhook_password": "********",
"visa_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"visa_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"amex_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"amex_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"mastercard_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"mastercard_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"loon_client_key": "7DD771287D0024BA418F8F7ECC7DF1CD",
"loon_secret_key": "********",
"loon_accepted_schemes": [
"mastercard",
"visa"
],
"created_at": "2022-02-01T14:20:00.000+00:00",
"updated_at": "2022-02-01T14:20:00.000+00:00",
"over_capture_amount": 1000,
"over_capture_percentage": 20
}
],
"limit": 1,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": null
}