Servicio de edición de la tienda

Después de obtener el token o la firma en el paso anterior, la tienda online puede consumir el servicio de edición de la tienda. Para eso, solo se deben enviar los datos a modificar.

Detalles de la llamada#

  • Recurso: /v1/merchants/{id}
  • Método HTTP: PUT
  • Formato de solicitud: JSON
  • Formato de respuesta: JSON
  • Parámetros de encabezado: | Parámetro | Descripción | Formato | Obligatorio | | :-------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------: | :---------: | | merchant_id | Código de tienda en Portal Carat. Los códigos de producción y certificación serán diferentes. | < 15 AN | SI | | `merchant_key | Clave de autenticación para la tienda de pagos online. Las claves de producción y certificación serán diferentes. | < 80 AN | SI | | token | Token obtenido del servicio de creación de tokens. [Más información.] (Registration-tiendas-ws-token.md) | = 66 AN | NO | | Content-Type | Debe enviarse con el valor application / json. | = 15 AN | SI | | Autorización | La firma de autenticación de la tienda debe enviarse en el formato ´Bearer{firma}". Ejemplo: Bearer JHVGytfdgauygdauiw78264284527852897hagdg. | < 2000 AN | NO |

Ejemplo de uso de token#

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/merchants/qereIoinsd3d"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "token: 1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr"
--data-binary
{
"fantasy_name":"Teste de Loja",
"corporate_name":"Testes de Loja Ltda.",
"merchant_status":"A",
"subacquirer_group":{
"create":"true",
"id":"123456",
"cnpj":"12345678901234"
},
"domain":"www.testeloja.com",
"cnpj":"123123123123",
"address":"Rua do Teste, 123",
"city":"São Teste",
"state":"SP",
"zip_code":"12345678",
"phone_number":"11912341234",
"email":"testeloja@teste.com",
"mcc":"1234",
"threeds_payment_link_authentication": "1",
"automatic_threeds_minimum_value" : "9999999",
"automatic_threeds_maximum_value" : "100000",
"automatic_antifraud_minimum_value" : "0",
"automatic_antifraud_maximum_value" : "99999",
"antifraud_over_threeds" : "false",
"transactional_urls":{
"status":"https://www.testeloja.com/status",
"authenticity":"https://www.testeloja.com/autent",
"hash":"https://www.testeloja.com/hash"
},
"return_urls":{
"success":"https://www.testeloja.com/sucesso",
"failure":"https://www.testeloja.com/fracasso",
"cancel":"https://www.testeloja.com/cancel"
},
"permissions":{
"payment":"true",
"pre_authorization":"false",
"recharge":"false",
"risk_analysis":"true",
"schedule":"true",
"iata":"false",
"card_store":"false",
"payment_link":"true"
},
"establishments":[
{
"code":"00000000123",
"routing_id":"1125",
"subacquirer_group_id":"123456"
},
{
"code":"00000000321",
"routing_id":"1005"
}
],
"authorizers":[
{
"id":"1",
"routing_id":"1125",
"min_installments_amount":"100",
"max_installments_without_interest":"1",
"max_installments_with_interest":"12",
"enable_subacquirer_group":"true",
"acquirer_merchant_id": "12345",
"cvv_mandatory":"true"
},
{
"id":"2",
"routing_id":"1005",
"min_installments_amount":"100",
"max_installments_without_interest":"1",
"max_installments_with_interest":"12",
"enable_subacquirer_group":"false",
"acquirer_merchant_id": "11111"
}
]
}
--verbose

Ejemplo usando suscripción#

curl
--request PUT "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/merchants/qereIoinsd3d"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--header "Authorization: Bearer YYYYYYY"
--data-binary
{
"fantasy_name":"Prueba de tienda",
"corporate_name":"Pruebas de tienda Ltda.",
"merchant_status":"A",
"subacquirer_group":{
"create":"true",
"id":"123456",
"cnpj":"12345678901234"
},
"domain":"www.testeloja.com",
"cnpj":"123123123123",
"address":"Rua Teste, 123",
"city":"São Teste",
"state":"SP",
"zip_code":"12345678",
"phone_number":"11912341234",
"email":"testeloja@teste.com",
"mcc":"1234",
"threeds_payment_link_authentication": "1",
"automatic_threeds_minimum_value" : "9999999",
"automatic_threeds_maximum_value" : "100000",
"automatic_antifraud_minimum_value" : "0",
"automatic_antifraud_maximum_value" : "99999",
"antifraud_over_threeds" : "false",
"transactional_urls":{
"status":"https://www.testeloja.com/status",
"authenticity":"https://www.testeloja.com/autent",
"hash":"https://www.testeloja.com/hash"
},
"return_urls":{
"success":"https://www.testeloja.com/sucesso",
"failure":"https://www.testeloja.com/fracasso",
"cancel":"https://www.testeloja.com/cancel"
},
"permissions":{
"payment":"true",
"pre_authorization":"false",
"recharge":"false",
"risk_analysis":"true",
"schedule":"true",
"iata":"false",
"card_store":"false",
"payment_link":"true"
},
"establishments":[
{
"code":"00000000123",
"routing_id":"1125",
"subacquirer_group_id":"123456"
},
{
"code":"00000000321",
"routing_id":"1005"
}
],
"authorizers":[
{
"id":"1",
"routing_id":"1125",
"min_installments_amount":"100",
"max_installments_without_interest":"1",
"max_installments_with_interest":"12",
"enable_subacquirer_group":"true",
"acquirer_merchant_id": "12345",
"cvv_mandatory":"true"
},
{
"id":"2",
"routing_id":"1005",
"min_installments_amount":"100",
"max_installments_without_interest":"1",
"max_installments_with_interest":"12",
"enable_subacquirer_group":"false",
"acquirer_merchant_id": "11111"
}
]
}
--verbose

Respuesta:

{
"id": "qereIoinsd3d",
"key": "9B71234TB12D938T9384TDB294T923D412T938D1293D4B923D",
"response_code": "0",
"response_message": "OK",
"authorizer_response_code": "0",
"authorizer_response_message": "OK"
}

parámetros de solicitud#

En la siguiente tabla se muestra la descripción de los parámetros de solicitud de servicio de edición de la tienda: | Parámetro | Descripción | Formato | Obligatorio | | :---------------------------------: | :------------------------------------------------------------------------------------------------------------------------------- | :-------------: | :------------------------------------------------------: | | {id} | Código de la tienda que se va a editar. Presente en la propia URL. | < 15 AN | SI | | fantasy_name | Nombre comercial de la tienda. | < 250 AN | NO | | corporate_name | Razón Social de la tienda. | < 250 AN | NO | | merchant_status | Estado de la tienda. Puede tomar los siguientes valores: A = Activo I = Inactivo | = 1 AN | NO | | domain | Dominio (sitio web) de la tienda. | < 500 AN | NO | | cnpj | CNPJ o CPF de la tienda. Sólo números. | < 14 N | NO | | address | Dirección de la tienda. | < 200 AN | NO | | city | Ciudad de la tienda. | < 50 AN | NO | | state | Estado de la tienda (sigla). | = 2 AN | NO | | zip_code | Código postal de la tienda. | < 9 AN | NO | | phone_number | Teléfono de la tienda. | < 30 AN | NO | | email | Dirección de correo electrónico de la tienda. | < 100 AN | NO | | mcc | Merchant Category Code.. | = 4 N | NO | | threeds_payment_link_authentication |Tipo de autenticación predeterminado que se mostrará al generar el link de pago. [Más información.] (Portal-shopkeeper-payment-geracao-link.md)

  • 0 = Sin autenticación
  • 1 = Habilita el uso de 3DS. Pero, si el servidor 3DS no admite la marca de la tarjeta o no se autentica, se denegará el pago.
  • 2 = Habilite el uso de 3DS. Sin embargo, si el server 3DS no admite la marca de la tarjeta, no se autentica con el server 3DS. Si la marca de la tarjeta es compatible y se niega la autenticación, se denegará el pago
  • 3 = Habilitar el uso de 3DS. Sin embargo, incluso si la autenticación falla, el pago no se denegará tras la autenticación.
| = 1 N | NO | | automatic_threeds_minimum_value | Valor mínimo en centavos para que el 3DS se habilite automáticamente. Atención: no se deben utilizar intervalos que permitan el uso conjunto de 3ds y antifraude. < 12 N | NO | | automatic_threeds_maximum_value | Valor máximo en centavos para que el 3DS se habilite automáticamente. Atención: no se deben utilizar intervalos que permitan el uso de 3ds y antifraude juntos. | < 12 N | NO | | automatic_antifraud_minimum_value |Cantidad mínima en centavos para habilitar automáticamente Antifraude. Solo será posible editar este valor si Antifraude está preconfigurado. Atención: no se deben utilizar intervalos que permitan el uso conjunto de 3ds y antifraude. < 12 N | NO | | automatic_antifraud_maximum_value | Valor máximo en centavos para habilitar automáticamente Antifraude. Solo será posible editar este valor si Antifraude está preconfigurado. Atención: no se deben utilizar intervalos que permitan el uso conjunto de 3ds y antifraude. < 12 N | NO | | antifraud_over_threeds | Marca de la tarjeta que enciende la funcionalidad para activar el antifraude automáticamente en caso de error o denegación de autenticación utilizando el server 3DS integrado con Portal Carat | < 5 AN | NO | | subacquirer_group | Subadquisición de datos de grupo. | | create |Flag que indica si se debe crear el grupo de subcompra | < 5 T / F | NO | | id | ID de grupo de sub-adquisición | < 6 AN | NO | | cnpj | CNPJ del subgrupo adquirente | = 14 N | SÍ, si el campo subacquirer_group.create es true | | establishments | Datos de establecimientos a dar de alta en SiTef. | | code | Código de establecimiento (número lógico) que debe registrarse en SiTef | < 32 AN | NO | | routing_id | ID de ruta (tipo de pago de Portal Carat) | < 4 N | NO | | subacquirer_group_id | ID de grupo de sub-adquisición. Debe enviarse si este establecimiento se va a registrar para el grupo en lugar de la empresa. | < 6 AN | NO | | extra_date | Información adicional de la propiedad | < 32 AN | NO | | transaccional_urls | URL utilizadas en flujos transaccionales. | | status | URL para recibir avisos de estado. | < 500 AN | NO | | authenticity | URL para recibir POSTs de autenticidad. | < 500 AN | NO | | hash | URL para recibir el hash / token de la tarjeta almacenada. | < 500 AN | NO | | return_urls | URL de amortización HTML. | | éxito | URL de retorno exitosa. | < 500 AN | NO | | failure | URL de retorno de Falla. | < 500 AN | NO | | cancel |Cancelar la URL de retorno. | < 500 AN | NO | | permissions | Permisos transaccionales que se asignarán a la tienda. Envíe el valor "verdadero" para habilitar la funcionalidad en cuestión. | | payment| Permiso de pago. | <u> <</u> 5 AN | NO | |pre_authorization| Permiso de preautorización. | <u> <</u> 5 AN | NO | |recharge| Permiso para recargar. | <u> <</u> 5 AN | NO | |risk_analysis| Permiso para análisis de riesgos. | <u> <</u> 5 AN | NO | |schedule| Permiso para programar. | <u> <</u> 5 AN | NO | |iata| Permiso para IATA. | <u> <</u> 5 AN | NO | |card_store| Permiso para el almacenamiento de tarjetas. | <u> <</u> 5 AN | NO | |payment_link| Permiso de pago mediante enlace. | <u> <</u> 5 AN | NO | | ** authorizers[] ** | Autorizadores para registrarse en la tienda. | |id| ID del autorizador en el Portal Carat. [Más información.] (autorizadores.md#códigos-de-autorizadores-no-e-sitef) | <u> <</u> 4 N | SI | |routing_id| Identificación de enrutamiento / adquirente en el Portal Carat. [Más información.] (# Códigos-de-enrutamiento-adquiriente) | <u> <</u> 4 N | SI | |status| Envíe "A" para activar o "I" para desactivar el autorizador. | <u> <</u> 1 AN | NO | |min_installments_amount| Importe mínimo para cuotas en transacciones HTML. Valor predeterminado:1000| <u> <</u> 12 N | NO | |max_installments_without_interest| Número máximo de cuotas sin intereses en transacciones HTML. Valor predeterminado:3| <u> <</u> 2 N | NO | |max_installments_with_interest| Número máximo de cuotas que devengan intereses en transacciones HTML. Valor predeterminado:12| <u> <</u> 2 N | NO | |enable_subacquirer_group| Habilitar la bandera para el uso del grupo de sub-adquisición. Envíe "verdadero" para habilitarlo o "falso" para deshabilitarlo. | <u> <</u> 5 T / F | NO | |purchaser_merchant_id| Identificador de tienda designado por el adquirente. Sithreeds_enabled = true, debe enviar al menos un adquisr_merchant_id| <u> <</u> 35 AN | NO | |cvv_mandatory| Habilite el campo de código de seguridad obligatorio de la tarjeta. Envíetruepara habilitar ofalso` para deshabilitar. | < 5 T / F | NO | | autorizadores []. parámetros | Parámetros específicos de enrutamiento. [Más información.] (# Parámetros-específicos-de-enrutamiento) |

Parámetros de respuesta#

Si tiene éxito, el código de respuesta HTTP será "200". Cualquier otro código debe interpretarse como un error. En la siguiente tabla se muestra la descripción de los parámetros de respuesta del servicio de edición de tienda:

ParámetroDescripciónFormato
response_codeCódigo de respuesta de Portal Carat. Cualquier código que no sea "0" significa error.< 4 N
response_messageMensaje de respuesta de Portal Carat.< 500 AN
authorizer_response_codeAuthorizer response code.< 4 N
authorizer_response_messageAuthorizer response message.< 500 AN
idCódigo da la tienda cambiada.< 15 AN
keyClave de la tienda cambiada.< 80 AN