# Payment

Extends \MercadoPago\Entity

This class provides the methods to access the API that will allow you to create your own payment experience on your website.

From basic to advanced configurations, you control the whole experience.

link | Click here for more infos
RestMethod | (resource="/v1/payments", method="create")
RestMethod | (resource="/v1/payments/:id", method="read")
RestMethod | (resource="/v1/payments/search", method="search")
RestMethod | (resource="/v1/payments/:id", method="update")
RestMethod | (resource="/v1/payments/:id/refunds", method="refund")
package | Default

### Methods

## capture

    capture(integer $amount) : \MercadoPago\Payment

Throws |

\Exception

### Arguments

#### $amount

`integer`

### Response

`\MercadoPago\Payment`

## refund

    refund(integer $amount) : boolean

Throws |

\Exception

### Arguments

#### $amount

`integer`

### Response

`boolean`

### Properties

## id

    id : integer

var |
Attribute | (primaryKey = true)

### Type(s)

`integer`

## acquirer

    acquirer : string

var |
Attribute | ()

### Type(s)

`string`

## acquirer_reconciliation

    acquirer_reconciliation : string

var |
Attribute | ()

### Type(s)

`string`

## site_id

    site_id : string

var |
Attribute | (idempotency = true)

### Type(s)

`string`

## sponsor_id

    sponsor_id : integer

var |
Attribute | ()

### Type(s)

`integer`

## operation_type

    operation_type : string

var |
Attribute | ()

### Type(s)

`string`

## order_id

    order_id : integer

var |
Attribute | (idempotency = true)

### Type(s)

`integer`

## order

    order : integer

var |
Attribute | ()

### Type(s)

`integer`

## binary_mode

    binary_mode : boolean

var |
Attribute | ()

### Type(s)

`boolean`

## external_reference

    external_reference : string

var |
Attribute | ()

### Type(s)

`string`

## status

    status : string

var |
Attribute | ()

### Type(s)

`string`

## status_detail

    status_detail : string

var |
Attribute | ()

### Type(s)

`string`

## store_id

    store_id : integer

var |
Attribute | ()

### Type(s)

`integer`

## taxes_amount

    taxes_amount : float

var |
Attribute | ()

### Type(s)

`float`

## payment_type

    payment_type : string

var |
Attribute | (type = "string")

### Type(s)

`string`

## date_created

    date_created : \DateTime

var |
Attribute | ()

### Type(s)

`\DateTime`

## last_modified

    last_modified : \DateTime

var |
Attribute | ()

### Type(s)

`\DateTime`

## live_mode

    live_mode : boolean

var |
Attribute | ()

### Type(s)

`boolean`

## date_last_update

    date_last_updated : \DateTime

var |
Attribute | ()

### Type(s)

`\DateTime`

## date_of_expiration

    date_of_expiration : \DateTime

var |
Attribute | ()

### Type(s)

`\DateTime`

## deduction_schema

    deduction_schema : string

var |
Attribute | ()

### Type(s)

`string`

## date_approved

    date_approved : \DateTime

var |
Attribute | ()

### Type(s)

`\DateTime`

## money_release_date

    money_release_date : \DateTime

var |
Attribute | ()

### Type(s)

`\DateTime`

## money_release_schema

    money_release_schema : string

var |
Attribute | ()

### Type(s)

`string`

## currency_id

    currency_id : string

var |
Attribute | ()

### Type(s)

`string`

## transaction_amount

    transaction_amount : float

var |
Attribute | (type = "float")

### Type(s)

`float`

## transaction_amount_refunded

    transaction_amount_refunded : float

var |
Attribute | (type = "float")

### Type(s)

`float`

## shipping_cost

    shipping_cost : float

var |
Attribute | ()

### Type(s)

`float`

## total_paid_amount

    total_paid_amount : float

var |
Attribute | (idempotency = true)

### Type(s)

`float`

## finance_charge

    finance_charge : float

var |
Attribute | (type = "float")

### Type(s)

`float`

## net_received_amount

    net_received_amount : float

var |
Attribute | ()

### Type(s)

`float`

## marketplace

    marketplace : string

var |
Attribute | ()

### Type(s)

`string`

