API docs by Redocly

Vitorio Payments API (0.0.1)

Download OpenAPI specification:

Public API for Vitorio payments.

Payment

Create Payment

Create a new Vitorio payment link from information from a third party payment

Authorizations:
Vitorio API Key
Request Body schema: application/json
required
taxIdType
required
string
Enum: "CNPJ" "CPF"

O tipo de documento do cliente final

taxId
required
string

O número do documento do cliente final

paymentType
required
string
Enum: "BOLETO" "PIX" "CREDIT_CARD" "VITORIO_CARD"

Tipo de cobrança. Para Asaas, é o request.billingType enviado a POST /v3/payments.

thirdPartyPaymentId
required
string

ID da cobrança no provedor de pagamentos. Para Asaas, é o response.id retornado por POST /v3/payments

thirdPartyInstallmentId
string

ID do parcelamento no provedor de pagamentos (se a cobrança foi parcelada). Para Asaas, é o response.installment retornado por POST /v3/payments.

thirdPartyInvoiceUrl
required
string

URL da fatura no provedor de pagamentos. Para Asaas, é o response.invoiceUrl retornado por POST /v3/payments.

paymentAmountCents
required
integer <int32>

Valor desta cobrança em centavos. Para Asaas, é o valor de request.value enviado a POST /v3/payments multiplicado por 100.

paymentDueDate
required
string

Data de vencimento desta cobrança (formato YYYY-MM-DD). Para Asaas, é o response.dueDate retornado por POST /v3/payments.

orderAmountCents
integer <int32>

Valor total da compra em centavos. Esse campo só é necessário se a compra tiver sido parcelada. Para Asaas, é o valor de request.totalValue enviado a POST /v3/payments multiplicado por 100.

orderInstallmentCount
integer <int32>

Quantidade de parcelas da compra (se parcelada). Para Asaas, é o valor de request.installmentCount enviado a POST /v3/payments.

object

Detalhes do boleto associado à cobrança. Este objeto só deve ser enviado se, no checkout, a cobrança escolhida pelo cliente foi do tipo BOLETO.

object

Detalhes do Pix da cobrança. Este objeto só deve ser enviado se, no checkout, a cobrança escolhida pelo cliente foi do tipo BOLETO, PIX ou VITORIO_CARD.

object

Informações de multa para pagamento após o vencimento

object

Informações de juros para pagamento após o vencimento

Responses

Request samples

Content type
application/json
Example

Complete example of creating a boleto payment link with boleto and PIX details

{
  • "taxIdType": "CNPJ",
  • "taxId": "12345678000195",
  • "paymentType": "BOLETO",
  • "thirdPartyPaymentId": "pay_613raayijduautxe",
  • "thirdPartyInvoiceUrl": "https://sandbox.asaas.com/i/613rsayijdufutxe",
  • "paymentAmountCents": 100000,
  • "paymentDueDate": "2027-01-01",
  • "boletoDetails": {},
  • "pixDetails": {
    },
  • "fine": {
    },
  • "interest": {
    }
}

Response samples

Content type
application/json
Example

Update Payment

Atualiza o status de uma cobrança existente

Authorizations:
Vitorio API Key
path Parameters
paymentId
required
string
Request Body schema: application/json
required
status
required
string
Enum: "PENDING" "PROCESSING" "AWAITING_CREDIT" "CANCELLED" "DONE" "REFUNDED" "BLOCKED_BY_VALUE_DIVERGENCE"

Responses

Request samples

Content type
application/json

Example of updating a payment status to PENDING

{
  • "status": "PENDING"
}

Response samples

Content type
application/json
{ }