Cartão de crédito

Para criar um pedido com cartão de crédito, devemos incluir o objeto credit_card dentro do nó payment, assim como a propriedade "payment_method": "credit_card". O objeto credit_card contêm os seguintes atributos:

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

O objeto credit_card pode conter as seguintes propriedades:

AtributosTipoDescrição
installmentsintegerQuantidade de parcelas. Valor padrão: 1.
statement_descriptorstringTexto exibido na fatura do cartão. Max: 13 caracteres para clientes PSP. Max: 22 caracteres para clientes gateway.
operation_typestringIndica 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_tokenobjectCartã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_cyclestringInforma 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)
metadataobjectObjeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento.
extended_limit_enabledbooleanIndica se o super limite está habilitado (para cartões private label).
extended_limit_codestringCódigo do super limite (para cartões private label).
merchant_category_codeintegerCódigo de classificação do ramo de atuação do lojista.
authenticationobjectObjeto que indica se a transação de cartão de crédito é autenticada ou não.
auto_recoverybooleanPossibilita que a retentativa offline seja desabilitada por requisição.
payloadobjectObjeto de dados criptografados, tais como: GooglePay

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:

StatusDescrição
authorized_pending_captureAutorizada pendente de captura
not_authorizedNão autorizada
capturedCapturada
partial_captureCapturada parcialmente
waiting_captureAguardando captura
refundedEstornada
voidedCancelada
partial_refundedEstornada parcialmente
partial_voidCancelada parcialmente
error_on_voidingErro no cancelamento
error_on_refundingErro no estorno
waiting_cancellationAguardando cancelamento
with_errorCom erro
failedFalha

📘

Token de bandeira (network_token)

É possível realizar transações de cartão de credito utilizando token gerados externamente por serviços ligados a tokenização das bandeiras VISA, Master e ELO. Esse processo é chamado de Pass Through, quando um token gerado externamente é utilizado para transacionar via Pagar.me.

O network_token substitui a necessidade das informações originais do cartão de credito. 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 credito.

Pelas definições das bandeiras Master e Visa, é necessário enviar um novo criptograma gerado pela bandeira no campo cryptograms a cada transação realizada utilizando um network_token.

🚧

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:

typestringIndica o tipo de autenticação utilizado. Atualmente o único tipo suportado é threed_secure
threed_secureobjectIndica os campos a serem enviados para a autenticação 3DS.

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

AtributosTipoTamanho máximoDescrição
mpistring11Indica quem é o autenticador da transação. Pode receber os valores: "third_party" para autenticadores externos.
ecistring2Indica o resultado da tentativa de autenticação. Obrigatório quando o mpi é "third_party".
cavvstring256Código de autenticação do dono do cartão. Obrigatório quando o mpi é "third_party".
transaction_idstring256id da transação no autenticador. Obrigatório quando o mpi é "third_party".
ds_transaction_idstring256Identificador da transação no Directory Service
versionstring6Versão do 3DS
redirect_urlstring512Url de redirecionamento quando a transação é aprovada pelo autenticador. Obrigatório quando o mpié "acquirer".

