Para criar um 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:
| Atributos | Tipo | Descrição |
|---|---|---|
expires_in | integer | Data de expiração do Pix em segundos. (Mandatório) |
expires_at | datetime | Data de expiração do Pix. (Opcional | Mandatório caso não enviado o expires_in) [Formato: YYYY-MM-DDThh:mm:ss] |
additional_information | Array of objects | Objeto chave/valor utilizado para adicionar informações sobre o pagamento. Esses dados serão visíveis para o consumidor na hora do pagamento. |
Bancos aceitos para transações de PIX
O meio de pagamento PIX só está disponível para contas configuradas com um gateway específico chamado Pagar.me .
Estorno de transações
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.
Pix com Split
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.
{
"items": [
{
"amount": 2990,
"description": "Chaveiro do Tesseract",
"quantity": 1
}
],
"customer": {
"name": "Tony Stark",
"email": "[email protected]",
"type": "individual",
"document": "01234567890",
"phones": {
"home_phone": {
"country_code": "55",
"number": "22180513",
"area_code": "21"
}
}
},
"payments": [
{
"payment_method": "pix",
"pix": {
"expires_in": "52134613",
"additional_information": [
{
"name": "Quantidade",
"value": "2"
}
]
}
}
]
}
{
"id": "or_56GXnk6T0eU88qMm",
"code": "YV3RCRIN24",
"amount": 3090,
"currency": "BRL",
"closed": true,
"items": [
{
"id": "oi_6rXqKEzuZYcRo2zL",
"description": "Chaveiro do Tesseract",
"amount": 2990,
"quantity": 1,
"status": "active",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:30Z"
}
],
"customer": {
"id": "cus_x4nz0P4SbOTA0KBZ",
"name": "Tony Stark",
"email": "[email protected]",
"document": "14582256988",
"type": "individual",
"delinquent": false,
"created_at": "2019-05-02T17:06:01Z",
"updated_at": "2019-06-12T14:50:18Z",
"phones": {}
},
"shipping": {
"amount": 100,
"description": "Stark",
"recipient_name": "Tony Stark",
"recipient_phone": "24586787867",
"address": {
"city": "Malibu",
"state": "CA",
"country": "US",
"zip_code": "90265",
"line_1": "10880, Malibu Point, Malibu Central"
}
},
"status": "pending",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:30Z",
"closed_at": "2019-10-16T17:36:30Z",
"ip": "52.168.67.32",
"session_id": "322b821a",
"device": {
"platform": "ANDROID OS"
},
"location": {
"latitude": "-22.970722",
"longitude": "43.182365"
},
"charges": [
{
"id": "ch_K2rJ5nlHwTE4qRDP",
"code": "YV3RCRIN24",
"gateway_id": "3b4bb2d9-19b3-4638-a974-0bb914fff472",
"amount": 3090,
"status": "pending",
"currency": "BRL",
"payment_method": "Pix",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:31Z",
"customer": {
"id": "cus_x4nz0P4SbOTA0KBZ",
"name": "Tony Stark",
"email": "[email protected]",
"document": "14582256988",
"type": "individual",
"delinquent": false,
"created_at": "2019-05-02T17:06:01Z",
"updated_at": "2019-06-12T14:50:18Z",
"phones": {}
},
"last_transaction": {
"id": "tran_bZ0N3DjjUzTW68eq",
"transaction_type": "Pix",
"gateway_id": "044581ea-67e8-4772-bd56-f10ade5499de",
"amount": 3090,
"status": "waiting_payment",
"success": true,
"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",
"qr_code_url": "https://api.mundipagg.com/core/v1/transactions/tran_bZ0N3DjjUzTW68eq/qrcode.png",
"additional_information": [
{
"name": "Quantidade",
"value": "2"
}
],
"expires_at": "2020-09-20T00:00:00Z",
"created_at": "2019-10-16T17:36:30Z",
"updated_at": "2019-10-16T17:36:30Z",
"gateway_response": {
"code": "201"
},
"antifraud_response": {}
}
}
],
"checkouts": []
}
{
"items": [
{
"amount": 100,
"description": "Chaveiro do Tesseract",
"quantity": 1,
"code": "12345"
}
],
"customer": {
"name": "Tony Stark",
"email": "[email protected]"
},
"payments": [
{
"payment_method": "pix",
"pix": {
"expires_in": "52134613",
"additional_information": [
{
"name": "Quantidade",
"value": "2"
}
],
"split": [
{
"amount": 50,
"recipient_id": "rp_5yGwpMGckBHVYmb6",
"type": "percentage",
"options": {
"charge_processing_fee": true,
"charge_remainder_fee": true,
"liable": true
}
},
{
"amount": 50,
"type": "percentage",
"recipient_id": "rp_yLnAyVpHbQIqZxwO",
"options": {
"charge_processing_fee": false,
"charge_remainder_fee": false,
"liable": false
}
}
]
}
]
}
Status das transações de Pix (Transaction)
As transações de Pix podem possuir os seguintes status:
| Status | Descrição |
|---|---|
waiting_payment | Aguardando pagamento |
paid | Pago |
pending_refuded | Aguardando estorno |
refunded | Estornado |
with_error | Com erro |
failed | Falha |