Informando os dados essenciais para efetivação de uma cobrança, este recurso permite a criação de uma cobrança de pagamento com cartões de benefícios do tipo voucher (alimentação ou refeição).
Importante
Para habilitar a aceitação de vouchers é necessário estar de acordo com as regras do PAT (Programa de Alimentação do Trabalhador) e entrar em contato diretamente com a empresa de benefício para realização de um credenciamento.
Veja como realizar esta etapa em Cobrando com voucher.
Cartões de benefícios aceitos:
- VR Refeição
- VR Alimentação
- VR Multibenefícios
Em breve outras opções de bandeiras de vouchers estarão disponíveis
curl --location --request POST 'https://sandbox.api.pagseguro.com/charges' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--header 'x-api-version: 4.0' \
--header 'x-idempotency-key;' \
--data-raw '{
"reference_id": "ex-00001",
"description": "Pagamento com voucher",
"amount": {
"value": 1000,
"currency": "BRL"
},
"payment_method": {
"type": "VOUCHER",
"capture": true,
"card": {
"number": "4111111111111111",
"exp_month": "03",
"exp_year": "2026",
"security_code": "123",
"holder": {
"name": "Jose da Silva",
}
}
},
"notification_urls": [
"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
],
"metadata": {
"Exemplo": "Aceita qualquer informação",
"NotaFiscal": "123",
"idComprador": "123456"
}
}'
{
"id": "CHAR_2FFF3F2B-BAA4-47EA-8B40-3838C5CA059F",
"reference_id": "ex-00001",
"status": "PAID",
"created_at": "2022-05-25T16:01:37.385-03:00",
"paid_at": "2022-05-25T16:01:39.000-03:00",
"description": "Pagamento com voucher",
"amount": {
"value": 1000,
"currency": "BRL",
"summary": {
"total": 1000,
"paid": 1000,
"refunded": 0
}
},
"payment_response": {
"code": "20000",
"message": "SUCESSO",
"reference": "032416400102"
},
"payment_method": {
"type": "VOUCHER",
"capture": true,
"card": {
"brand": "vr",
"first_digits": "411111",
"last_digits": "1111",
"exp_month": "3",
"exp_year": "2026",
"holder": {
"name": "Jose da Silva"
}
},
"soft_descriptor": "sellervirtual"
},
"notification_urls": [],
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_2FFF3F2B-BAA4-47EA-8B40-3838C5CA059F",
"media": "application/json",
"type": "GET"
}
]
}