--- agentTools: projectIndex: https://docs.mundipagg.com/llms.txt --- # Checkout Para criar um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **checkout**, devemos incluir o objeto `checkout` dentro do nó `payment`, assim como a propriedade `"payment_method": "checkout"`. O objeto `checkout` contêm as seguintes propriedades: [block:parameters] { "data": { "h-0": "Atributos", "h-1": "Tipo", "h-2": "Descrição", "0-0": "`accepted_payment_method`", "0-1": "**array of string**", "0-2": "_Meios de pagamento aceitos para o checkout_. Valores possíveis: `credit_card`, `debit_card`, `boleto`, `voucher` e `bank_transfer`, `pix`.", "2-0": "`default_payment_method`", "2-1": "**string**", "2-2": "_Meio de pagamento padrão_.", "3-0": "`success_url`", "3-1": "**string**", "3-2": "_URL para redirecionamento de sucesso_.", "5-0": "`credit_card`", "5-1": "**object**", "5-2": "_Configurações para pagamento com cartão de crédito_.", "7-0": "`credit_card.statement_descriptor`", "7-1": "**string**", "7-2": "_Texto da fatura do cartão_.", "8-0": "`credit_card.installments`", "8-1": "**array of objects**", "8-2": "_Array de configurações de parcelas_.", "9-0": "`credit_card.installments.number`", "9-2": "_Quantidade de parcelas_.", "9-1": "**number**", "10-0": "`credit_card.installments.total`", "10-1": "**number**", "10-2": "_Valor total referente à quantidade de parcelas_.", "11-0": "`boleto`", "11-1": "**object**", "11-2": "_Configurações para pagamento com boleto_.", "12-0": "`boleto.due_at`", "12-1": "**string**", "12-2": "_Data de vencimento do boleto_.", "13-0": "`boleto.instructions`", "13-1": "**string**", "13-2": "_Instruções do boleto_.", "16-0": "`metadata`", "16-1": "**object**", "16-2": "_Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento_.[Saiba mais sobre metadata](https://docs.mundipagg.com/v1/reference#metadata).", "14-0": "`skip_checkout_success_page`", "14-1": "**boolean**", "14-2": "_Permite pular a tela de redirecionamento pós pagamento_.", "15-0": "`customer_editable`", "15-1": "**boolean**", "15-2": "_Torna o objeto do cliente editável_.", "6-0": "`credit_card.capture`", "6-1": "**boolean**", "6-2": "_Indica se a transação deve ser capturada ou somente autorizada_. Caso seja `true`, o valor é capturado simultaneamente à autorização.", "17-0": "`bank_transfer`", "17-1": "**object**", "17-2": "_Configurações para pagamento via transferência bancária_.", "18-0": "`bank_transfer.bank`", "18-1": "**array of objects**", "18-2": "_Array de configurações para indicar quais bancos serão utilizados para a transferência bancária_.", "19-0": "`expires_in`", "19-1": "**integer**", "19-2": "_Tempo, em minutos, para a expiração do checkout_. Caso não seja enviado, o checkout não irá expirar.", "20-0": "`billing_address_editable`", "20-1": "**boolean**", "20-2": "_Torna o objeto billing address editável_.", "21-0": "`billing_address`", "21-1": "**object**", "21-2": "_Configuração para endereço de cobrança_.", "1-0": "`accepted_multi_payment_methods`", "1-1": "**array of array of string**", "1-2": "_Meios de pagamentos aceitos para permitir ao cliente a opção de multimeios_. Valores possíveis: `credit_card, boleto` e `credit_card, credit_card` .", "4-0": "`debit_card`", "4-1": "**object**", "4-2": "_Configurações para pagamento com cartão de débito. [Saiba mais sobre cartão de débito](https://docs.mundipagg.com/v1/reference#cart%C3%A3o-de-d%C3%A9bito).", "22-0": "`voucher`", "22-1": "**object**", "22-2": "_Configurações para pagamento com voucher._ [Saiba mais sobre voucher](https://docs.mundipagg.com/reference#meio-de-pagamento-voucher).", "23-0": "`pix`", "23-1": "**object**", "23-2": "_Configurações para pagamento com PIX_ \n[Saiba mais sobre PIX]\n(https://docs.mundipagg.com/reference#pix)" }, "cols": 3, "rows": 24 } [/block] [block:code] { "codes": [ { "code": "{\n \"items\":[\n {\n \"amount\":2990,\n \"description\":\"Chaveiro do Tesseract\",\n \"quantity\":1\n }\n ],\n \"customer\":{\n \"name\":\"Tony Stark\",\n \"email\":\"tstark@avengers.com\"\n },\n \"payments\":[\n {\n \"payment_method\":\"checkout\",\n \"amount\":2000,\n \"checkout\": {\n \"customer_editable\" : false,\n \"skip_checkout_success_page\": true,\n \"accepted_payment_methods\": [ \"credit_card\", \"boleto\", \"bank_transfer\", \"voucher\",\"debit_card\"],\n \"accepted_multi_payment_methods\": [ \n\t\t \t\t[\"credit_card\",\"credit_card\"],\n\t\t \t\t[\"credit_card\",\"boleto\"]\n\t\t \t\t\t],\n \"success_url\": \"https://www.mundipagg.com\",\n \"bank_transfer\": {\n \"bank\": [\"237\", \"001\", \"341\"]\n },\n \"boleto\": {\n \"bank\": \"033\",\n \"instructions\": \"Pagar até o vencimento\",\n \"due_at\": \"2020-07-25T00:00:00Z\"\n },\n \"credit_card\": {\n \"capture\": true,\n \"statement_descriptor\": \"Desc na fatura\",\n \"installments\": [\n {\n \"number\": 1,\n \"total\": 2000\n },\n {\n \"number\": 2,\n \"total\": 2500\n }\n ]\n },\"voucher\":{\n \t\t\"capture\": true,\n \t\t\"statement_descriptor\": \"Mundipagg\"\n },\n \"debit_card\": {\n \"authentication\":{\n \"statement_descriptor\": \"Desc na fatura\",\n \"type\":\"threed_secure\",\n \"threed_secure\":{\n \"mpi\":\"acquirer\",\n \"success_url\":\"http://www.mundipagg.com\"\n }\n }\n }\n }\n }\n ]\n}", "language": "json", "name": "Request checkout (Pedido)" }, { "code": "{\n \"id\": \"or_3AQ5bRgsyzfe5KEr\",\n \"code\": \"Z9GQZSVHX8\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": false,\n \"items\": [\n {\n \"id\": \"oi_1Y6DxKAUNXtvgMOW\",\n \"type\": \"product\",\n \"description\": \"Chaveiro do Tesseract\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2020-07-06T22:53:47Z\",\n \"updated_at\": \"2020-07-06T22:53:47Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_QaJd1LRfxF0g3KDP\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2020-07-06T22:42:09Z\",\n \"updated_at\": \"2020-07-06T22:42:09Z\",\n \"phones\": {}\n },\n \"status\": \"pending\",\n \"created_at\": \"2020-07-06T22:53:47Z\",\n \"updated_at\": \"2020-07-06T22:53:47Z\",\n \"checkouts\": [\n {\n \"id\": \"chk_GmMAkj7h2U6ONrW5\",\n \"currency\": \"BRL\",\n \"amount\": 2000,\n \"status\": \"open\",\n \"success_url\": \"https://www.mundipagg.com\",\n \"payment_url\": \"https://api.mundipagg.com/checkout/v1/orders/chk_GmMAkj7h2U6ONrW5\",\n \"customer_editable\": false,\n \"billing_address_editable\": true,\n \"skip_checkout_success_page\": true,\n \"shippable\": false,\n \"created_at\": \"2020-07-06T22:53:47Z\",\n \"updated_at\": \"2020-07-06T22:53:47Z\",\n \"accepted_payment_methods\": [\n \"credit_card\",\n \"boleto\",\n \"bank_transfer\",\n \"voucher\",\n \"debit_card\"\n ],\n \"accepted_multi_payment_methods\": [\n [\n \"credit_card\",\n \"credit_card\"\n ],\n [\n \"credit_card\",\n \"boleto\"\n ]\n ],\n \"customer\": {\n \"id\": \"cus_QaJd1LRfxF0g3KDP\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2020-07-06T22:42:09Z\",\n \"updated_at\": \"2020-07-06T22:42:09Z\",\n \"phones\": {}\n },\n \"credit_card\": {\n \"capture\": true,\n \"statementDescriptor\": \"Desc na fatura\",\n \"statement_descriptor\": \"Desc na fatura\",\n \"authentication\": {\n \"type\": \"none\",\n \"threed_secure\": {}\n },\n \"installments\": [\n {\n \"number\": 1,\n \"total\": 2000\n },\n {\n \"number\": 2,\n \"total\": 2500\n }\n ]\n },\n \"debit_card\": {\n \"authentication\": {\n \"type\": \"threed_secure\",\n \"threed_secure\": {\n \"mpi\": \"acquirer\",\n \"success_url\": \"http://www.mundipagg.com\"\n }\n }\n },\n \"boleto\": {\n \"due_at\": \"2020-07-25T00:00:00Z\",\n \"instructions\": \"Pagar até o vencimento\"\n },\n \"voucher\": {\n \"capture\": true,\n \"statement_descriptor\": \"Mundipagg\"\n },\n \"billing_address\": {},\n \"metadata\": {}\n }\n ]\n}", "language": "json", "name": "Response checkout (Pedido)" }, { "code": "//This example was built using MundiAPI-PHP SDK.\n//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP\n\n$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.\n$basicAuthPassword = ''; //fill it with an empty string\n\n$apiClient = new \\MundiAPILib\\MundiAPIClient(\n $secretKey,\n $basicAuthPassword\n);\n\n$orderController = $apiClient->getOrders();\n\n$customer = new \\MundiAPILib\\Models\\CreateCustomerRequest();\n$customer->name = \"Tony Stark\";\n$customer->email = \"tonystark@avengers.com\";\n\n$checkout = new \\MundiAPILib\\Models\\CreateCheckoutPaymentRequest();\n$checkout->customerEditable = false;\n$checkout->skipCheckoutSuccessPage = true;\n$checkout->acceptedPaymentMethods = [\"credit_card\", \"boleto\", \"bank_transfer\", \"debit_card\"];\n$checkout->acceptedMultiPaymentMethods = [[\"credit_card\", \"credit_card\"], [\"credit_card\", \"boleto\"]];\n$checkout->successUrl = \"https://www.mundipagg.com\";\n\n//Bank transfer payment Setup;\n$checkout->bankTransfer = new \\MundiAPILib\\Models\\CreateCheckoutBankTransferRequest();\n$checkout->bankTransfer->bank = [\"237\", \"001\", \"341\"];\n\n//Boleto Payment Setup;\n$checkout->boleto = new \\MundiAPILib\\Models\\CreateCheckoutBoletoPaymentRequest();\n$checkout->boleto->bank = \"033\";\n$checkout->boleto->instructions =\"Pagar ate o vencimento\";\n$checkout->boleto->dueAt = new \\DateTime(\"2021-07-25T00:00:00Z\");\n\n//Credit Card Payment Setup;\n$checkout->creditCard = new \\MundiAPILib\\Models\\CreateCheckoutCreditCardPaymentRequest();\n$checkout->creditCard->capture = true;\n$checkout->creditCard->statement_descriptor = \"Descriptor example\";\n$checkout->creditCard->installments = [ //Credit card installments Setup\n new \\MundiAPILib\\Models\\CreateCheckoutCardInstallmentOptionRequest(),\n new \\MundiAPILib\\Models\\CreateCheckoutCardInstallmentOptionRequest()\n];\n// installment 1;\n$checkout->creditCard->installments[0]->number = 1;\n$checkout->creditCard->installments[0]->total = 2000;\n// installment 2 with extra tax of 500;\n$checkout->creditCard->installments[1]->number = 1;\n$checkout->creditCard->installments[1]->total = 2500;\n\n// Debit Card Payment Setup;\n$checkout->debitCard = new \\MundiAPILib\\Models\\CreateCheckoutDebitCardPaymentRequest();\n// Debit card Authentication Setup;\n$checkout->debitCard->authentication = new \\MundiAPILib\\Models\\CreatePaymentAuthenticationRequest();\n$checkout->debitCard->authentication->type = 'threed_secure';\n$checkout->debitCard->authentication->threedSecure = new \\MundiAPILib\\Models\\CreateThreeDSecureRequest();\n$checkout->debitCard->authentication->threedSecure->mpi = \"acquirer\";\n$checkout->debitCard->authentication->threedSecure->successUrl = \"https://www.mundipagg.com\";\n\n$request = new \\MundiAPILib\\Models\\CreateOrderRequest();\n\n$request->items = [new \\MundiAPILib\\Models\\CreateOrderItemRequest()];\n$request->items[0]->description = \"Tesseract Bracelet\";\n$request->items[0]->quantity = 1;\n$request->items[0]->amount = 2990; // this value should be in cents\n\n$request->payments = [new \\MundiAPILib\\Models\\CreatePaymentRequest()];\n$request->payments[0]->amount = 2000; // this value should be in cents\n$request->payments[0]->paymentMethod = \"checkout\";\n$request->payments[0]->checkout = $checkout;\n$request->customer = $customer;\n\n$result = new \\MundiAPILib\\Models\\GetOrderResponse();\n$result->checkouts = [new \\MundiAPILib\\Models\\GetCheckoutPaymentResponse()];\n$result = $orderController->createOrder($request);\n\necho json_encode($result, JSON_PRETTY_PRINT);", "language": "php", "name": "SDK PHP" }, { "code": "from mundiapi.mundiapi_client import MundiapiClient\nfrom mundiapi.models import *\nfrom mundiapi.controllers import *\nfrom mundiapi.exceptions.error_exception import *\n\nMundiapiClient.config.basic_auth_user_name = \"SUA_SECRET_KEY:\"\norders_controller = orders_controller.OrdersController()\n\ncustomer = create_customer_request.CreateCustomerRequest()\ncustomer.name = \"Tony Stark\"\ncustomer.email = \"tonystark@avengers.com\"\n\ncheckout = create_checkout_payment_request.CreateCheckoutPaymentRequest()\ncheckout.customer_editable = False\ncheckout.skip_checkout_success_page = True\ncheckout.accepted_payment_methods = [\"credit_card\", \"boleto\", \"bank_transfer\", \"debit_card\"]\ncheckout.accepted_multi_payment_methods = [[\"credit_card\", \"credit_card\"], [\"credit_card\", \"boleto\"]]\ncheckout.success_url = \"https://www.mundipagg.com\"\n\n#Bank transfer payment Setup\ncheckout.bank_transfer = create_checkout_bank_transfer_request.CreateCheckoutBankTransferRequest()\ncheckout.bank_transfer.bank = [\"237\", \"001\", \"341\"]\n\n#Boleto Payment Setup\ncheckout.boleto = create_checkout_boleto_payment_request.CreateCheckoutBoletoPaymentRequest()\ncheckout.boleto.bank = \"033\"\ncheckout.boleto.instructions =\"Pagar ate o vencimento\"\ncheckout.boleto.due_at = \"2021-07-25T00:00:00Z\"\n\n#Credit Card Payment Setup\ncheckout.credit_card = create_checkout_credit_card_payment_request.CreateCheckoutCreditCardPaymentRequest()\ncheckout.credit_card.capture = True\ncheckout.credit_card.statement_descriptor = \"Descriptor example\"\ncheckout.credit_card.installments = [ # Credit card installments Setup\n create_checkout_card_installment_option_request.CreateCheckoutCardInstallmentOptionRequest(),\n create_checkout_card_installment_option_request.CreateCheckoutCardInstallmentOptionRequest()]\n# installment 1\ncheckout.credit_card.installments[0].number = 1\ncheckout.credit_card.installments[0].total = 2000\n# installment 2 with extra tax of 500\ncheckout.credit_card.installments[1].number = 1\ncheckout.credit_card.installments[1].total = 2500\n\n# Debit Card Payment Setup\ncheckout.debit_card = create_checkout_debit_card_payment_request.CreateCheckoutDebitCardPaymentRequest()\n# Debit card Authentication Setup\ncheckout.debit_card.authentication = create_payment_authentication_request.CreatePaymentAuthenticationRequest()\ncheckout.debit_card.authentication.mtype = 'none'\ncheckout.debit_card.authentication.threed_secure = create_three_d_secure_request.CreateThreeDSecureRequest()\ncheckout.debit_card.authentication.threed_secure.mpi = \"acquirer\"\ncheckout.debit_card.authentication.threed_secure.success_url = \"https://www.mundipagg.com\"\n\nrequest = create_order_request.CreateOrderRequest()\nrequest.code = \"test-SDK-python\"\nrequest.items = [create_order_item_request.CreateOrderItemRequest()]\nrequest.items[0].description = \"Tesseract Bracelet\"\nrequest.items[0].quantity = 1\nrequest.items[0].amount = 2990\n\nrequest.payments = [create_payment_request.CreatePaymentRequest()]\nrequest.payments[0].amount = 2000\nrequest.payments[0].payment_method = \"checkout\"\nrequest.payments[0].checkout = checkout\nrequest.customer = customer\n\ntry:\n result = get_order_response.GetOrderResponse()\n result.checkouts = [get_checkout_payment_response.GetCheckoutPaymentResponse()]\n result = orders_controller.create_order(request)\n print(\"Order id: \", result.id)\n print(\"Checkout id: \", result.checkouts[0].id)\n print(\"Order result status: \", result.status)\n print(\"Checkout payment url: \", result.checkouts[0].payment_url)\n assert result.status == \"pending\"\n assert result.checkouts[0].boleto is not None\n assert result.checkouts[0].credit_card is not None\n assert result.checkouts[0].debit_card is not None\n assert result.checkouts[0].bank_transfer is not None\n assert result.checkouts[0].payment_url is not None\nexcept ErrorException as ex:\n print(\"\\n\")\n print(\"Error Message: \", ex.message)\n print(\"Status code Response: \", ex.response_code)\n if(ex.errors is not None):\n print(\"Errors: \", ex.errors)\nexcept Exception as ex:\n raise ex", "language": "python", "name": "SDK PYTHON" } ] } [/block] [block:callout] { "type": "danger", "body": "É importante notar que o meio de pagamento checkout é suportado somente por pedidos, **não podendo ser utilizado em cobranças**.", "title": "CHECKOUT APLICA-SE APENAS A PEDIDOS" } [/block]