Informando os dados essenciais para efetivação de um pagamento, este recurso permite a criação de um pedido com cobrança de pagamento recorrente.
Através desse recurso realize uma cobrança do seu cliente, indicando ao PagSeguro que o pedido está relacionado 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 Pedidos usando o recurso /orders informando o tipo de recorrência INITIAL no parâmetro charges[].recurring.type, nesse cenário o uso do código de segurança do cartão(charges[].payment_method.card.security_code) é obrigatório.
Já para as cobranças subsequentes, você deve integrar seu sistema com a API de Pedidos usando o recurso /orders informando o tipo de recorrência SUBSEQUENT no parâmetro charges[].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/orders' \
--header 'Authorization: Bearer {{TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"reference_id": "ex-00001",
"customer": {
"name": "Jose da Silva",
"email": "[email protected]",
"tax_id": "12345678909",
"phones": [
{
"country": "55",
"area": "11",
"number": "999999999",
"type": "MOBILE"
}
]
},
"items": [
{
"reference_id": "referencia do item",
"name": "nome do item",
"quantity": 1,
"unit_amount": 500
}
],
"shipping": {
"address": {
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"complement": "apto 12",
"locality": "Pinheiros",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "01452002"
}
},
"notification_urls": [
"https://meusite.com/notificacoes"
],
"charges": [
{
"reference_id": "referencia da cobranca",
"description": "descricao da cobranca",
"amount": {
"value": 500,
"currency": "BRL"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"encrypted":"VfC6DIK1XyGymJHYLjG+XVUeqPdb44UopeCZukfpY1TPy1tVI1ic79ikrLT6wSk/w6u01T8y4Qqcp9hzJZPAcmLfXE52OXTqPGimo2u/ET/HQnHlWNpLdc2aYs2rYwiqoHdoArjUHU2cdAdMF2pZjskvvxxd3rmhH53JTletpoIuqOs9oqVkajfu3GPb9pV/bnBJ5jWCGgrfjU8UGHcKCRtLO4Dpns7cj59NloRyEn1zNx5YP4OwHoZ6z0mFzlFlzcwjbjoaI7F8AVvCkd4MHJB5WwenkKHq107bkcqIH2mK/MVes7kBx9WtgU98ZIgc8RHSLu70Gy0YSmTFAo06pg==",
"security_code": "123",
"holder": {
"name": "Jose da Silva"
},
"store": true
}
},
"recurring": {
"type": "INITIAL"
}
}
]
}'
{
"id": "ORDE_6828BE5C-D27B-4DC9-BDD1-3DEC52F4CA8E",
"reference_id": "ex-00001",
"created_at": "2023-02-08T16:19:00.259-03:00",
"customer": {
"name": "Jose da Silva",
"email": "[email protected]",
"tax_id": "12345678909",
"phones": [
{
"type": "MOBILE",
"country": "55",
"area": "11",
"number": "999999999"
}
]
},
"items": [
{
"reference_id": "referencia do item",
"name": "nome do item",
"quantity": 1,
"unit_amount": 500
}
],
"shipping": {
"address": {
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"complement": "apto 12",
"locality": "Pinheiros",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "01452002"
}
},
"charges": [
{
"id": "CHAR_6291DE92-7F26-4043-A14E-146695E554A4",
"reference_id": "referencia da cobranca",
"status": "PAID",
"created_at": "2023-02-08T16:19:00.760-03:00",
"paid_at": "2023-02-08T16:19:02.000-03:00",
"description": "descricao da cobranca",
"amount": {
"value": 500,
"currency": "BRL",
"summary": {
"total": 500,
"paid": 500,
"refunded": 0
}
},
"payment_response": {
"code": "20000",
"message": "SUCESSO",
"reference": "032416400102"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"id": "CARD_CCFE8D12-79E9-4ADF-920B-A54E51D8DA6E",
"brand": "mastercard",
"first_digits": "555566",
"last_digits": "8884",
"exp_month": "12",
"exp_year": "2030",
"holder": {
"name": "Joãozinho da Silva"
},
"store": true
},
"soft_descriptor": "IntegracaoPagsegu"
},
"recurring": {
"type": "INITIAL"
},
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_6291DE92-7F26-4043-A14E-146695E554A4",
"media": "application/json",
"type": "GET"
},
{
"rel": "CHARGE.CANCEL",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_6291DE92-7F26-4043-A14E-146695E554A4/cancel",
"media": "application/json",
"type": "POST"
}
]
}
],
"notification_urls": [
"https://meusite.com/notificacoes"
],
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_6828BE5C-D27B-4DC9-BDD1-3DEC52F4CA8E",
"media": "application/json",
"type": "GET"
},
{
"rel": "PAY",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_6828BE5C-D27B-4DC9-BDD1-3DEC52F4CA8E/pay",
"media": "application/json",
"type": "POST"
}
]
}
curl --location --request POST 'https://sandbox.api.pagseguro.com/orders' \
--header 'Authorization: Bearer {{TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"reference_id": "ex-00001",
"customer": {
"name": "Jose da Silva",
"email": "[email protected]",
"tax_id": "12345678909",
"phones": [
{
"country": "55",
"area": "11",
"number": "999999999",
"type": "MOBILE"
}
]
},
"items": [
{
"reference_id": "referencia do item",
"name": "nome do item",
"quantity": 1,
"unit_amount": 500
}
],
"shipping": {
"address": {
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"complement": "apto 12",
"locality": "Pinheiros",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "01452002"
}
},
"notification_urls": [
"https://meusite.com/notificacoes"
],
"charges": [
{
"reference_id": "referencia da cobranca",
"description": "descricao da cobranca",
"amount": {
"value": 500,
"currency": "BRL"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"id": "CARD_CCFE8D12-79E9-4ADF-920B-A54E51D8DA6E",
"holder": {
"name": "Jose da Silva"
},
"store": true
}
},
"recurring": {
"type": "SUBSEQUENT"
}
}
]
}'
{
"id": "ORDE_2E178025-62AC-4BCE-8300-0D87D4359261",
"reference_id": "ex-00001",
"created_at": "2023-02-08T16:20:35.797-03:00",
"customer": {
"name": "Jose da Silva",
"email": "[email protected]",
"tax_id": "12345678909",
"phones": [
{
"type": "MOBILE",
"country": "55",
"area": "11",
"number": "999999999"
}
]
},
"items": [
{
"reference_id": "referencia do item",
"name": "nome do item",
"quantity": 1,
"unit_amount": 500
}
],
"shipping": {
"address": {
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"complement": "apto 12",
"locality": "Pinheiros",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "01452002"
}
},
"charges": [
{
"id": "CHAR_370C8EA6-5236-4736-A8D2-BD7BC83F9B81",
"reference_id": "referencia da cobranca",
"status": "PAID",
"created_at": "2023-02-08T16:20:36.275-03:00",
"paid_at": "2023-02-08T16:20:37.000-03:00",
"description": "descricao da cobranca",
"amount": {
"value": 500,
"currency": "BRL",
"summary": {
"total": 500,
"paid": 500,
"refunded": 0
}
},
"payment_response": {
"code": "20000",
"message": "SUCESSO",
"reference": "032416400102"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"id": "CARD_CCFE8D12-79E9-4ADF-920B-A54E51D8DA6E",
"brand": "mastercard",
"first_digits": "555566",
"last_digits": "8884",
"exp_month": "12",
"exp_year": "2030",
"holder": {
"name": "Joãozinho da Silva"
},
"store": true
},
"soft_descriptor": "IntegracaoPagsegu"
},
"recurring": {
"type": "SUBSEQUENT"
},
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_370C8EA6-5236-4736-A8D2-BD7BC83F9B81",
"media": "application/json",
"type": "GET"
},
{
"rel": "CHARGE.CANCEL",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_370C8EA6-5236-4736-A8D2-BD7BC83F9B81/cancel",
"media": "application/json",
"type": "POST"
}
]
}
],
"notification_urls": [
"https://meusite.com/notificacoes"
],
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_2E178025-62AC-4BCE-8300-0D87D4359261",
"media": "application/json",
"type": "GET"
},
{
"rel": "PAY",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_2E178025-62AC-4BCE-8300-0D87D4359261/pay",
"media": "application/json",
"type": "POST"
}
]
}