Cartão de crédito

Propriedades do objeto de cartão de crédito `credit_card`:

O objeto credit_card pode conter as seguintes propriedades:

Atributos	Tipo	Descrição
`installments`	integer	Quantidade de parcelas. Valor padrão: `1`.
`statement_descriptor`	string	Texto exibido na fatura do cartão. Max: 13 caracteres para clientes PSP. Max: 22 caracteres para clientes gateway.
`operation_type`	string	Indica se a transação deve ser capturada `auth_and_capture`, autorizada `auth_only`, ou pré autorizada `pre_auth`. Valor padrão: `auth_and_capture`.
`card`, `card_id`, `card_token`, ou `network_token`	object	Cartão de crédito: (Somente uma opção) `card`: Informações referentes ao cartão do cliente. `card_id`: Identificador do cartão previamente cadastrado de um cliente. `card_token`: Token do cartão gerado pelo checkout transparente ou via tokenizaçãoJS. Saiba mais sobre cartões. `network_token`: Token referente a uma cartão gerado pelos serviços de tokenização das bandeiras.
`recurrence_cycle`	string	Informa se o pedido é a primeira ou subsequente transação de uma recorrência externa. Possíveis valores: `first` ou `subsequent`. (Importante: Não cria uma cobrança recorrente)
`metadata`	object	Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento.
`extended_limit_enabled`	boolean	Indica se o super limite está habilitado (para cartões private label).
`extended_limit_code`	string	Código do super limite (para cartões private label).
`merchant_category_code`	integer	Código de classificação do ramo de atuação do lojista.
`authentication`	object	Objeto que indica se a transação de cartão de crédito é autenticada ou não.
`auto_recovery`	boolean	Possibilita que a retentativa offline seja desabilitada por requisição.
`payload`	object	Objeto de dados criptografados, tais como: GooglePay.
`payment_type`	object	Objeto dos dados de pagamento, tais como: Token ou PAN
`funding_source`	string	Indica modelo de liquidação que será adotado a depender do cartão utilizado no processamento da transação. Valores possíveis: `credit` (Cartão de Crédito), `debit` (Cartão de Débito), e `prepaid` (Cartão Pré Pago)
`initiated_type`	string	Identificador do tipo de transação avulsa. Valores possíveis: `partial_shipment` (Remessa Parcial), `related_or_delayed_charge` (Cobrança Atrasada), `no_show` (Multa) ou `retry` (Retentativa).
`recurrence_model`	string	Identificador do tipo de recorrência. Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa).

Status da transação de cartão de crédito (transaction)

As transações de Cartão de Crédito podem possuir os seguintes status abaixos. Eles são representados dentro do objeto "charge.last_transaction.status"

Status	Descrição
`authorized_pending_capture`	Autorizada pendente de captura
`not_authorized`	Não autorizada
`captured`	Capturada
`partial_capture`	Capturada parcialmente
`waiting_capture`	Aguardando captura
`refunded`	Estornada
`voided`	Cancelada
`partial_refunded`	Estornada parcialmente
`partial_void`	Cancelada parcialmente
`error_on_voiding`	Erro no cancelamento
`error_on_refunding`	Erro no estorno
`waiting_cancellation`	Aguardando cancelamento
`with_error`	Com erro
`failed`	Falha

📘
Token de bandeira (network_token)
O Pagar.me suporta a utilização de network tokens gerados externamente por serviços de tokenização das bandeiras. Essa funcionalidade, conhecida como Pass Through, permite realizar transações utilizando esses tokens em substituição às informações originais do cartão.
Sendo assim, a API Pagar.me v5 aceita o objeto network_token como um substituto do objeto card
O fluxo transacional e as regras de negócio da API são idênticas a uma transação com cartão de crédito. Porém, pelas definições das bandeiras Mastercard e Visa, além dos dados de TOKEN é necessário enviar um novo criptograma gerado pela bandeira no campo cryptograms a cada transação realizada utilizando um network_token.
Essa funcionalidade está disponível apenas para clientes do modelo Gateway

🚧
Liberação de Pré-autorização
Para realizar transações de pré-autorização via Pagar.me é necessário entrar em contato com sua adquirente e solicitar a liberação da funcionalidade.

Transações Autenticadas:

Para os casos em que a transação é autenticada, o objeto authentication é obrigatório. Ele possui os seguintes campos:


`type`	string	Indica o tipo de autenticação utilizado. Atualmente o único tipo suportado é threed_secure
`threed_secure`	object	Indica os campos a serem enviados para a autenticação 3DS.

Por fim, o objeto threed_secure contém os seguintes campos:

