Pagar venda em aberto

post

https://gateway-sandbox.cyclopay.com/v1/charges/{charge_uuid}/pay

Pagar uma venda que está em aberto

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Esse método permite pagar vendas em aberto, que possuem valores a pagar, ou seja, que possuem status = PAID_PARTIALLY

Path Params

charge_uuid

string

required

Body Params

payment_method

string

enum

required

Allowed:

amount

int32

transaction_initiator

string

enum

Identificador do iniciador da transação

Allowed:

use_case

string

enum

Identificador do contexto da transação

Allowed:

card

object

payments_supported

array of strings

Opcional. Para payment_method = smartform, lista os meios de pagamento que serão disponibilizados no formulário. Cada item deve corresponder exatamente a um dos valores permitidos. Quando omitido, nenhuma lista de restrição é enviada.

payments_supported

pix

object

Configurações do pagamento quando payment_method = pix-cob ou pix-cobv. Para pix-cob, usar expires; para pix-cobv, usar due_date. O comprador da venda deve possuir documento válido. Os campos de multa, juros e desconto exigem o respectivo valor positivo quando o tipo for informado.

boleto

object

Configurações do pagamento quando payment_method = boleto. A venda deve possuir comprador com documento válido e endereço de cobrança completo. Os campos de multa, juros e desconto exigem o respectivo valor positivo quando o tipo for informado.

Headers

idempotency-key

uuid

Opcional. UUID que identifica a solicitação de pagamento.

Responses

409

Conflito de idempotência: chave reutilizada com payload diferente, solicitação ainda em processamento, solicitação anterior marcada como falha ou resultado indisponível.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400