Merchant editing service
After getting the token or signature in the previous step, the virtual store can consume the merchant editing service. For this, only the data to be altered must be sent.
Call details#
- Resource:
/v1/merchants/{id} - HTTP Method:
PUT - Request format:
JSON - Response format:
JSON - Header parameters:
| Parameter | Description | Format | Mandatory |
|---|---|---|---|
merchant_id | Merchant code on Carat Portal. The production and certification codes will be different. | < 15 AN | YES |
merchant_key | Merchant authentication key on Carat Portal. The production and certification keys will be different. | < 80 AN | YES |
token | Token obtained on the token creation service. Learn more. | = 66 AN | NO |
Content-Type | Must be sent with the value application/json. | = 15 AN | YES |
Authorization | The merchant's signature must be sent in the format Bearer {signature}. Exemple: Bearer JHVGytfdgauygdauiw78264284527852897hagdg. | < 2000 AN | NO |
Example using token#
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Example using signature#
To use this example, don't forget to define the variable {{url}} with the value
esitef-homologacao.softwareexpress.com.br
Response:
Request parameters#
The table below describes the parameters of the merchant creation service:
| Parameter | Description | Format | Mandatory |
|---|---|---|---|
{id} | Code of the merchant to be created. Sent in the URL. | < 15 AN | YES |
fantasy_name | Fantasy name of the merchant. | < 250 AN | NO |
corporate_name | Corporate name of the merchant. | < 250 AN | NO |
merchant_status | Merchant's current status. Can take the following values: A = Active I = Inactive | = 1 AN | NO |
domain | Domain (site) of the merchant. | < 65 AN | NO |
cnpj | CNPJ or CPF of the merchant. Numbers only. | < 14 N | NO |
address | Address of the merchant. | < 30 AN | NO |
city | City of the merchant. | < 13 AN | NO |
state | State of the merchant (abbreviation). | = 2 AN | NO |
zip_code | Zip code of the merchant. | < 9 AN | NO |
phone_number | Phone number of the merchant. | < 30 AN | NO |
email | E-mail address of the merchant. | < 100 AN | NO |
mcc | Merchant Category Code. | = 4 N | NO |
threeds_payment_link_authentication | Default authentication type that will be displayed when generating the payment link.
| = 1 N | NO |
automatic_threeds_minimum_value | Minimum value in cents for the 3DS to be automatically enabled. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used. | < 12 N | NO |
automatic_threeds_maximum_value | Maximum value in cents for the 3DS to be automatically enabled. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used. | < 12 N | NO |
automatic_antifraud_minimum_value | Minimum value in cents for the Anti-Fraud to be automatically enabled. It will only be possible to edit this value if Anti-Fraud is pre-configured. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used. | < 12 N | NO |
automatic_antifraud_maximum_value | Maximum value in cents for the Anti-Fraud to be automatically enabled. It will only be possible to edit this value if Anti-Fraud is pre-configured. Attention: intervals that allow the use of 3ds and anti-fraud together must not be used. | < 12 N | NO |
antifraud_over_threeds | Flag that turns on the functionality to activate the anti-fraud automatically in case of error or denied authentication using the 3DS Server integrated with Payment Online | < 5 AN | NO |
| soft_descriptor | Submerchant data. | ||
id | Submerchant ID | < 22 AN | NO |
country | Submerchant country. ISO 3166-1 numeric code. | = 3 N | NO |
fantasy_name | Submerchant fantasy name | < 22 AN | NO |
| subacquirer_group | Subacquirer group data. | ||
create | Flag indicating whether the subacquirer group should be created | < 5 T/F | NO |
id | Subacquirer group ID | < 6 AN | NO |
cnpj | Subacquirer group CNPJ | = 14 N | YES, if the field subacquirer_group.create is true |
| establishments | Data of the establishments to be created on SiTef. | ||
code | Establishment code (logical number) to be created on SiTef | = 11 N | NO |
routing_id | Acquirer/routing ID on Carat Portal | < 4 N | NO |
subacquirer_group_id | Subacquirer group ID. Should be sent in case the establishment must be created for the group instead of the merchant. | = 6 N | NO |
extra_data | Additional establishment information | < 32 AN | NO |
| transactional_urls | URLs used on transactional flows. | ||
status | URL for receiving status notifications. | < 500 AN | NO |
authenticity | URL for receiving authenticity POSTs. | < 500 AN | NO |
hash | URL for receiving stored card hash/token. | < 500 AN | NO |
| return_urls | HTML payment return URLs. | ||
success | Success return URL. | < 500 AN | NO |
failure | Failure return URL. | < 500 AN | NO |
cancel | Cancel return URL. | < 500 AN | NO |
| permissions | Transactional permissions to be attributed to the merchant. Send the value true to enable the desired functionality. | ||
payment | Payment permission. | < 5 AN | NO |
pre_authorization | Pre-authorization permission. | < 5 AN | NO |
recharge | Recharge permission. | < 5 AN | NO |
risk_analysis | Risk analysis permission. | < 5 AN | NO |
schedule | Schedule permission. | < 5 AN | NO |
iata | IATA permission. | < 5 AN | NO |
card_store | Card store permission. | < 5 AN | NO |
payment_link | Payment link permission. | < 5 AN | NO |
| authorizers[] | Authorizers to be registered to the merchant. | ||
id | Authorizer ID on Carat Portal. Learn more. | < 4 N | YES |
routing_id | Routing/acquirer ID on Carat Portal. Learn more. | < 4 N | YES |
status | Send A to activate or I to inactivate the authorizer. | < 1 AN | NO |
min_installments_amount | Minimum installment amount for HTML transactions. Default value: 1000 | < 12 N | NO |
max_installments_without_interest | Maximum installments without interest for HTML transactions. Default value: 3 | < 2 N | NO |
max_installments_with_interest | Maximum installments with interest for HTML transactions. Default value: 12 | < 2 N | NO |
enable_subacquirer_group | Enable subacquirer group usage for the authorizer. Send true to enable or false to disable. | < 5 T/F | NO |
acquirer_merchant_id | Merchant identifier designated by the acquirer. If threeds_enabled = true you must send at least one acquirer_merchant_id | < 35 AN | NO |
cvv_mandatory | Enable mandatory card security code field. Send true to enable or false to disable. | < 5 T/F | NO |
| authorizers[].parameters | Specific routing parameters. Learn more. |
Response parameters#
If successful, the HTTP response code will be 200. Any other code must be interpreted as an error. The table below describes the response parameters of the merchant editing service:
| Parameter | Description | Format |
|---|---|---|
response_code | Carat Portal response code. Any code different from 0 means failure. | < 4 N |
response_message | Carat Portal response message. | < 500 AN |
authorizer_response_code | Authorizer response code. | < 4 N |
authorizer_response_message | Authorizer response message. | < 500 AN |
id | Code of the created merchant. | < 15 AN |
key | Key of the created merchant. | < 80 AN |