## marketplace_fee

    marketplace_fee : float

var |
Attribute | (type = "float")

### Type(s)

`float`

## reason

    reason : string

var |
Attribute | ()

### Type(s)

`string`

## payer

    payer : object

var |
Attribute | ()

### Type(s)

`object`

## collector

    collector : object

var |
Attribute | ()

### Type(s)

`object`

## collector_id

    collector_id : integer

var |
Attribute | ()

### Type(s)

`integer`

## counter_currency

    counter_currency : string

var |
Attribute | ()

### Type(s)

`string`

## payment_method_id

    payment_method_id : string

var |
Attribute | ()

### Type(s)

`string`

## payment_type_id

    payment_type_id : string

var |
Attribute | ()

### Type(s)

`string`

## pos_id

    pos_id : string

var |
Attribute | ()

### Type(s)

`string`

## transaction_details

    transaction_details : object

var |
Attribute | ()

### Type(s)

`object`

## fee_details

    fee_details : object

var |
Attribute | ()

### Type(s)

`object`

## differential_pricing_id

    differential_pricing_id : integer

var |
Attribute | ()

### Type(s)

`integer`

## application_fee

    application_fee : float

var |
Attribute | ()

### Type(s)

`float`

## authorization_code

    authorization_code : string

var |
Attribute | ()

### Type(s)

`string`

## capture

    capture : boolean

var |
Attribute | ()

### Type(s)

`boolean`

## captured

    captured : boolean

var |
Attribute | ()

### Type(s)

`boolean`

## card

    card : integer

var |
Attribute | ()

### Type(s)

`integer`

## call_for_authorize_id

    call_for_authorize_id : string

var |
Attribute | ()

### Type(s)

`string`

## statement_descriptor

    statement_descriptor : string

var |
Attribute | ()

### Type(s)

`string`

## refunds

    refunds : object

var |
Attribute | ()

### Type(s)

`object`

## Shipping_amount

    shipping_amount : float

var |
Attribute | ()

### Type(s)

`float`

## additional_info

    additional_info : array

var |
Attribute | ()

### Type(s)

`array`

## campaign_id

    campaign_id : string

var |
Attribute | ()

### Type(s)

`string`

## coupon_amount

    coupon_amount : float

var |
Attribute | ()

### Type(s)

`float`

## installments

    installments : integer

var |
Attribute | (type = "int")

### Type(s)

`integer`

## token

    token : string

var |
Attribute | ()

### Type(s)

`string`

## description

    description : string

var |
Attribute | ()

### Type(s)

`string`

## notification_url

    notification_url : string

var |
Attribute | ()

### Type(s)

`string`

## issuer_id

    issuer_id : string

var |
Attribute | ()

### Type(s)

`string`

## processing_mode

    processing_mode : string

var |
Attribute | ()

### Type(s)

`string`

## merchant_account_id

    merchant_account_id : integer

var |
Attribute | ()

### Type(s)

`integer`

## merchant_number

    merchant_number : integer

var |
Attribute | ()

### Type(s)

`integer`

## metadata

    metadata : object

var |
Attribute | ()

### Type(s)

`object`

## callback_url

    callback_url : string

var |
Attribute | ()

### Type(s)

`string`

## amount_refunded

    amount_refunded : float

var |
Attribute | ()

### Type(s)

`float`

## coupon_code

    coupon_code : string

var |
Attribute | ()

### Type(s)

`string`

## barcode

    barcode : string

var |
Attribute | ()

### Type(s)

`string`

## marketplace_owner

    marketplace_owner : integer

var |
Attribute | ()

### Type(s)

`integer`

## integrator_id

    integrator_id : string

var |
Attribute | ()

### Type(s)

`string`

## corporation_id

    corporation_id : string

var |
Attribute | ()

### Type(s)

`string`

## platform_id

    platform_id : string

var |
Attribute | ()

### Type(s)

`string`

## charges details

    charges_details : object

var |
Attribute | ()

### Type(s)

`object`

## taxes

    taxes : array

Attribute | (type = "array")
var |

### Type(s)

`array`

## net_amount

    net_amount : float

var |
Attribute | (type = "float")

### Type(s)

`float`