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.
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
The human-readable name of the merchant account.
The optional URL where webhooks will be received.
The optional username to use when outbound_webhook_url
is configured and
requires basic authentication.
The optional password to use when outbound_webhook_url
is configured and
requires basic authentication.
Requestor ID provided for Visa after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.
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 Amex after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.
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 Mastercard after onboarding to use Network Tokens. The requestor ID must be unique across all schemes and merchant accounts.
Application ID provided for Mastercard after onboarding to use Network Tokens. The application ID must be unique across all schemes and merchant accounts.
Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy.
- If the field is not set, the Account Updater service configuration is not updated.
- If the field is set to
null
, the Account Updater service is disabled. - If the field is set to
null
, the otherloon_*
fields must be set tonull
as well.
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 set, the Account Updater service configuration is not updated.
- If the field is set to
null
, the Account Updater service is disabled. - If the field is set to
null
, the otherloon_*
fields must be set tonull
as well.
Card schemes accepted when creating jobs using this set of Loon API keys. Loon is the Account Updater service used by Gr4vy.
- If the field is not set, the Account Updater service configuration is not updated.
- If the field is set to
null
, the Account Updater service is disabled. - If the field is set to
null
, the otherloon_*
fields must be set tonull
as well.
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
Response
merchant-account
.
merchant-account
The ID for this merchant account.
The display name of this merchant account.
The optional URL where webhooks will be received.
The optional username to use when outbound_webhook_url
is configured and
requires basic authentication.
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.
Application ID provided for Visa after onboarding to use Network Tokens.
Requestor ID provided for Amex after onboarding to use Network Tokens.
Application ID provided for Amex after onboarding to use Network Tokens.
Requestor ID provided for Mastercard after onboarding to use Network Tokens.
Application ID provided for Mastercard after onboarding to use Network Tokens.
Client key provided by Pagos to authenticate to the Loon API. Loon is the Account Updater service used by Gr4vy.
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
The date and time when this merchant account was created.
The date and time when this merchant account was updated.
Was this page helpful?