Docs
post https://gateway.iugu.com/api/v1/transactions/zero_auth

Realizar autorização zero

Realiza uma autorização zero para validar um cartão de crédito. Atualmente apenas via Cielo.

  • Um cartão inválido não é um erro HTTP: a resposta é 200 com Valid: false.
  • O resultado é armazenado por cartão; consultas seguintes do mesmo cartão retornam o resultado armazenado, sem nova chamada ao adquirente.

Sem ações implementadas definidas

Request

Headers

Workspace-Id

Type: string

ID do workspace. Quando ausente, é usado o workspace padrão do Gateway.

Ex: 1D81KhKbYuVq9505Bz4Nk9

Body Required

Content Type: application/json

credit_card_id

Required

String

ID do cartão de crédito tokenizado no Gateway

mcc

Required

String

Merchant Category Code

cnpj

Required

String = 14 characters

CNPJ do estabelecimento (aceita CNPJ alfanumérico; convertido para maiúsculas)

account_id

Required

String

Identificador da conta

Example
1
2
3
4
5
6
{
  "credit_card_id": "<CREDIT_CARD_ID>",
  "mcc": "<MCC>",
  "cnpj": "<CNPJ>",
  "account_id": "<ACCOUNT_ID>"
}

Response

200

Autorização zero realizada (cartão válido ou inválido)

Valid
Boolean

Indica se o cartão é válido

ReturnCode
String

Código de retorno do adquirente

ReturnMessage
String

Mensagem de retorno do adquirente

IssuerTransactionId
String

ID da transação no emissor

WorkspaceId
String

Example
1
2
3
4
5
6
7
{
  "Valid": true,
  "ReturnCode": "00",
  "ReturnMessage": "Transacao autorizada",
  "IssuerTransactionId": "580027442382078",
  "WorkspaceId": "1D81KhKbYuVq9505Bz4Nk9"
}

400

Parâmetro obrigatório ausente, com tipo/formato inválido ou não documentado

error
String
Enum: `invalid_parameter_error`

error_code
String

`invalid_`

Ex: invalid_sub_merchant_postal_code

details
Object

message
String

Ex: sub_merchant.postal_code format is invalid

Example
1
2
3
4
5
6
7
{
  "error": "<ERROR>",
  "error_code": "invalid_sub_merchant_postal_code",
  "details": {
    "message": "sub_merchant.postal_code format is invalid"
  }
}

401

Não autorizado - Token de autenticação inválido ou ausente

message
String
Enum: `Requires authentication`, `Bad credentials`

Example
1
2
3
{
  "message": "<MESSAGE>"
}

404

`credit_card_not_found`: Cartão de crédito não encontrado

error
String

Tipo do erro

Ex: payment_not_found

service
String

Nome do serviço que gerou o erro

Ex: Acquirers::CancelService

details
Object

Detalhes adicionais (estrutura varia por tipo de erro)

Example
1
2
3
4
5
6
{
  "error": "payment_not_found",
  "service": "Acquirers::CancelService",
  "details": {
  }
}

500

Erro interno. Inclui falhas de roteamento (ex.: `no_ec_group_found`, `no_active_ecs_available`) e rejeições do adquirente (`bad_request`).

error
String

Tipo do erro

Ex: payment_not_found

service
String

Nome do serviço que gerou o erro

Ex: Acquirers::CancelService

details
Object

Detalhes adicionais (estrutura varia por tipo de erro)

Example
1
2
3
4
5
6
{
  "error": "payment_not_found",
  "service": "Acquirers::CancelService",
  "details": {
  }
}