Payments

A "Payment" represents a purchase that was financed. All payments must start with a Payment Request.

Endpoints

List Payments - Fetch a list of all payments

Get Payment - Fetch a single payment

Upload Invoices - Upload and submit invoices as part of the authorization step

Payment Object

Attribute	Type	Description
id	string	Id for the payment
status	string	Status of the payment. See payment statuses.
currency	string	Currency of the payment
orderId	string	An ID unique to your system to identify the order (set in Payment Request)
orderDescription	string	Description of the order (set in Payment Request)
meta	object	object sent as parameter meta on Payment Request
customerId	string	ID of the customer that created the payment
customer.id	string	ID of the customer that created the payment
customer.legalName	string	Name of the customer that created the payment
customer.cnpj	string	CNPJ of the customer that created the payment
amount	number	Payment's amount in cents (R$ 1.000,99 is represented as 100099)
merchantSubsidyAmount	number	Value of merchant subsidy in cents (automatically calculated if merchantSubsidyRate is provided)
merchantSubsidyRate	number	Rate of merchant subsidy (automatically calculated if merchantSubsidyAmount is provided) (in decimal - ex. 0.02 = 2%)
merchantTotalAmount	number	Amount that will be paid to merchant (amount - merchantFeeAmount)
paymentType	string	How the payment to the merchant is made. Currently always "bank_transfer".
invoiceStatus	string	Status of the invoice related to the payment. Can be one of "awaiting", "submitted" or "completed"
monthsUntilFirstPayment	number	Number of months allowed from the date of the financing to when the first installment is due
firstInstallmentDate	date	Date when first installment is due
paymentMeta.lenderPaidAt	date	Date that payment to merchant was made
merchantRecourseRate	number	Recourse rate covered by merchant (if applies to merchant account)
createdAt	date	Date that payment was created
updatedAt	date	Date of the last modification in the payment's data

Payment.status

Status	Description
initialized	Payment was started by the client, but additional action is required
authorized	Payment was completed by the client and is ready for merchant action
captured	Payment is being disbursed (invoice was uploaded by merchant and approved by Finove)
settled	Payment was disbursed to the merchant
canceled	Payment was canceled