Overview
Every time a customer pays an invoice, order, or payment link, a payment is created.
A payment can also be created manually. That means you are charging a customer's payment method manually. The customer will receive a notification of payment. You can also manually forward the customer a receipt.
Properties of a Payment Object
id(String): Payment ID.description(String): Payment description.paidDate(String): Date and time when the payment was made.paymentDate(String): Date and time when the payment is due.createdDate(String): Date and time when the payment object was created.paymentMethodId(String): Payment method ID.paymentMethodType(String): Payment method type.statementDescriptor(String): Description of the payment to be displayed in the bank statement.installments(String): Number of installmets.metadata(Array): Custom properties stored as key-value pairs.currency(Object): An object describing the currency.paymentGatewayCurrency(Object): An object describing the payment gateway currency.customerEmail(String): Customer email.customerName(String): Customer name.customerId(String): Customer ID.customerIsDeleted(Boolean): If True, the customer object has been maked as deleted.status(String): Payment status.grossAmount(String): Payment gross amount.netAmount(String): Payment net amount.feeAmount(String): Fee amount.refundAmount(String): Refund amount.paymentGatewayGrossAmount(Number): Payment gateway gross amount.paymentGatewayExchangeRate(Number): Payment gateway exchange rate.paymentLinks(Object): Object contining the properties of the payment link, if any.paymentGatewayErrorMessage(String): Payment gateway error message.receiptNumber(String): Recept number.invoiceId(String): Invoice ID.pixQrCodeText(String): PIX QR Code text.