Atributos	Tipo	Tamanho máximo	Descrição
`mpi`	string	11	Indica quem é o autenticador da transação. Pode receber os valores: "third_party" para autenticadores externos.
`eci`	string	2	Indica o resultado da tentativa de autenticação. Obrigatório quando o `mpi` é "third_party".
`cavv`	string	256	Código de autenticação do dono do cartão. Obrigatório quando o `mpi` é "third_party".
`transaction_id`	string	256	id da transação no autenticador. Obrigatório quando o `mpi` é "third_party".
`ds_transaction_id`	string	256	Identificador da transação no Directory Service
`version`	string	6	Versão do 3DS

🚧
Transações Autenticadas 3DS
Transações com autenticação estão disponível apenas para clientes gateway
Campos obrigatórios: mpi, eci, cavv e transaction_id são os necessários para uma transação com autenticação externa.

❗️
Atenção
Atualmente, são ofertadas duas versões para a autenticação de transações. A versão 1.0 do 3DS será descontinuada, e o Pagar.me está aceitando novas integrações nas versões 2.1.0 e 2.2.0, que apresentam melhor experiência para o portador e um maior número de dispositivos suportados.

Exemplos de Requisições:

{
    "items": [
        {
            "amount": 2990,
            "description": "Chaveiro do Tesseract",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]"
    },
    "payments": [
        {
            "payment_method": "credit_card",
            "credit_card": {
                "recurrence_cycle": "first",
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "card": {
                    "number": "4000000000000010",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 30,
                    "cvv": "3531",
                    "billing_address": {
                        "line_1": "10880, Malibu Point, Malibu Central",
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"                
                    }
                }
            }
        }
    ]
}

{
    "id": "or_DNobwn2CpGuvw0zp",
    "code": "GP8KUL0B2D",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_zd0pe0LRuEsBeQlg",
            "type": "product",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2023-03-03T19:49:14Z",
            "updated_at": "2023-03-03T19:49:14Z"
        }
    ],
    "customer": {
        "id": "cus_NOjl9o0iPFr8wdQp",
        "name": "Tony Stark",
        "email": "[email protected]",
        "delinquent": false,
        "created_at": "2023-03-03T19:38:58Z",
        "updated_at": "2023-03-03T19:38:58Z",
        "phones": {}
    },
    "status": "pending",
    "created_at": "2023-03-03T19:49:14Z",
    "updated_at": "2023-03-03T19:49:15Z",
    "closed_at": "2023-03-03T19:49:14Z",
    "charges": [
        {
            "id": "ch_p4lnAGyU0GT1E9MZ",
            "code": "GP8KUL0B2D",
            "amount": 2990,
            "status": "pending",
            "currency": "BRL",
            "payment_method": "credit_card",
            "funding_source": "prepaid",
            "created_at": "2023-03-03T19:49:14Z",
            "updated_at": "2023-03-03T19:49:15Z",
            "customer": {
                "id": "cus_NOjl9o0iPFr8wdQp",
                "name": "Tony Stark",
                "email": "[email protected]",
                "delinquent": false,
                "created_at": "2023-03-03T19:38:58Z",
                "updated_at": "2023-03-03T19:38:58Z",
                "phones": {}
            },
            "last_transaction": {
                "operation_key": "830608357",
                "id": "tran_ywqNVaxiorcpde8W",
                "transaction_type": "credit_card",
                "gateway_id": "e98d2459-7b0e-43c1-b5e6-adea2c751427",
                "amount": 2990,
                "status": "authorized_pending_capture",
                "success": true,
                "installments": 1,
                "funding_source": "prepaid",
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "simulator",
                "acquirer_tid": "806863466",
                "acquirer_nsu": "66184",
                "acquirer_auth_code": "890",
                "acquirer_message": "Transação autorizada com sucesso",
                "acquirer_return_code": "00",
                "operation_type": "auth_only",
                "card": {
                    "id": "card_D5p74jkH15SBYvYq",
                    "first_six_digits": "400000",
                    "last_four_digits": "0010",
                    "brand": "Visa",
                    "holder_name": "Homelander",
                    "exp_month": 12,
                    "exp_year": 2025,
                    "status": "active",
                    "type": "credit",
                    "created_at": "2023-03-03T19:49:14Z",
                    "updated_at": "2023-03-03T19:49:14Z",
                    "billing_address": {
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US",
                        "line_1": "10880, Malibu Point, Malibu Central"
                    }
                },
                "payment_type": "PAN",
                "created_at": "2023-03-03T19:49:15Z",
                "updated_at": "2023-03-03T19:49:15Z",
                "gateway_response": {
                    "code": "200",
                    "errors": []
                },
                "antifraud_response": {},
                "metadata": {}
            }
        }
    ],
    "checkouts": []
}

