Quando você cria e paga o pedido com divisão de pagamento, somente o endpoint Criar pedido é utilizado. Nesse caso, além das informações relacionadas ao pedido, você precisará fornecer as informações do método de pagamento selecionado.
Os dados necessários para criar e pagar o pedido irão variar de acordo com o método de pagamento selecionado. Por isso, aconselhamos você a utilizar os guias disponíveis na página de Casos de Uso, caso você ainda não realizou testes de pagamento.
Para utilizar da divisão do pagamento, você irá fornecer os mesmos dados que no caso anterior. No corpo da requisição você deve informar as informações do meio de pagamento que será utilizado através do objeto charges.
As informações da divisão do pagamento são informadas através do objeto charges.splits. Para definir a divisão do pagamento você precisará informar se utilizará a divisão percentual ou fixa. Além disso, precisa informar os id das contas de cada um dos recebedores e os valores que cada um receberá, sejam percentuais ou fixos. A descrição desses parâmetros é apresentada na tabela abaixo:
| Parâmetro | Descrição |
|---|---|
charges.splits.method | Define se a divisão será FIXEDou PERCENTAGE. |
charges.splits.receivers.account.id | Identificador único da conta PagBank do recebedor. |
charges.splits.receivers.amount.value | Valor destinado ao recebedor. Se a divisão for FIXED, esse valor é definido em centavos. Se a divisão for PERCENTAGE, esse valor é o percentual do montante total destinado ao recebedor. |
Abaixo você encontra dois exemplo de requisição e resposta ao endpoint Criar pedido com divisão do pagamento. Um utiliza cartão de crédito como meio de pagamento e o segundo utiliza Boleto.
curl --location --request POST 'https://sandbox.api.pagseguro.com/orders' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '
{
"reference_id": "referencia do pedido",
"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": 10000
}
],
"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 do pagamento",
"description": "descricao do pagamento",
"amount": {
"value": 10000,
"currency": "BRL"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"number": "4111111111111111",
"exp_month": "12",
"exp_year": "2026",
"security_code": "123",
"holder": {
"name": "Jose da Silva",
"tax_id": "65544332211"
},
"store": false
}
},
"splits": {
"method": "FIXED",
"receivers": [
{
"account": {
"id": "ACCO_12345"
},
"amount": {
"value": "6000"
}
},
{
"account": {
"id": "ACCO_67890"
},
"amount": {
"value": "4000"
}
}
]
}
}
]
}'
{
"id": "ORDE_F432482E-DFD1-476E-B5FB-3077B5E3A856",
"reference_id": "referencia do pedido",
"created_at": "2020-11-21T23:12:23.28-03:00",
"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": 10000
}
],
"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_3D4C63B5-B71E-418B-891E-660C79348C65",
"reference_id": "referencia da cobranca",
"status": "PAID",
"created_at": "2020-11-21T23:12:25.114-03:00",
"paid_at": "2020-11-21T23:12:25.737-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": "1606011145716"
},
"payment_method": {
"type": "CREDIT_CARD",
"installments": 1,
"capture": true,
"card": {
"brand": "visa",
"first_digits": "411111",
"last_digits": "1111",
"exp_month": "12",
"exp_year": "2026",
"holder": {
"name": "Jose da Silva",
"tax_id": "65544332211"
}
}
},
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_3D4C63B5-B71E-418B-891E-660C79348C65",
"media": "application/json",
"type": "GET"
},
{
"rel": "CHARGE.CANCEL",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_3D4C63B5-B71E-418B-891E-660C79348C65/cancel",
"media": "application/json",
"type": "POST"
},
{
"rel": "SPLIT",
"href": "https://sandbox.api.pagseguro.com/splits/SPLI_4F0F18DD-184B-4ED1-BCBC-F3A58A3DC7A8",
"media": "application/json",
"type": "GET"
}
]
}
],
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_F432482E-DFD1-476E-B5FB-3077B5E3A856",
"media": "application/json",
"type": "GET"
},
{
"rel": "PAY",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_F432482E-DFD1-476E-B5FB-3077B5E3A856/pay",
"media": "application/json",
"type": "POST"
}
]
}
curl --location 'https://sandbox.api.pagseguro.com/orders' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data-raw '
{
"reference_id": "Referência Pedido",
"items": [
{
"name": "Mouse",
"quantity": 1,
"unit_amount": 24999
}
],
"shipping": {
"address": {
"street": "R. teste",
"number": "988",
"locality": "Bairro",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "12345000"
}
},
"customer": {
"phone": {
"country": 55,
"area": 11,
"number": 988776655,
"type": "CELLPHONE"
},
"name": "Teste da Silva",
"email": "[email protected]",
"tax_id": "12345679891"
},
"notification_urls": [
"https://meusite.com/notificacoes"
],
"charges": [
{
"reference_id": "Referencia Pagamento",
"description": "Motivo do pagamento",
"amount": {
"value": 24999,
"currency": "BRL"
},
"payment_method": {
"type": "BOLETO",
"boleto": {
"due_date": "2023-09-08",
"instruction_lines": {
"line_1": "Pagamento de item 123",
"line_2": "Via PagBank"
},
"holder": {
"name": "Jose da Silva",
"tax_id": "12345679891",
"email": "[email protected]",
"address": {
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"locality": "Pinheiros",
"city": "Sao Paulo",
"region": "Sao Paulo",
"region_code": "SP",
"country": "Brasil",
"postal_code": "01452002"
}
}
}
},
"splits": {
"method": "PERCENTAGE",
"receivers": [
{
"account": {
"id": "ACCO_12345"
},
"amount": {
"value": 22
}
},
{
"account": {
"id": "ACCO_67890"
},
"amount": {
"value": 78
}
}
]
}
}
]
}'
{
"id": "ORDE_A92826A8-4D0C-4645-B889-D6E5FEA2AA3A",
"reference_id": "Referência Pedido",
"created_at": "2023-09-06T11:31:25.006-03:00",
"customer": {
"name": "Teste da Silva",
"email": "[email protected]",
"tax_id": "43934616000142"
},
"items": [
{
"name": "Mouse",
"quantity": 1,
"unit_amount": 24999
}
],
"shipping": {
"address": {
"street": "R. teste",
"number": "988",
"locality": "Bairro",
"city": "São Paulo",
"region_code": "SP",
"country": "BRA",
"postal_code": "12345000"
}
},
"charges": [
{
"id": "CHAR_6FA1BCED-1E5E-4906-8ECB-C60A4135243F",
"reference_id": "Referência Pagamento",
"status": "WAITING",
"created_at": "2023-09-06T11:31:25.114-03:00",
"description": "Motivo do pagamento",
"amount": {
"value": 24999,
"currency": "BRL",
"summary": {
"total": 24999,
"paid": 0,
"refunded": 0
}
},
"payment_response": {
"code": "20000",
"message": "SUCESSO"
},
"payment_method": {
"type": "BOLETO",
"boleto": {
"id": "5F7D42CC-AE6F-46E2-BFFF-58C43066AA90",
"barcode": "03399853012970000024227020901016278150000015630",
"formatted_barcode": "03399.85301 29700.000242 27020.901016 2 78150000015630",
"due_date": "2023-09-08",
"instruction_lines": {
"line_1": "Pagamento processado para DESC Fatura",
"line_2": "Via PagSeguro"
},
"holder": {
"name": "Jose da Silva",
"tax_id": "12345679891",
"email": "[email protected]",
"address": {
"region": "Sao Paulo",
"city": "Sao Paulo",
"postal_code": "01452002",
"street": "Avenida Brigadeiro Faria Lima",
"number": "1384",
"locality": "Pinheiros",
"country": "Brasil",
"region_code": "SP"
}
}
}
},
"links": [
{
"rel": "SELF",
"href": "https://boleto.sandbox.pagseguro.com.br/5f7d42cc-ae6f-46e2-bfff-58c43066aa90.pdf",
"media": "application/pdf",
"type": "GET"
},
{
"rel": "SELF",
"href": "https://boleto.sandbox.pagseguro.com.br/5f7d42cc-ae6f-46e2-bfff-58c43066aa90.png",
"media": "image/png",
"type": "GET"
},
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/charges/CHAR_6FA1BCED-1E5E-4906-8ECB-C60A4135243F",
"media": "application/json",
"type": "GET"
},
{
"rel": "SPLIT",
"href": "https://sandbox.api.pagseguro.com/splits/SPLI_469D48BC-ED56-4886-8256-321772F2D915",
"media": "application/json",
"type": "GET"
}
]
}
],
"notification_urls": [
"https://eoff72c4qocxub0.m.pipedream.net"
],
"links": [
{
"rel": "SELF",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_A92826A8-4D0C-4645-B889-D6E5FEA2AA3A",
"media": "application/json",
"type": "GET"
},
{
"rel": "PAY",
"href": "https://sandbox.api.pagseguro.com/orders/ORDE_A92826A8-4D0C-4645-B889-D6E5FEA2AA3A/pay",
"media": "application/json",
"type": "POST"
}
]
}
Na resposta da requisição você encontra o idjuntamente com o link para realizar consulta sobre o atual status da divisão do pagamento. Essa informação está disponível no parâmetro charges.links, onde você deve selecionar o objeto rel: SPLIT. No link disponibilizado você encontra o id da divisão do pagamento no formato SPLI_XXXXXXXXX.