--- title: "Pagar pedido" method: POST path: "/orders/{order_id}/pay" --- # Pagar pedido `POST /orders/{order_id}/pay` ## Path parameters - `order_id` string, required ## Headers - `Authorization` string, required ## Request body - object - `charges` object[] — Contêm as informações necessárias para a execução da cobrança, definindo os dados do meio de pagamento e o valor do pedido. - `reference_id` string — Identificador único atribuído para a cobrança. - `description` string — Descrição da cobrança. - `amount` object — Especifica a quantia da cobrança, com o valor e moeda. - `value` integer — Valor a ser cobrado em centavos. Apenas números inteiros positivos.
Exemplo: R$ 1.500,99 = 150099 - `currency` string — Código de moeda ISO de três letras, em maiúsculo. Por enquanto, apenas o Real brasileiro é suportado (BRL). - `payment_method` object — Contém as informações do método de pagamento da cobrança. - `type` 'CREDIT_CARD' | 'DEBIT_CARD' | 'BOLETO' — Indica o método de pagamento usado na cobrança.
- `CREDIT_CARD` para Cartão de Crédito ou `DEBIT_CARD` para Cartão de Débito. ⚠️ **Obrigatório o envio do objeto `card`.** ⚠️
- `BOLETO` para Boleto. ⚠️ **Obrigatório o envio do objeto `boleto` com as informações adicionais desse objeto.** ⚠️ - `installments` integer — Quantidade de parcelas. ⚠️ **Obrigatório para o método de pagamento Cartão de Crédito.** ⚠️ - `capture` boolean — Parâmetro que indica se uma transação de cartão de crédito deve ser apenas pré-autorizada (reserva o valor da cobrança no cartão do cliente de 6 até 29 dias) ou se a transação deve ser capturada automaticamente (cobrança realizada em apenas um passo). ⚠️ **Obrigatório para o método de pagamento cartão de crédito.** ⚠️ ⚠️ **Função indisponível para o método de pagamento cartão de débito e token de bandeira (crédito).** ⚠️
- `VISA`,`MASTERCARD` e `ELO` permitirá à captura com cartão de crédito e token de bandeira em até 29 dias(Lista de MCCs disponíveis).
- `AMEX` e `HIPERCARD` permitirá à captura apenas com o cartão de crédito e em até 6 dias.

