---
title: "Geração de uma forma de pagamento"
method: POST
path: "/cards/invoices/{statementId}/payment"
tags: ["Pagamento de faturas"]
---

# Geração de uma forma de pagamento

`POST /cards/invoices/{statementId}/payment`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/cards/invoices/{statementId}/payment`
- Auth: HTTP bearer

<div class="bkly-ref-description">
  <p>Gere uma forma de pagamento para uma fatura específica, por meio do seu ID.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: invoice.write</span>
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Geração de uma forma de pagamento](/docs/geracao-forma-pagamento)."
}
[/block]

## Path parameters

- `statementId` integer, required: Identificador único da fatura em aberto. Insira somente números, sem caracteres especiais.

## Headers

- `x-correlation-id` string: Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

## Parameters

- `#/paths/~1cards~1invoices~1adjustments/post/parameters/1` (unresolved $ref)
- `#/paths/~1cards~1invoices~1adjustments/post/parameters/0` (unresolved $ref)
- `#/paths/~1cards~1invoices~1adjustments/post/parameters/4` (unresolved $ref)

## Request body

- CreatePaymentCommand
  - `paymentType` 'Cash' | 'Partial' | 'InstallmentWithEntry' | 'InstallmentWithoutEntry', required: Opção de pagamento.
  - `amount` object: Objeto que deverá conter informações sobre o valor a ser pago. <b>Importante</b>: o envio deste objeto é obrigatório somente se o tipo de pagamento escolhido for “Partial”.
    - `value` number, double: Valor a ser pago.
    - `currency` string: Código da moeda com base na ISO - 4217.
  - `paymentOptionId` integer, nullable: Identificador da opção de pagamento. Este campo é obrigatório somente se o tipo de pagamento escolhido tenha sido <code>InstallmentWithEntry</code>.

## Response `202`

Solicitação aceita com sucesso.

- PaymentStatusDto
  - `status` 'Pending' | 'Paid': Situação do pagamento.
  - `digitableLine` string, nullable: Linha digitável do boleto de pagamento.
  - `authenticationCode` string, nullable: Identificador da forma de pagamento.

## Other responses

- `400` (unresolved $ref)
- `406`: A solicitação não foi aceita.

---

[API](https://skmtc.dev/bankly/apis/gest-o-de-faturas.md) - [All operations](https://skmtc.dev/bankly/apis/gest-o-de-faturas/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/gest-o-de-faturas/revisions/59ad0e112fb8?raw)