POST

/merchant-accounts

curl --request POST \
  --url https://api.sandbox.{gr4vy_id}.gr4vy.app/merchant-accounts \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json'
{
  "status": "201",
  "example": {
    "created_at": "2022-02-01T14:20:00.000+00:00",
    "display_name": "Plantly UK",
    "id": "plantly-uk",
    "outbound_webhook_url": "https://www.example.com/webhook",
    "outbound_webhook_username": "gr4vy",
    "type": "merchant-account",
    "updated_at": "2022-02-01T14:20:00.000+00:00",
    "visa_network_tokens_app_id": "ca12b3d0-4e23-41a9-906f-e5cbb8e6a731",
    "visa_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2"
  }
}

This endpoint requires the merchant-accounts.write scope.

Authorizations

Authorizationheaderrequired
string

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

Body

application/json
amex_network_tokens_app_id
string | null

Application ID provided for Amex after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.

amex_network_tokens_requestor_id
string | null

Requestor ID provided for Amex after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.

display_name
string

The human-readable name of the merchant account.

id
string

The unique ID for the merchant account.

mastercard_network_tokens_app_id
string | null

Application ID provided for Mastercard after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.

mastercard_network_tokens_requestor_id
string | null

Requestor ID provided for Mastercard after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.

outbound_webhook_password
string | null

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

outbound_webhook_url
string | null

The optional URL where webhooks will be received.

outbound_webhook_username
string | null

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

visa_network_tokens_app_id
string | null

Application ID provided for Visa after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.

visa_network_tokens_requestor_id
string | null

Requestor ID provided for Visa after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.

Response

201 - application/json
amex_network_tokens_app_id
string | null

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

amex_network_tokens_requestor_id
string | null

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

created_at
string

The date and time when this merchant account was created.

display_name
string

The display name of this merchant account.

id
string

The ID for this merchant account.

mastercard_network_tokens_app_id
string | null

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

mastercard_network_tokens_requestor_id
string | null

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

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.

outbound_webhook_url
string | null

The optional URL where webhooks will be received.

outbound_webhook_username
string | null

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

type
enum<string>

merchant-account.

Available options:
merchant-account
updated_at
string

The date and time when this merchant account was updated.

visa_network_tokens_app_id
string | null

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

visa_network_tokens_requestor_id
string | null

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