Informando os dados essenciais para efetivação de uma cobrança, este recurso permite a criação de uma cobrança de pagamento recorrente.
Através desse recurso realize uma cobrança do seu cliente, indicando ao PagSeguro que a cobrança está relacionada a um pagamento recorrente.
Esse recurso é ideal se você:
- Possui serviço contínuo;
- Possui gestão de recorrência própria;
Para a primeira cobrança da recorrência, você deve integrar seu sistema com a API de Cobrança usando o recurso /charges informando o tipo de recorrência INITIAL no parâmetro recurring.type, nesse cenário o uso do código de segurança do cartão(payment_method.card.security_code) é obrigatório.
Já para as cobranças subsequentes, você deve integrar seu sistema com a API de Cobrança usando o recurso /charges informando o tipo de recorrência SUBSEQUENT no parâmetro recurring.type.
IMPORTANTE
A utilização desse parâmetro não está vinculada nem condicionada à API de Pagamento Recorrente do PagSeguro.
curl --location --request POST 'https://sandbox.api.pagseguro.com/charges' \
--header 'Authorization: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"reference_id": "ex-00001",
"description": "Motivo da cobrança",
"amount": {
"value": 1000,
"currency": "BRL"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": false,
"card": {
"number": "4111111111111111",
"exp_month": "03",
"exp_year": "2026",
"security_code": "123",
"holder": {
"name": "Jose da Silva"
}
}
},
"recurring": {
"type": "INITIAL"
},
"notification_urls": [
"https://yourserver.com/nas_ecommerce/277be731-3b7c-4dac-8c4e-4c3f4a1fdc46/"
]
}'
{
"id": "CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1",
"reference_id": "ex-00001",
"status": "PAID",
"created_at": "2020-05-19T18:49:48.406-03:00",
"paid_at": "2020-05-19T18:49:48.45-03:00",
"description": "Motivo da cobrança",
"amount": {
"value": 1000,
"currency": "BRL",
"summary": {
"total": 1000,
"paid": 1000,
"refunded": 0
}
},
"payment_response": {
"code": "20000",
"message": "SUCESSO",
"reference": "031700056475"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"brand": "mastercard",
"first_digits": "411111",
"last_digits": "1111",
"exp_month": "3",
"exp_year": "2026",
"holder": {
"name": "João da silva"
}
}
},
"recurring": {
"type": "INITIAL"
},
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1",
"media": "application/json",
"type": "GET"
},
{
"rel": "CHARGE.CANCEL",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1/cancel",
"media": "application/json",
"type": "POST"
}
],
"notification_urls": [
"https://yourserver.com/ecommerce/"
]
}
curl --location --request POST 'https://sandbox.api.pagseguro.com/charges' \
--header 'Authorization: {{token}}' \
--header 'Content-Type: application/json' \
--header 'x-idempotency-key;' \
--data-raw '{
"reference_id": "ex-00001",
"description": "Motivo da cobrança",
"amount": {
"value": 1000,
"currency": "BRL"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": "1",
"capture": true,
"card": {
"number": "4111111111111111",
"exp_month": "03",
"exp_year": "2026",
"holder": {
"name": "João da silva"
}
}
},
"recurring": {
"type": "SUBSEQUENT"
},
"notification_urls": [
"https://yourserver.com/ecommerce/"
]
}'
{
"id": "CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1",
"reference_id": "ex-00001",
"status": "PAID",
"created_at": "2020-05-19T18:49:48.406-03:00",
"paid_at": "2020-05-19T18:49:48.45-03:00",
"description": "Motivo da cobrança",
"amount": {
"value": 1000,
"currency": "BRL",
"summary": {
"total": 1000,
"paid": 1000,
"refunded": 0
}
},
"payment_response": {
"code": "20000",
"message": "SUCESSO",
"reference": "031700056475"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"brand": "mastercard",
"first_digits": "411111",
"last_digits": "1111",
"exp_month": "3",
"exp_year": "2026",
"holder": {
"name": "João da silva"
}
}
},
"recurring": {
"type": "SUBSEQUENT"
},
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1",
"media": "application/json",
"type": "GET"
},
{
"rel": "CHARGE.CANCEL",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_80FFD68A-A74E-4066-B35C-076C467F35B1/cancel",
"media": "application/json",
"type": "POST"
}
],
"notification_urls": [
"https://yourserver.com/ecommerce/"
]
}