Para todo transação que um POS integrado realizar será criado uma nova charge dentro da order referente ao pedido pago pelo POS. Uma order poderá conter n charges de pagamentos do POS.
Para cada transação no POS, será realizada a criação de charge e isso sempre irá disparar o envio de webhooks para o parceiro que tiver os eventos de webhooks configurados.
Configuração de Webhooks
A configuração de webhooks deve ser realizada pelo Dashboard Pagar.me. Em Configurações->Webhooks.
Transações Avulsas
Para transação avulsa, na qual o POS realiza um pagamento que não está relacionado a um pedido previamente criado, automaticamente será criado um pedido e uma charge para o mesmo.
Exemplo de Webhook charge.paid, enviado quando uma cobrança é paga via POS
{
"id": "hook_masdwqYGoIjcEVe5Go",
"account": {
"id": "acc_ladsADGdasdgwIEd58A",
"name": "Parceiro Teste"
},
"type": "charge.paid",
"created_at": "2023-01-18T21:22:22.9517556Z",
"data": {
"id": "ch_bBy6neoSPdsdaewffvxvVd",
"code": "11831338033297",
"amount": 2538,
"paid_amount": 2538,
"status": "paid",
"currency": "BRL",
"payment_method": "cash",
"paid_at": "2023-01-18T21:22:21.8129944Z",
"created_at": "2023-01-18T21:22:21.7607907Z",
"updated_at": "2023-01-18T21:22:21.8129944Z",
"pending_cancellation": false,
"customer": {
"id": "cus_p0ljRJKHPDCdfsfsdvAF",
"name": "Unknown customer",
"delinquent": false,
"created_at": "2023-01-18T21:22:21.6962222Z",
"updated_at": "2023-01-18T21:22:21.6962222Z",
"phones": {},
"metadata": {}
},
"order": {
"id": "or_omyzASdsdfoGADSFA06",
"code": "O6W1CADq3TJR",
"amount": 2538,
"closed": true,
"created_at": "2023-01-18T21:22:21.7274739Z",
"updated_at": "2023-01-18T21:22:21.8276542Z",
"closed_at": "2023-01-18T21:22:21.7274739Z",
"currency": "BRL",
"status": "paid",
"customer_id": "cus_pFASdFKHPDCZjGVP",
"metadata": {
"scheme_name": "MasterCard",
"account_holder_name": null,
"account_funding_source": "Credit",
"authorization_code": "051659",
"initiator_transaction_key": "6C568971-3.21.0-ROPA0Z-0017",
"installment_quantity": null,
"installment_type": null,
"transaction_timestamp": "2023-01-18T21:22:18.461+00:00",
"terminal_serial_number": "6C568971"
}
},
"last_transaction": {
"transaction_type": "cash",
"id": "tran_KlAMPFDffEURU1Pm0r",
"amount": 2538,
"status": "paid",
"success": true,
"created_at": "2023-01-18T21:22:21.7908938Z",
"updated_at": "2023-01-18T21:22:21.7908938Z",
"gateway_response": {},
"antifraud_response": {}
},
"metadata": {
"scheme_name": "MasterCard",
"account_holder_name": null,
"account_funding_source": "Credit",
"authorization_code": "0124659",
"initiator_transaction_key": "6C568971-3.21.0-ROPA0Z-0017",
"installment_quantity": null,
"installment_type": null,
"transaction_timestamp": "2023-01-18T21:22:18.461+00:00",
"terminal_serial_number": "6C5680991"
}
}
}
Exemplo de Webhook charge.refunded, realizado quando uma cobrança é cancelada via POS
{
"id": "hook_3xLXqbnTAufsdfsP",
"account": {
"id": "acc_KrX29dfwefsvMBj",
"name": "Parceiro teste"
},
"type": "charge.refunded",
"created_at": "2023-01-16T19:34:01.4435691Z",
"data": {
"id": "ch_4XYezJ3gSasdfasfwjq67",
"code": "11631304828303",
"amount": 18254,
"paid_amount": 18254,
"canceled_amount": 18254,
"status": "canceled",
"currency": "BRL",
"payment_method": "cash",
"paid_at": "2023-01-16T18:53:51.54Z",
"canceled_at": "2023-01-16T19:33:58.4205666Z",
"created_at": "2023-01-16T18:53:51.523Z",
"updated_at": "2023-01-16T19:33:58.4205666Z",
"pending_cancellation": false,
"order": {
"id": "or_3gya1sfwwwhBkasdQfvO",
"code": "R205B0MF4K",
"amount": 18254,
"closed": true,
"created_at": "2023-01-16T18:53:27.947Z",
"updated_at": "2023-01-16T18:53:55.897Z",
"closed_at": "2023-01-16T18:53:55.897Z",
"currency": "BRL",
"status": "paid",
"metadata": {}
},
"last_transaction": {
"transaction_type": "cash",
"id": "tran_J4zmQWLT9S9jPFsdfwQWfd",
"amount": 18254,
"status": "canceled",
"success": true,
"created_at": "2023-01-16T19:33:58.4205666Z",
"updated_at": "2023-01-16T19:33:58.4205666Z",
"gateway_response": {},
"antifraud_response": {},
"metadata": {}
},
"metadata": {
"scheme_name": "Visa",
"account_holder_name": "Tony Stark ",
"account_funding_source": "Credit",
"authorization_code": "209634",
"initiator_transaction_key": "6M518018-3.21.0-ROLDTL-0039",
"installment_quantity": null,
"installment_type": null,
"transaction_timestamp": "2023-01-16T18:53:47.894+00:00",
"terminal_serial_number": "6M7898018"
}
}
}
Campos específicos para transações de POS:
| Atributo | Tipo | Descrição |
|---|---|---|
| data.code | String | NSU - Código identificador da transação na adquirente |
| metadata.schemeName | String in ("Alelo", "AmericanExpress", "AvanCard", "BanesCard" ,"Ben", "Biq", "Cabal", "CooperCard", "DinersClub", "Discover", "Elo", "FortBrasil", "GreenCard", "Hipercard", "JCB", "MasterCard", "NutriCard", "Senff", "Sodexo", "SoroCred", "Ticket", "UnionPay", "UpBrasil", "ValeCard"," VerdeCard", "VeroCard", "Visa", "VR") | Nome da bandeira |
| metadata.accountHolderName | String | Nome do portador do cartão |
| metadata.accountFundingSource | String in ("Credit", "Debit", "Prepaid") | Tipo da transação |
| metadata.authorizationCode | String | Código de autorização da bandeira |
| metadata.installmentQuantity | String ("1" a "24") | Quantidade de parcelas. Campo não será enviado se transação não for de crédito parcelado |
| metadata.installmentType | String in ("MerchantFinanced", "IssuerFinanced") | Tipo de parcelamento. Campo não será enviado se transação não for de crédito parcelado |
| metadata.transactionTimestamp | String DateTime Ex: "2020-07-09T18:28:26" | Data/Hora da transação UTV |
| metadata.terminalSerialNumber | String | Numero serial do terminal (POS) |
| metadata.initiatorTransactionKey | Sting | Código identificador da transação do POS |
Cartões Pré-pagos - A partir do dia 01/04/2023
Para atender à Resolução nº 246 do Banco Central do Brasil, em 01/04/2023 as liquidações de cartões pré-pagos que antes aconteciam em D+30 passam a ser em D+2. Para ser possível conciliar esse tipo de transação, incluiremos no campo AccountFundingSource um novo valor (3) que indicara transações originadas de cartões Pré-pago (Prepaid).