API Reference
GuidesSuporteAPI Reference

Cartão de débito

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

AtributosTipoDescrição
statement_descriptorstringTexto exibido na fatura do cartão. Max: 22 caracteres.
card, card_id, card_tokenounetwork_token`objectCartão de débito.
card: Informações referentes ao cartão do cliente.
card_id é o identificador do cartão de um cliente.
card_token é o token do cartão gerado pelo checkout transparente. Saiba mais sobre cartões.
network_token: Token referente a uma cartão gerado pelos serviços de tokenização das bandeiras.
recurrencebooleanIndica se é uma cobrança/pedido de recorrência.
Valor padrão: false
metadataobjectObjeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento.
merchant_category_codeintegerCódigo de classificação do ramo de atuação do lojista.
authenticationobjectObjeto que indica se a transação de débito é autenticada ou não.
payloadobjectObjeto de dados criptografados, tais como: GooglePay
initiated_typestringIdentificador 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_modelstringIdentificador do tipo de recorrência.
Valores possíveis: standing_order (Ordem Permanente), instalment (Parcelamento) ou subscription (Assinatura convencional com valor e frequência fixa).

🚧

Funcionalidade disponível apenas para clientes Gateway

As funcionalidades apresentadas abaixo estão disponível apenas para clientes gateway

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 o valor "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 3D-S
success_urlstring512Url de redirecionamento quando a transação é aprovada pelo autenticador.

📘

Autenticação 3DS

Os campos 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.

{
    "amount": 1000,
    "code": "123",
    "customer": {
        "name": "Tony Stark"
    },
    "currency": "BRL",
    "payment": {
        "payment_method": "debit_card",
        "operation_reference": "TESTEAPIDOCS",
        "debit_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": "Teste de débito",
            "quantity": 1,
            "code": "123"
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "type": "individual",
        "document_type": "CPF",
        "address": {
            "line_1": "375, Av. General Justo, Centro",
            "line_2": "8º andar",
            "zip_code": "20021130",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR"
        }
    },
    "payments": [
        {
            "payment_method": "debit_card",
            "debit_card": {
                "capture": false,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "network_token": {
                    "number": "5256621004565548",
                    "holder_name": "Tony Stark",
                    "exp_month": 12,
                    "exp_year": 2023,
                    "cryptograms": [
                        "ANfQt43bddROAAEnSAMhAAADFA===="
                    ],
                    "billing_address": {
                        "street": "Malibu Point",
                        "number": "10880",
                        "zip_code": "90265",
                        "neighborhood": "Central Malibu",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                }
            },
        }
    ]
}

{
    "id": "or_nEA3rVEC7TqOVWM2",
    "code": "W2NQAEJF3J",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_2jdEG82C8Cz5wLy4",
            "type": "product",
            "description": "Teste de débito",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2023-04-14T18:13:25Z",
            "updated_at": "2023-04-14T18:13:25Z",
            "code": "123"
        }
    ],
    "customer": {
        "id": "cus_4qN8MKbCxt8aDovj",
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "document_type": "cpf",
        "type": "individual",
        "delinquent": false,
        "address": {
            "id": "addr_bve7jDhwvsm5orDk",
            "line_1": "375, Av. General Justo, Centro",
            "line_2": "8º andar",
            "zip_code": "20021130",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR",
            "status": "active",
            "created_at": "2023-04-14T18:13:16Z",
            "updated_at": "2023-04-14T18:13:16Z"
        },
        "created_at": "2023-04-14T18:13:16Z",
        "updated_at": "2023-04-14T18:13:16Z",
        "phones": {}
    },
    "status": "paid",
    "created_at": "2023-04-14T18:13:25Z",
    "updated_at": "2023-04-14T18:13:28Z",
    "closed_at": "2023-04-14T18:13:25Z",
    "charges": [
        {
            "id": "ch_K83x0jXHMLumQalm",
            "code": "W2NQAEJF3J",
            "gateway_id": "f942829d-4a63-47b2-9af1-bef65ced0a5a",
            "amount": 2990,
            "paid_amount": 2990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "debit_card",
            "paid_at": "2023-04-14T18:13:27Z",
            "created_at": "2023-04-14T18:13:25Z",
            "updated_at": "2023-04-14T18:13:27Z",
            "customer": {
                "id": "cus_4qN8MKbCxt8aDovj",
                "name": "Tony Stark",
                "email": "[email protected]",
                "document": "93095135270",
                "document_type": "cpf",
                "type": "individual",
                "delinquent": false,
                "address": {
                    "id": "addr_bve7jDhwvsm5orDk",
                    "line_1": "375, Av. General Justo, Centro",
                    "line_2": "8º andar",
                    "zip_code": "20021130",
                    "city": "Rio de Janeiro",
                    "state": "RJ",
                    "country": "BR",
                    "status": "active",
                    "created_at": "2023-04-14T18:13:16Z",
                    "updated_at": "2023-04-14T18:13:16Z"
                },
                "created_at": "2023-04-14T18:13:16Z",
                "updated_at": "2023-04-14T18:13:16Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_BaQ7M70FRiQbVZew",
                "transaction_type": "debit_card",
                "gateway_id": "db376787-7071-49d4-9ab0-a3a5d4d176f2",
                "amount": 2990,
                "status": "captured",
                "success": true,
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "stone",
                "acquirer_affiliation_code": "266B24CD5F429E56134743A01287BACB",
                "acquirer_tid": "20430073908801",
                "acquirer_nsu": "20430073908801",
                "acquirer_auth_code": "908801",
                "acquirer_message": "Stone|Aprovado",
                "acquirer_return_code": "0000",
                "operation_type": "capture",
                "network_token": {
                    "id": "nt_doLl3pGmUrIo5Pgn",
                    "first_six_digits": "525662",
                    "last_four_digits": "5548",
                    "brand": "Mastercard",
                    "holder_name": "Tony Stark",
                    "exp_month": 12,
                    "exp_year": 2023,
                    "created_at": "2023-04-14T18:13:16Z",
                    "updated_at": "2023-04-14T18:13:16Z",
                    "status": "active",
                    "billing_address": {
                        "street": "Malibu Point",
                        "number": "10880",
                        "zip_code": "90265",
                        "neighborhood": "Central Malibu",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                },
                "payment_type": "Token",
                "created_at": "2023-04-14T18:13:25Z",
                "updated_at": "2023-04-14T18:13:25Z",
                "gateway_response": {
                    "code": "201",
                    "errors": []
                },
                "antifraud_response": {},
                "metadata": {}
            },
        }
    ]
}

{
    "items": [
        {
            "amount": 2990,
            "description": "Teste de débito",
            "quantity": 1,
            "code": "123"
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "type": "individual",
        "document_type": "CPF",
        "address": {
            "line_1": "375, Av. General Justo, Centro",
            "line_2": "8º andar",
            "zip_code": "20021130",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR"
        }
    },
    "payments": [
        {
            "payment_method": "debit_card",
            "debit_card": {
                "capture": false,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "network_token": {
                    "number": "5256621004565548",
                    "holder_name": "Tony Stark",
                    "exp_month": 12,
                    "exp_year": 2023,
                    "cryptograms": [
                        "ANfQt43bddROAAEnSAMhAAADFA===="
                    ],
                    "billing_address": {
                        "street": "Malibu Point",
                        "number": "10880",
                        "zip_code": "90265",
                        "neighborhood": "Central Malibu",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                },
                "authentication": {
                    "type": "threed_secure",
                    "threed_secure": {
                        "mpi": "acquirer",
                        "success_url": "http://www.pagar.me"
                    }
                }
            },
        }
    ]
}

{
    "id": "or_yJPVBm7szliRwx97",
    "code": "MKJDF40UO8",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_a9g8lb5t6cQKXWpe",
            "type": "product",
            "description": "Teste de débito",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2023-04-14T18:25:38Z",
            "updated_at": "2023-04-14T18:25:38Z",
            "code": "123"
        }
    ],
    "customer": {
        "id": "cus_4qN8MKbCxt8aDovj",
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "document_type": "cpf",
        "type": "individual",
        "delinquent": false,
        "address": {
            "id": "addr_bve7jDhwvsm5orDk",
            "line_1": "375, Av. General Justo, Centro",
            "line_2": "8º andar",
            "zip_code": "20021130",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR",
            "status": "active",
            "created_at": "2023-04-14T18:13:16Z",
            "updated_at": "2023-04-14T18:13:16Z"
        },
        "created_at": "2023-04-14T18:13:16Z",
        "updated_at": "2023-04-14T18:13:16Z",
        "phones": {}
    },
    "status": "paid",
    "created_at": "2023-04-14T18:25:38Z",
    "updated_at": "2023-04-14T18:25:42Z",
    "closed_at": "2023-04-14T18:25:38Z",
    "charges": [
        {
            "id": "ch_aRLoYxLHefrMOkAG",
            "code": "MKJDF40UO8",
            "gateway_id": "824a2f78-0548-4655-9131-8b4065066d77",
            "amount": 2990,
            "paid_amount": 2990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "debit_card",
            "paid_at": "2023-04-14T18:25:42Z",
            "created_at": "2023-04-14T18:25:39Z",
            "updated_at": "2023-04-14T18:25:42Z",
            "customer": {
                "id": "cus_4qN8MKbCxt8aDovj",
                "name": "Tony Stark",
                "email": "[email protected]",
                "document": "93095135270",
                "document_type": "cpf",
                "type": "individual",
                "delinquent": false,
                "address": {
                    "id": "addr_bve7jDhwvsm5orDk",
                    "line_1": "375, Av. General Justo, Centro",
                    "line_2": "8º andar",
                    "zip_code": "20021130",
                    "city": "Rio de Janeiro",
                    "state": "RJ",
                    "country": "BR",
                    "status": "active",
                    "created_at": "2023-04-14T18:13:16Z",
                    "updated_at": "2023-04-14T18:13:16Z"
                },
                "created_at": "2023-04-14T18:13:16Z",
                "updated_at": "2023-04-14T18:13:16Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_jRpOmqgckHn6NBEb",
                "transaction_type": "debit_card",
                "gateway_id": "5c7d44af-f695-4046-8264-fa7a238b3bae",
                "amount": 2990,
                "status": "captured",
                "success": true,
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "stone",
                "acquirer_affiliation_code": "266B24CD5F429E56134743A01287BACB",
                "acquirer_tid": "20430073908837",
                "acquirer_nsu": "20430073908837",
                "acquirer_auth_code": "908837",
                "acquirer_message": "Stone|Aprovado",
                "acquirer_return_code": "0000",
                "operation_type": "capture",
                "mpi": "acquirer",
                "network_token": {
                    "id": "nt_doLl3pGmUrIo5Pgn",
                    "first_six_digits": "525662",
                    "last_four_digits": "5548",
                    "brand": "Mastercard",
                    "holder_name": "Tony Stark",
                    "exp_month": 12,
                    "exp_year": 2023,
                    "created_at": "2023-04-14T18:13:16Z",
                    "updated_at": "2023-04-14T18:13:16Z",
                    "status": "active",
                    "billing_address": {
                        "street": "Malibu Point",
                        "number": "10880",
                        "zip_code": "90265",
                        "neighborhood": "Central Malibu",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                },
                "payment_type": "Token",
                "created_at": "2023-04-14T18:25:39Z",
                "updated_at": "2023-04-14T18:25:39Z",
                "gateway_response": {
                    "code": "201",
                    "errors": []
                },
                "antifraud_response": {},
                "metadata": {}
            },
            }
        }
    ]
}

Status das transações de Cartão de Débito (Transaction)

As transações de Cartão de Débito podem possuir os seguintes status:

StatusDescrição
not_authorizedNão autorizada
pendingPendente
capturedCapturada
refundedEstornada
error_on_refundingErro no estorno
with_errorCom erro
failedFalha