API Reference

Source object

Source object represent your customer's payment method or instrument. Those are used with Payments API to pay a payment or related to Customer object to be used as a reusable payment instrument.

Attributes


id

string
Unique object's identifier.


customer

string
ID of the Customer to which this Source was related.


gateway

choice
The payment gateway that the Source represents. Possible choice values paypal webpay khipu oneclick


amount

float
A float number in the currency unit, this is 10.5 USD or 10000 CLP. This is the amount for which the source will be chargeable once ready. Required for single_use gateway.


status

string
The status of the Source, one of failed, pending, consumed, chargeable or finalized . For a gateway with single_use usage only chargeable sources can be used to pay a payment.


description

string
A short Source's description. Its max length is 256.


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": "sou_Ut4GSx94Xh4PlS21",
    "customer": {
        "id": "cus_Ut4GSx94Xh4PlS21",
        "name": "Acme Ventures LLC",
        "address": "",
        "state": {
            "id": "21222",
            "name": "Illinois",
            "country": {
                "id": "US"
                "name": "United States"
            }
        }
    },
    "gateway": "paypal",
    "amount": null,
    "return_url": null,
    "method_data": null,
    "description": "Invoice payment No. 3",
    "status": "chargeable",
    "created": "2020-08-03 12:54:16",
    "updated": "2020-08-03 12:54:16"
}