- Informar `false` para pré-autorizar. Informar `true` para cobrança em um passo. - `soft_descriptor` string — Parâmetro responsável pelo que será exibido como **Nome na Fatura do cliente**. ⚠️ **Aplicável no momento apenas para Cartão de crédito** ⚠️ ⚠️ **Não permite caracteres especiais. Acentuações serão substituídas por caracteres sem acentos, demais caracteres especiais serão removidos.** ⚠️ - `card` object — Objeto contendo os dados de Cartão de Crédito, Cartão de Débito ou Token de Bandeira. ⚠️ **Obrigatório para o método de pagamento Cartão de Crédito, Cartão de Débito ou Token de Bandeira.** ⚠️ - `id` string — Identificador PagBank do Cartão de Crédito salvo (Cartão Tokenizado pelo PagBank). ⚠️ **Função indisponível para o método de pagamento com Cartão de Débito e Token de Bandeira.** ⚠️ - `encrypted` string — Criptograma do cartão criptografado. - `number` string — Número do Cartão de Crédito ou Cartão de Débito. - `network_token` string — Número do Token de Bandeira. - `exp_month` integer, required — Mês de expiração do Cartão de Crédito, Cartão de Débito ou Token de Bandeira. - `exp_year` integer, required — Ano de expiração do Cartão de Crédito, Cartão de Débito ou Token de Bandeira. - `security_code` string — Código de Segurança do Cartão de Crédito, Cartão de Débito ou Token de Bandeira. - `store` boolean — Indica se o cartão deverá ser armazenado no PagBank para futuras compras. ⚠️ **Função indisponível para o método de pagamento com Cartão de Débito e Token de Bandeira.** ⚠️
- Informar `false` ou omitir esse parâmetro fará com que o cartão não seja armazenado. Informar `true` fará com que o cartão seja armazenado. Na resposta da requisição irá receber o token do cartão em `payment_method.card.id`. - `holder` object — Contém as informações do portador do Cartão de Crédito, Cartão de Débito e Token de Bandeira. - `name` string — Nome do portador do Cartão de Crédito, Cartão de Débito e Token de Bandeira. ⚠️ **Obrigatório para cobranças com 3DS e Criptografia** ⚠️ - `tax_id` string — Documento de identificação (CPF) do portador do Cartão de Crédito, Cartão de Débito e Token de Bandeira. - `token_data` object — Objeto contendo os dados adicionais de Tokenização de Bandeira. ⚠️ **Deve ser enviado quando um Cartão de Crédito ou Débito Tokenizado pelas bandeiras Visa ou Mastercard é utilizado.** ⚠️ - `requestor_id` string — Identificador de quem gerou o Token de Bandeira (Token Requestor). - `wallet` 'APPLE_PAY' | 'GOOGLE_PAY' | 'SAMSUNG_PAY' | 'MERCHANT_TOKENIZATION_PROGRAM' — Tipo de carteira que armazenou o Token de Bandeira. - `cryptogram` string, required — Criptograma gerado pela bandeira. - `ecommerce_domain` string — Identificador do domínio de origem da transação, comumente caracterizado em um formato de domínio reverso.
Exemplo: `br.com.pagseguro` - `assurance_level` integer — Conteúdo que indica o nível de confiança do Token de Bandeira. - `authentication_method` object — Objeto contendo os dados adicionais de autenticação vínculados à uma transação. ⚠️ **Obrigatório para o método de pagamento com cartão de débito.** ⚠️ - `type` 'THREEDS' | 'INAPP' — Indica o método de autenticação utilizado na cobrança. ⚠️ **Condicional para Token de Bandeira ELO.** ⚠️
- `THREEDS` se o método de autenticação utilizado for 3DS.
- `INAPP` se o método de autenticação utilizado for InApp. - `id` string — Identificador do método de autenticação utilizado. - `cavv` string — Identificador único gerado em cenário de sucesso de autenticação do cliente. - `eci` string, required — Indicador E-Commerce retornado quando ocorre uma autenticação. Corresponde ao resultado da autenticação. - `xid` string — Identificador de uma transação de um MPI - Recomendado para a bandeira `VISA`. ⚠️ **Condicional para 3DS.** ⚠️ - `version` string — Versão do protocolo 3DS utilizado na autenticação. - `dstrans_id` string — ID da transação gerada pelo servidor de diretório durante uma autenticação - Recomendado para a bandeira `MASTERCARD`. ⚠️ **Condicional para 3DS.** ⚠️ - `boleto` object — Objeto contendo os dados para geração do boleto. ⚠️ **Obrigatório para o método de pagamento com Boleto Bancário.** ⚠️ - `due_date` string — Data de vencimento do Boleto. Formato: `YYYY-MM-DD` - `instruction_lines` object — Objeto contendo as linhas de instrução do Boleto. - `line_1` string — Primeira linha de instruções sobre o pagamento do Boleto. - `line_2` string — Segunda linha de instruções sobre o pagamento do Boleto. - `holder` object — Objeto contendo as informações do responsável pelo pagamento do Boleto. - `name` string — Nome do responsável pelo pagamento do Boleto. - `tax_id` string — Número do documento do responsável pelo pagamento do Boleto.
- CPF (11 caracteres).
- CNPJ (14 caracteres). - `email` string — E-mail do responsável pelo pagamento do Boleto. - `address` object — Objeto contendo as informações de endereço do responsável pelo pagamento do Boleto. - `street` string, required — Rua do endereço. - `number` string, required — Número do endereço. - `locality` string, required — Bairro do endereço. - `city` string, required — Cidade do endereço. - `region` string, required — Estado do endereço - `region_code` string, required — Código do Estado do endereço ([Padrão ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `country` string, required — País do endereço ([Padrão ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)). - `postal_code` string, required — CEP do endereço. - `notification_urls` string — URLs que serão notificadas em toda alteração ocorrida na cobrança. ⚠️ **Necessário que seja em ambiente seguro com SSL (HTTPS)** ⚠️ - `splits` object — Objeto contendo as contas e os valores a serem pagos para transações com divisão do pagamento.⚠️ **Exclusivo para divisão de pagamentos.** ⚠️ - `method` 'FIXED' | 'PERCENTAGE' — Especifíca como a divisão do pagamento será realizada. Essa divisão pode ser definida como:
-`FIXED`: deve ser informado os valores monetários, espeficiando o montante a ser transferido para cada conta.
- `PERCENTAGE`: deve ser informado o percentual do montante total a ser repassado para cada conta. - `receivers` object[] — Especifica as contas que receberão partes distintas do pagamento e define os valores ou percentuais a serem transferidos para cada uma delas. - `id` string — Identificador único da conta do recebedor. - `value` integer — Define o valor ou percentual a ser atribuído a cada recebedor.
- `FIXED`: informe os valores em centavos, garantindo que a soma desses valores seja igual ao total da transação.
- `PERCENTAGE`: informe valores inteiros sem casas decimais, assegurando que a soma totalize 100%. ## Response `201` 201 - union - object - `id` string - `reference_id` string - `created_at` string - `shipping` object - `address` object - `street` string - `number` string - `complement` string - `locality` string - `city` string - `region` string - `region_code` string - `country` string - `postal_code` string - `items` object[] - `reference_id` string - `name` string - `quantity` integer - `unit_amount` integer - `dimensions` object - `length` integer - `width` integer - `height` integer - `weight` integer - `customer` object - `name` string - `email` string - `tax_id` string - `phones` object[] - `country` string - `area` string - `number` string - `type` string - `charges` object[] - `id` string - `reference_id` string - `status` string - `created_at` string - `paid_at` string - `description` string - `amount` object - `value` integer - `currency` string - `summary` object - `total` integer - `paid` integer - `refunded` integer - `payment_response` object - `code` string - `message` string - `reference` string - `payment_method` object - `type` string - `installments` integer - `capture` boolean - `card` object - `brand` string - `first_digits` string - `last_digits` string - `exp_month` string - `exp_year` string - `holder` object - `name` string - `tax_id` string - `links` object[] - `rel` string - `href` string - `media` string - `type` string - `metadata` object - `Key` string - `qr_code` object[] - `id` string - `amount` object - `value` integer - `text` string - `links` object[] - `rel` string - `href` string - `media` string - `type` string - `links` object[] - `rel` string - `href` string - `media` string - `type` string - object - `id` string - `reference_id` string - `status` string - `created_at` string - `description` string - `amount` object - `value` integer - `currency` string - `summary` object - `total` integer - `paid` integer - `refunded` integer - `payment_response` object - `code` string - `message` string - `payment_method` object - `type` string - `boleto` object - `id` string - `barcode` string - `formatted_barcode` string - `due_date` string - `instruction_lines` object - `line_1` string - `line_2` string - `holder` object - `name` string - `tax_id` string - `email` string - `address` object - `region` string - `city` string - `postal_code` string - `street` string - `number` string - `locality` string - `country` string - `region_code` string - `links` object[] - `rel` string - `href` string - `media` string - `type` string ## Other responses - `400` — 400 --- [API](https://skmtc.net/pagbank/apis/nova-plataforma-sandbox.md) · [All operations](https://skmtc.net/pagbank/apis/nova-plataforma-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pagbank/nova-plataforma-sandbox/versions/05e64f3006ab/schema)