--- agentTools: projectIndex: https://docs.mundipagg.com/llms.txt --- # Pix Para criar um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **Pix**, devemos incluir o objeto `Pix` dentro do nó `payment`, assim como a propriedade `"payment_method": "Pix"`. O objeto `Pix` contém as seguintes propriedades: [block:parameters] { "data": { "1-0": "`expires_at`", "1-1": "**datetime**", "2-0": "`additional_information`", "2-1": "**Array of objects **", "1-2": "_Data de expiração do Pix_. \n(**Opcional | Mandatório caso não enviado o expires_in**) [Formato: YYYY-MM-DDThh:mm:ss]", "2-2": "_Objeto chave/valor utilizado para adicionar informações sobre o pagamento. Esses dados serão visíveis para o consumidor na hora do pagamento_.", "h-0": "Atributos", "h-1": "Tipo", "h-2": "Descrição", "0-0": "`expires_in`", "0-1": "**integer**", "0-2": "_Data de expiração do Pix em segundos_. \n(**Mandatório**)" }, "cols": 3, "rows": 3 } [/block] [block:callout] { "type": "info", "body": "O meio de pagamento PIX só está disponível para contas configuradas com um gateway específico chamado Pagar.me .", "title": "Bancos aceitos para transações de PIX" } [/block] [block:callout] { "type": "info", "title": "Estorno de transações", "body": "Para realizar o estorno de transações com pix é necessário enviar uma requisição de cancelamento de cobrança informando o id da cobrança que deve ser cancelada." } [/block] [block:callout] { "type": "info", "title": "Pix com Split", "body": "Para os clientes com afiliação Pagar.me, é possível criar pedidos e cobranças com o meio de pagamento Pix incluindo a funcionalidade de Split." } [/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\": \"avengerstark@ligadajustica.com.br\",\n \"type\": \"individual\",\n \"document\": \"01234567890\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"22180513\",\n \"area_code\": \"21\"\n }\n }\n },\n \"payments\": [\n {\n \"payment_method\": \"pix\",\n \"pix\": {\n \"expires_in\": \"52134613\",\n \"additional_information\": [\n {\n \"name\": \"Quantidade\",\n \"value\": \"2\"\n }\n ]\n }\n }\n ]\n}", "language": "json", "name": "Request Pix (Pedido)" }, { "code": "{\n \"id\": \"or_56GXnk6T0eU88qMm\",\n \"code\": \"YV3RCRIN24\",\n \"amount\": 3090,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_6rXqKEzuZYcRo2zL\",\n \"description\": \"Chaveiro do Tesseract\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2019-10-16T17:36:30Z\",\n \"updated_at\": \"2019-10-16T17:36:30Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_x4nz0P4SbOTA0KBZ\",\n \"name\": \"Tony Stark\",\n \"email\": \"avengerstark@ligadajustica.com.br\",\n \"document\": \"14582256988\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2019-05-02T17:06:01Z\",\n \"updated_at\": \"2019-06-12T14:50:18Z\",\n \"phones\": {}\n },\n \"shipping\": {\n \"amount\": 100,\n \"description\": \"Stark\",\n \"recipient_name\": \"Tony Stark\",\n \"recipient_phone\": \"24586787867\",\n \"address\": {\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip_code\": \"90265\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"status\": \"pending\",\n \"created_at\": \"2019-10-16T17:36:30Z\",\n \"updated_at\": \"2019-10-16T17:36:30Z\",\n \"closed_at\": \"2019-10-16T17:36:30Z\",\n \"ip\": \"52.168.67.32\",\n \"session_id\": \"322b821a\",\n \"device\": {\n \"platform\": \"ANDROID OS\"\n },\n \"location\": {\n \"latitude\": \"-22.970722\",\n \"longitude\": \"43.182365\"\n },\n \"charges\": [\n {\n \"id\": \"ch_K2rJ5nlHwTE4qRDP\",\n \"code\": \"YV3RCRIN24\",\n \"gateway_id\": \"3b4bb2d9-19b3-4638-a974-0bb914fff472\",\n \"amount\": 3090,\n \"status\": \"pending\",\n \"currency\": \"BRL\",\n \"payment_method\": \"Pix\",\n \"created_at\": \"2019-10-16T17:36:30Z\",\n \"updated_at\": \"2019-10-16T17:36:31Z\",\n \"customer\": {\n \"id\": \"cus_x4nz0P4SbOTA0KBZ\",\n \"name\": \"Tony Stark\",\n \"email\": \"avengerstark@ligadajustica.com.br\",\n \"document\": \"14582256988\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2019-05-02T17:06:01Z\",\n \"updated_at\": \"2019-06-12T14:50:18Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_bZ0N3DjjUzTW68eq\",\n \"transaction_type\": \"Pix\",\n \"gateway_id\": \"044581ea-67e8-4772-bd56-f10ade5499de\",\n \"amount\": 3090,\n \"status\": \"waiting_payment\",\n \"success\": true,\n \"qr_code\": \"00020101021226480019BR.COM.STONE.QRCODE0108A37F8712020912345678927820 014BR.GOV.BCB.PIX2560sandbox-qrcode.stone.com.br/api/v2/qr/sGY7FyVExavqkzFvkQu MXA28580010BR.COM.ELO0104516002151234567890000000308933BB1100401P520400 00530398654041.005802BR5911STONE TESTE6009SAO PAULO62600522sGY7FyVExavqkzFvkQuMXA50300017BR.GOV.BCB.BRCODE01051.0.0 80500010BR.COM.ELO01100915132023020200030201040613202363043BA1\",\n \"qr_code_url\": \"https://api.mundipagg.com/core/v1/transactions/tran_bZ0N3DjjUzTW68eq/qrcode.png\",\n \"additional_information\": [\n {\n \"name\": \"Quantidade\",\n \"value\": \"2\"\n }\n ],\n \"expires_at\": \"2020-09-20T00:00:00Z\",\n \"created_at\": \"2019-10-16T17:36:30Z\",\n \"updated_at\": \"2019-10-16T17:36:30Z\",\n \"gateway_response\": {\n \"code\": \"201\"\n },\n \"antifraud_response\": {}\n }\n }\n ],\n \"checkouts\": []\n}", "language": "json", "name": "Response Pix (Pedido)" }, { "code": "{\n \"items\": [\n {\n \"amount\": 100,\n \"description\": \"Chaveiro do Tesseract\",\n \"quantity\": 1,\n \"code\": \"12345\"\n }\n ],\n \"customer\": {\n \"name\": \"Tony Stark\",\n \"email\": \"Tony@Avangers.com\"\n },\n \n \"payments\": [\n {\n \"payment_method\": \"pix\",\n \"pix\": {\n \"expires_in\": \"52134613\",\n \"additional_information\": [\n {\n \"name\": \"Quantidade\",\n \"value\": \"2\"\n }\n ],\n \"split\": [\n {\n \"amount\": 50,\n \"recipient_id\": \"rp_5yGwpMGckBHVYmb6\",\n \"type\": \"percentage\",\n \"options\": {\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": true,\n \"liable\": true\n }\n },\n {\n \"amount\": 50,\n \"type\": \"percentage\",\n \"recipient_id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"options\": {\n \"charge_processing_fee\": false,\n \"charge_remainder_fee\": false,\n \"liable\": false\n }\n }\n ]\n }\n ]\n}", "language": "text" } ] } [/block] [block:api-header] { "title": "Status das transações de Pix (Transaction)" } [/block] As transações de Pix podem possuir os seguintes status: [block:parameters] { "data": { "h-0": "Status", "h-1": "Descrição", "0-0": "`waiting_payment`", "0-1": "Aguardando pagamento", "1-0": "`paid`", "3-0": "`refunded`", "4-0": "`with_error`", "5-0": "`failed`", "5-1": "Falha", "1-1": "Pago", "3-1": "Estornado", "4-1": "Com erro", "2-0": "`pending_refuded`", "2-1": "Aguardando estorno" }, "cols": 2, "rows": 6 } [/block]