A Payment resource is an attempt by your customer to send you money in exchange for your product. This is a reference to an amount that you are expecting to receive if a payment resource with paid status becomes a part of a payout. If the payment status is failed, you can determine the reason for failure.

A Payment Resource

{
            "id": "pay_a1nn2DXxeooJ9JqQfj7ytxfe",
            "type": "payment",
            "attributes": {
                "amount": 10000,
                "billing": {
                    "address": {
                        "city": "Furview",
                        "country": "PH",
                        "line1": "111",
                        "line2": "Wanchan St",
                        "postal_code": "11111",
                        "state": "Metro Manila"
                    },
                    "email": "[email protected]",
                    "name": "Zooey Doge",
                    "phone": "111-111-1111"
                },
                "currency": "PHP",
                "description": "Payment 1",
                "fee": 1850,
                "livemode": false,
                "net_amount": 8150,
                "payout": null,
                "source": {
                    "id": "tok_X925Gje9FzRxfZCiBzNaSCbE",
                    "type": "token"
                },
                "statement_descriptor": null,
                "status": "paid",
                "created_at": 1586093053,
                "paid_at": 1586093053,
                "updated_at": 1586093053
            }
        }

id string
Unique ID of the resource.


type string
Represents the resource type. Value is always payment.


amount integer
amount of the Payment. A positive integer with minimum amount of 10000. 10000 is the smallest unit in cents. If you want to receive an amount of 100.00, the value that you should pass is 10000. If you want to receive an amount of 1500.50, the value that you should pass is 150050. The amount is also considered as the gross amount.


billing dictionary

Attribute

Description

address.city string

City of the billing address information

address.country string

Country of the billing address information. Possible values are ISO 3166-1 alpha-2 codes or two-letter country codes..

address.line1 string

Line1 of the billing address information

address.line2 string

Line2 of the billing address information

address.postal_code string

Postal Code of the billing address information

address.state string

State of the billing address information

email string

E-mail address of the billing information.

name string

Name of the billing information.

phone string

Phone of the billing information.


currency string
Three-letter ISO currency code, in uppercase. PHP is the only supported currency as of the moment.


description string
Description of the payment.


fee integer
The PayMongo processing fee of the payment. A positive integer that is represented in cents. If the fee is 1500.50, the cent representation is 150050.


livemode boolean
The value is true if the resource exists in live mode or the value is false if the resource exists in test mode.


net_amount integer
The final amount that you will receive after PaytMongo deducted the fee. A positive integer that is represented in cents. If the net_amount is 1500.50, the cent representation is 150050.


payout dictionary
The Payout of the Payment resource. The value is null if the Payment is not yet a part of a Payout. If the Payout exists for the Payment, this means you will receive the net_amount of the Payment and this is sent to your nominated bank account. You may check the payout information for the status.


source dictionary
The payment method instrument used to create a payment.

Attribute

Description

id string

The id of the Source used to create the Payment.

type string

The type of the Source used to create the Payment. Possible values are source and token.


statement_descriptor string
You can use this value as the complete description that appears on your customers’ statements. Your account's business name is the default value if not passed.


status string
Status of the payment. Possible values are pending, failed and paid.


created_at


paid_at


updated_at