Update merchant account
Update an existing merchant account. Optionally, provide an
outbound_webhook_url, and if HTTP Basic Authentication is required, provide
the outbound_webhook_username and outbound_webhook_password. When
retrieving a Merchant Account the outbound_webhook_password will be omitted.
Optionally provide Network Tokens configuration per scheme. If done, all parameters for the same scheme must be provided.
/merchant-accounts/{merchant_account_id}
curl --request PUT \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/merchant-accounts/{merchant_account_id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json'{
"amex_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"amex_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"created_at": "2022-02-01T14:20:00.000+00:00",
"display_name": "Plantly UK",
"id": "plantly-uk",
"mastercard_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"mastercard_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"outbound_webhook_password": "********",
"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": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"visa_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2"
}This endpoint requires the merchant-accounts.write scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique ID for a merchant account.
Body
Application ID provided for Amex after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.
Requestor ID provided for Amex after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.
The human-readable name of the merchant account.
Application ID provided for Mastercard after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.
Requestor ID provided for Mastercard after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.
The optional password to use when outbound_webhook_url is configured and
requires basic authentication.
The optional URL where webhooks will be received.
The optional username to use when outbound_webhook_url is configured and
requires basic authentication.
Application ID provided for Visa after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.
Requestor ID provided for Visa after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.
Response
Application ID provided for Amex after onboarding to use Network Tokens.
Requestor ID provided for Amex after onboarding to use Network Tokens.
The date and time when this merchant account was created.
The display name of this merchant account.
The ID for this merchant account.
Application ID provided for Mastercard after onboarding to use Network Tokens.
Requestor ID provided for Mastercard after onboarding to use Network Tokens.
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.
The optional URL where webhooks will be received.
The optional username to use when outbound_webhook_url is configured and
requires basic authentication.
merchant-account.
merchant-account The date and time when this merchant account was updated.
Application ID provided for Visa after onboarding to use Network Tokens.
Requestor ID provided for Visa after onboarding to use Network Tokens.
curl --request PUT \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/merchant-accounts/{merchant_account_id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json'{
"amex_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"amex_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"created_at": "2022-02-01T14:20:00.000+00:00",
"display_name": "Plantly UK",
"id": "plantly-uk",
"mastercard_network_tokens_app_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"mastercard_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"outbound_webhook_password": "********",
"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": "e50fa0da-903d-4d54-aacc-4cac57d48df2",
"visa_network_tokens_requestor_id": "e50fa0da-903d-4d54-aacc-4cac57d48df2"
}