{
    "items": [
        {
            "amount": 2990,
            "description": "Chaveiro do Tesseract",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]"
    },
    "payments": [
        {
            "payment_method": "credit_card",
            "credit_card": {
                "card": {
                    "number": "4000000000000010",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 30,
                    "cvv": "3531",
                    "billing_address": {
                        "line_1": "10880, Malibu Point, Malibu Central",
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                },
                "authentication": {
                    "type": "threed_secure",
                    "threed_secure": {
                        "mpi": "third_party",
                        "eci": "05",
                        "cavv": "BwABBylVaQAAAAFwllVpAAAAAAA=",
                        "ds_transaction_id": "4165037e-2f84-443c-a4e2-0e3285eb911a",
                        "transaction_id": "9345dcf2-57bf-48ee-a495-663cf1fdb760",
                        "version": "2"
                    }
                }
            }
        }
    ]
}

{
    "items": [
        {
            "amount": 2990,
            "description": "Chaveiro do Tesseract",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]"
    },
    "payments": [
        {
            "payment_method": "credit_card",
            "credit_card": {
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "network_token": {
                    "number": "4190000000000010",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 30,
                    "cryptograms": [
                        "ANfQt43bddROAAEnSAMhAAADFA===="
                    ],
                    "billing_address": {
                        "line_1": "10880, Malibu Point, Malibu Central",
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                }
            }
        }
    ]
}

{
    "id": "or_GNmb7XquVcWdYJjA",
    "code": "R99AK2A1MR",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_nw6JPwTqDUawXro4",
            "type": "product",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2023-03-03T19:50:27Z",
            "updated_at": "2023-03-03T19:50:27Z"
        }
    ],
    "customer": {
        "id": "cus_NOjl9o0iPFr8wdQp",
        "name": "Tony Stark",
        "email": "[email protected]",
        "delinquent": false,
        "created_at": "2023-03-03T19:38:58Z",
        "updated_at": "2023-03-03T19:38:58Z",
        "phones": {}
    },
    "status": "paid",
    "created_at": "2023-03-03T19:50:27Z",
    "updated_at": "2023-03-03T19:50:28Z",
    "closed_at": "2023-03-03T19:50:27Z",
    "charges": [
        {
            "id": "ch_K6rxrpVHNt59037l",
            "code": "R99AK2A1MR",
            "amount": 2990,
            "paid_amount": 2990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "credit_card",
            "funding_source": "prepaid",
            "paid_at": "2023-03-03T19:50:28Z",
            "created_at": "2023-03-03T19:50:27Z",
            "updated_at": "2023-03-03T19:50:28Z",
            "customer": {
                "id": "cus_NOjl9o0iPFr8wdQp",
                "name": "Tony Stark",
                "email": "[email protected]",
                "delinquent": false,
                "created_at": "2023-03-03T19:38:58Z",
                "updated_at": "2023-03-03T19:38:58Z",
                "phones": {}
            },
            "last_transaction": {
                "operation_key": "394806072",
                "id": "tran_ygrZqYlf4tY5ALXp",
                "transaction_type": "credit_card",
                "gateway_id": "a89cea2b-4e0b-4f40-82a5-6dc08bcf5f19",
                "amount": 2990,
                "status": "captured",
                "success": true,
                "funding_source": "prepaid",
                "installments": 1,
                "installment_type": "merchant",
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "simulator",
                "acquirer_tid": "275763350",
                "acquirer_nsu": "70119",
                "acquirer_auth_code": "293",
                "acquirer_message": "Transação capturada com sucesso",
                "acquirer_return_code": "00",
                "entry_mode": "ecommerce",
                "operation_type": "auth_and_capture",
                "network_token": {
                    "id": "nt_AL0yDEQS22UODzGw",
                    "first_six_digits": "419000",
                    "last_four_digits": "0010",
                    "brand": "Visa",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 2030,
                    "created_at": "2023-03-03T19:38:58Z",
                    "updated_at": "2023-03-03T19:38:58Z",
                    "status": "active",
                    "billing_address": {
                        "street": "Malibu Point",
                        "number": "10880",
                        "zip_code": "90265",
                        "neighborhood": "Malibu Central",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                },
                "payment_type": "Token",
                "created_at": "2023-03-03T19:50:27Z",
                "updated_at": "2023-03-03T19:50:27Z",
                "gateway_response": {
                    "code": "200",
                    "errors": []
                },
                "antifraud_response": {},
                "metadata": {}
            }
        }
    ]
}

Cartão de crédito

Propriedades do objeto de cartão de crédito `credit_card`:

Status da transação de cartão de crédito (transaction)

📘
Token de bandeira (network_token)

🚧
Liberação de Pré-autorização

🚧
Transações Autenticadas 3DS

❗️
Atenção

Propriedades do objeto de cartão de crédito credit_card:

Status da transação de cartão de crédito (transaction)

📘Token de bandeira (network_token)

🚧Liberação de Pré-autorização

🚧Transações Autenticadas 3DS

❗️Atenção

Propriedades do objeto de cartão de crédito `credit_card`:

📘
Token de bandeira (network_token)

🚧
Liberação de Pré-autorização

🚧
Transações Autenticadas 3DS

❗️
Atenção