Charges API — Pay Invoice and Charge Link Endpoints

A charge in Nova.Pay represents a single invoice or payment link sent to a specific customer. Unlike a checkout page (which is reusable and public), a charge is a one-time payment request tied to a particular customer and order. Use these endpoints to fetch charge details, monitor payment status, and accept payment programmatically. Base URL: https://pay.nova.money/api/v1

Retrieve a charge

Fetch the full details of a charge, including customer information, products, and attached documents.

GET /charges/{id}

Path parameters

string

required

The Order UID of the charge.

Response

Returns a ChargeShow object.

string

The Order UID for this charge.

gateway

string

Payment gateway handling this charge (e.g. "stripe", "pagarme").

main_color

string

Hex colour code used on the hosted charge payment page.

menus

array

Navigation menu items shown on the hosted page.

page_title

string

Title displayed to the customer on the hosted payment page.

public_key

string

Gateway public key used for client-side card tokenisation.

logo

string

URL of the logo image displayed on the hosted page.

currency

string

ISO 4217 currency code (e.g. "BRL", "USD").

date

string

ISO 8601 date on which the charge was issued.

due_date

string

ISO 8601 due date by which the charge should be paid. Used to calculate interest and fines for late payments.

retention

number

Retention / withholding amount deducted from the charge value.

freight

number

Shipping / freight amount included in the charge.

enable_two_cards

boolean

Whether the customer can split this charge across two credit cards.

observation

string

Free-text note attached to the charge, visible to the customer.

customer

object

Customer to whom the charge is addressed.

Show customer fields

string

Customer email address.

name

string

Customer full name.

foreign

boolean

Whether the customer is a foreign (non-local) entity.

identification

string

CPF, CNPJ, or other national identifier.

Company legal name (for corporate customers).

address

object

Customer address details.

coupon

object

Coupon applied to this charge, if any.

Show coupon fields

code

string

Coupon code string.

discount

number

Discount amount or percentage applied by the coupon.

products

array

Products included in this charge.

Show product fields

integer

Internal product ID.

name

string

Product name.

description

string

Product description.

product_type

string

Product category (e.g. "digital", "physical").

subscription

boolean

Whether the product is a subscription.

quantity

integer

Number of units included in the charge.

value

number

Unit price of the product.

image

string

URL of the product image.

invoices

array

Fiscal invoices (NF-e / NFS-e) attached to this charge.

Show invoice fields

type

string

Invoice type (e.g. "nfe", "nfse").

url

string

Download URL for the invoice document.

files

array

Additional files attached to the charge (e.g. contracts, receipts).

Show file fields

url

string

Download URL for the file.

name

string

File name.

custom_code

string

Arbitrary code snippet injected into the hosted charge page.

default_payment_plan

object

The pre-selected payment plan for this charge.

Get the last payment for a charge

Returns the most recent active or failed payment attempt for a charge. This is useful for polling payment status without needing to manage a list of payment IDs.

GET /charges/{id}/last_payment

Path parameters

string

required

The Order UID of the charge.

Response

Returns a LastPayment object, or HTTP 204 No Content if no payment attempt has been made yet.

Example response

{
  "gateway_id": "pay_xyz789",
  "amount": 100.00,
  "interest": 0,
  "paid_at": null,
  "status": "waiting_payment"
}

gateway_id

string

The payment identifier issued by the gateway.

amount

number

The total amount of the payment attempt.

interest

number

Late-payment interest added to the original charge amount (zero if paid on time or in advance).

paid_at

string | null

ISO 8601 datetime at which the payment was confirmed. null if not yet paid.

status

string

Current payment status. Possible values: waiting_payment, paid, failed, cancelled, pending.

Pay a charge

Submit payment for a charge. You can pay using a credit card, Pix, or bank slip (boleto).

POST /charges/{id}/pay

Path parameters

string

required

The Order UID of the charge to pay.

Request body

payment_plan_id

string

required

The ID of the selected payment plan (e.g. "42-1"). Retrieve available plans from the Payment Plans endpoint.

confirmation_token_id

string

Stripe PaymentMethod confirmation token ID. Required when the gateway is Stripe and the payment method is credit card.

credit_card_0_token

string

Tokenised card data for the primary credit card.

credit_card_0_card_id

string

ID of a saved card on file to use as the primary card.

credit_card_0_payment_plan

string

Payment plan ID for the primary card (used in two-card splits).

credit_card_0_amount

number

Amount charged to the primary card (used in two-card splits).

credit_card_1_token

string

Tokenised card data for the secondary credit card (two-card split).

credit_card_1_card_id

string

ID of a saved card to use as the secondary card.

credit_card_1_payment_plan

string

Payment plan ID for the secondary card.

credit_card_1_amount

number

Amount charged to the secondary card.

observation

string

Free-text note to attach to this specific payment attempt.

Response

Returns a ChargePayResult object. Only the fields relevant to the chosen payment method are included.

The response shape differs by payment method. Always check which fields are present before accessing them.

status

string

The resulting payment status for credit card payments. Possible values:

Value	Description
`pending`	Payment is being processed.
`waiting_payment`	Awaiting payment confirmation from the gateway.
`paid`	Payment confirmed.
`cancelled`	Payment was cancelled.
`failed`	Payment attempt failed.
`waiting_cancellation`	Cancellation has been requested and is pending.

bank_slip_url

string

URL of the generated boleto PDF. Present only for bank_slip payments.

pix_qr_code

string

Base64-encoded Pix QR code image. Present only for pix payments.

pix_qr_code_url

string

URL to the Pix QR code image. Present only for pix payments.

pix_expires_at

string

ISO 8601 datetime when the Pix QR code expires. Present only for pix payments.

redirect_url

string

URL to redirect the customer to after payment (e.g. a confirmation or thank-you page).

Checkout

Payments

Management

Webhooks

Charges API — Pay Invoice and Charge Link Endpoints

Retrieve a charge

Path parameters

Response

Get the last payment for a charge

Path parameters

Response

Pay a charge

Path parameters

Request body

Response

​Retrieve a charge

​Path parameters

​Response

​Get the last payment for a charge

​Path parameters

​Response

​Pay a charge

​Path parameters

​Request body

​Response

Retrieve a charge

Path parameters

Response

Get the last payment for a charge

Path parameters

Response

Pay a charge

Path parameters

Request body

Response