🚧

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 é ofertado 2 versões para autenticação de transações. A versão 1.0 do 3DS será descontinuada e o Pagar.me está aceitando novas integrações apenas na versão 2.0 que apresenta melhor experiência para o portador e 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": false,
                "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_57oxkMntecE1P6JO",
    "code": "PGW5F69IX6",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_DZlmrdXfXQcmr5kO",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2019-01-21T18:37:48Z",
            "updated_at": "2019-01-21T18:37:48Z",
            "order": {
                "id": "or_57oxkMntecE1P6JO",
                "code": "PGW5F69IX6",
                "amount": 2990,
                "closed": true,
                "created_at": "2019-01-21T18:37:48Z",
                "updated_at": "2019-01-21T18:37:48Z",
                "closed_at": "2019-01-21T18:37:48Z",
                "currency": "BRL",
                "status": "paid",
                "customer_id": "cus_n3bqEzdsZUmNA7Qp",
                "items": [
                    {
                        "id": "oi_DZlmrdXfXQcmr5kO",
                        "description": "Chaveiro do Tesseract",
                        "amount": 2990,
                        "quantity": 1,
                        "status": "active"
                    }
                ]
            }
        }
    ],
    "customer": {
        "id": "cus_n3bqEzdsZUmNA7Qp",
        "name": "Tony Stark",
        "email": "[email protected]",
        "delinquent": false,
        "created_at": "2019-01-21T18:36:30Z",
        "updated_at": "2019-01-21T18:36:30Z",
        "phones": {}
    },
    "status": "paid",
    "created_at": "2019-01-21T18:37:48Z",
    "updated_at": "2019-01-21T18:37:48Z",
    "closed_at": "2019-01-21T18:37:48Z",
    "charges": [
        {
            "id": "ch_PNbX8jDIPuL1p5nM",
            "code": "PGW5F69IX6",
            "amount": 2990,
            "paid_amount": 2990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "credit_card",
            "paid_at": "2019-01-21T18:37:48Z",
            "created_at": "2019-01-21T18:37:48Z",
            "updated_at": "2019-01-21T18:37:48Z",
            "customer": {
                "id": "cus_n3bqEzdsZUmNA7Qp",
                "name": "Tony Stark",
                "email": "[email protected]",
                "delinquent": false,
                "created_at": "2019-01-21T18:36:30Z",
                "updated_at": "2019-01-21T18:36:30Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_G1byLaJUXHm5Eg4R",
                "transaction_type": "credit_card",
                "gateway_id": "82c0acb3-75b0-48b8-a3ac-0e51c4b3744c",
                "amount": 2990,
                "status": "captured",
                "success": true,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "acquirer_tid": "a4cf3de1-beb2-4724-822d-ac7ad14fa306",
                "acquirer_nsu": "a4cf3de1-beb2-4724-822d-ac7ad14fa306",
                "acquirer_auth_code": "903",
                "acquirer_message": "Transação capturada com sucesso",
                "acquirer_return_code": "00",
                "operation_type": "auth_and_capture",
                "card": {
                    "id": "card_apxQeXJsV2fGVwPL",
                    "first_six_digits": "400000",
                    "last_four_digits": "0010",
                    "brand": "Visa",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 2030,
                    "status": "active",
                    "type": "credit",
                    "created_at": "2019-01-21T18:37:48Z",
                    "updated_at": "2019-01-21T18:37:48Z",
                    "billing_address": {
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US",
                        "line_1": "10880, Malibu Point, Malibu Central"
                    }
                },
                "created_at": "2019-01-21T18:37:48Z",
                "updated_at": "2019-01-21T18:37:48Z",
                "gateway_response": {
                    "code": "200",
                    "errors": []
                }
            }
        }
    ],
    "checkouts": []
}
{
    "amount": 1000,
    "code": "123",
    "customer": {
        "name": "Tony Stark"
    },
    "currency": "BRL",
    "payment": {
        "payment_method": "credit_card",
        "operation_reference": "TESTEAPIDOCS",
        "credit_card": {
            "capture": false,
            "installments": 1,
            "statement_descriptor": "APIDOCS",
            "card": {
                "number": "4000000000000010",
                "holder_name": "Tony Stark",
                "exp_month": 11,
                "exp_year": 23,
                "cvv": "351"
            },
            "authentication": {
                "type": "threed_secure",
                "threed_secure": {
                    "mpi": "third_party",
                    "eci": "05",
                    "cavv": "BwABBylVaQAAAAFwllVpAAAAAAA=",
                    "ds_transaction_id": "Nmp3VFdWMlEwZ05pWGN3SGo4TDA=",
                    "version": "2"
                }
            }
        },
        "metadata": {
            "mundipagg_payment_method_code": "19"
        }
    }
}
{
    "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": "4000000000000010",
                    "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"                
                    }
                }
            }
        }
    ]
}