Payment object

When you want to pay a Payment before, you must create a Source and attach it to the Payment through the authorize resource. If the Source gateway belongs to a payment gateway with single_use usage, it should be paid through the pay resource, while if it belongs to a payment gateway with reusable usage, it will immediately try to charge the credit or debit card of the customer.

Attributes

id

string
Unique identifier of the object.

date

string
A positive number representing the amount to charge.

amount

number
A date equal to or greater than today in yyyy-mm-dd format.

currency

string
Three-letter ISO code for the currency of the payment.

description

string
A description for payment with a max length of 256 characters.

source

object
ID of the source with which the Payment was processed. The Source is attached through the or the , depending on the type of charge required.

payment_date

timestamp
Time at which the Payment was payed in format yyyy-mm-dd hh:mm:ss

customer

object
ID of the Customer this payment belongs to, of one exists.

invoice

object
ID of the Invoice this payment belongs to, of one exists. It will have this attribute when the payment is created from an invoice from the .

status

string
The status of the Source, one of requires_payment_method, processing, succeeded or canceled. The default status when the Payment is created is requires_payment_method.

metadata

object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. All keys can be unset by posting an empty value to metadata.

created

timestamp
Time at which the object was created in format yyyy-mm-dd hh:mm:ss

updated

timestamp
Time at which the object was updated in format yyyy-mm-dd hh:mm:ss

Object sample

{
    "id": "pay_ck6HZUxJR598PZf0uZ",
    "date": "2020-04-28",
    "amount": 12.50,
    "description": "Payment example via API",
    "status": "processing",
    "payment_date": null,
    "metadata": {},
    "created": "2020-04-10T13:48:55.259886-04:00",
    "updated": "2020-04-10T13:48:55.259903-04:00",
    "invoice": null,
    "customer": null,
    "currency": "CLP",
    "source": {
        "id": "sou_NBm22nauWP1YqUuY7G",
        "amount": 12.50,
        "description": null,
        "return_url": null,
        "status": "chargeable",
        "metadata": {},
        "created": "2020-04-10T18:21:02.871850-04:00",
        "updated": "2020-04-10T18:21:07.124700-04:00",
        "customer": null,
        "gateway": "paypal",
        "usage": "single",
        "flow": "redirect",
        "data": {
            "redirect_url": "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-ASLS84461XM815581J"
        }
    }
}