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 |
capture(integer $amount) : \MercadoPago\Payment
refund(integer $amount) : boolean
| Throws |
|
|---|
integer
boolean
id : integer
| var | |
|---|---|
| Attribute |
(primaryKey = true) |
integer
acquirer : string
| var | |
|---|---|
| Attribute |
() |
string
acquirer_reconciliation : string
| var | |
|---|---|
| Attribute |
() |
string
site_id : string
| var | |
|---|---|
| Attribute |
(idempotency = true) |
string
sponsor_id : integer
| var | |
|---|---|
| Attribute |
() |
integer
operation_type : string
| var | |
|---|---|
| Attribute |
() |
string
order_id : integer
| var | |
|---|---|
| Attribute |
(idempotency = true) |
integer
order : integer
| var | |
|---|---|
| Attribute |
() |
integer
binary_mode : boolean
| var | |
|---|---|
| Attribute |
() |
boolean
external_reference : string
| var | |
|---|---|
| Attribute |
() |
string
status : string
| var | |
|---|---|
| Attribute |
() |
string
status_detail : string
| var | |
|---|---|
| Attribute |
() |
string
store_id : integer
| var | |
|---|---|
| Attribute |
() |
integer
taxes_amount : float
| var | |
|---|---|
| Attribute |
() |
float
payment_type : string
| var | |
|---|---|
| Attribute |
(type = "string") |
string
date_created : \DateTime
| var | |
|---|---|
| Attribute |
() |
\DateTime
last_modified : \DateTime
| var | |
|---|---|
| Attribute |
() |
\DateTime
live_mode : boolean
| var | |
|---|---|
| Attribute |
() |
boolean
date_last_updated : \DateTime
| var | |
|---|---|
| Attribute |
() |
\DateTime
date_of_expiration : \DateTime
| var | |
|---|---|
| Attribute |
() |
\DateTime
deduction_schema : string
| var | |
|---|---|
| Attribute |
() |
string
date_approved : \DateTime
| var | |
|---|---|
| Attribute |
() |
\DateTime
money_release_date : \DateTime
| var | |
|---|---|
| Attribute |
() |
\DateTime
money_release_schema : string
| var | |
|---|---|
| Attribute |
() |
string
currency_id : string
| var | |
|---|---|
| Attribute |
() |
string
transaction_amount : float
| var | |
|---|---|
| Attribute |
(type = "float") |
float
transaction_amount_refunded : float
| var | |
|---|---|
| Attribute |
(type = "float") |
float
shipping_cost : float
| var | |
|---|---|
| Attribute |
() |
float
total_paid_amount : float
| var | |
|---|---|
| Attribute |
(idempotency = true) |
float
finance_charge : float
| var | |
|---|---|
| Attribute |
(type = "float") |
float
net_received_amount : float
| var | |
|---|---|
| Attribute |
() |
float
marketplace : string
| var | |
|---|---|
| Attribute |
() |
string
marketplace_fee : float
| var | |
|---|---|
| Attribute |
(type = "float") |
float
reason : string
| var | |
|---|---|
| Attribute |
() |
string
payer : object
| var | |
|---|---|
| Attribute |
() |
object
collector : object
| var | |
|---|---|
| Attribute |
() |
object
collector_id : integer
| var | |
|---|---|
| Attribute |
() |
integer
counter_currency : string
| var | |
|---|---|
| Attribute |
() |
string
payment_method_id : string
| var | |
|---|---|
| Attribute |
() |
string
payment_type_id : string
| var | |
|---|---|
| Attribute |
() |
string
pos_id : string
| var | |
|---|---|
| Attribute |
() |
string
transaction_details : object
| var | |
|---|---|
| Attribute |
() |
object
fee_details : object
| var | |
|---|---|
| Attribute |
() |
object
differential_pricing_id : integer
| var | |
|---|---|
| Attribute |
() |
integer
application_fee : float
| var | |
|---|---|
| Attribute |
() |
float
capture : boolean
| var | |
|---|---|
| Attribute |
() |
boolean
captured : boolean
| var | |
|---|---|
| Attribute |
() |
boolean
card : integer
| var | |
|---|---|
| Attribute |
() |
integer
statement_descriptor : string
| var | |
|---|---|
| Attribute |
() |
string
refunds : object
| var | |
|---|---|
| Attribute |
() |
object
shipping_amount : float
| var | |
|---|---|
| Attribute |
() |
float
additional_info : array
| var | |
|---|---|
| Attribute |
() |
array
campaign_id : string
| var | |
|---|---|
| Attribute |
() |
string
coupon_amount : float
| var | |
|---|---|
| Attribute |
() |
float
installments : integer
| var | |
|---|---|
| Attribute |
(type = "int") |
integer
token : string
| var | |
|---|---|
| Attribute |
() |
string
description : string
| var | |
|---|---|
| Attribute |
() |
string
notification_url : string
| var | |
|---|---|
| Attribute |
() |
string
issuer_id : string
| var | |
|---|---|
| Attribute |
() |
string
processing_mode : string
| var | |
|---|---|
| Attribute |
() |
string
merchant_account_id : integer
| var | |
|---|---|
| Attribute |
() |
integer
merchant_number : integer
| var | |
|---|---|
| Attribute |
() |
integer
callback_url : string
| var | |
|---|---|
| Attribute |
() |
string
amount_refunded : float
| var | |
|---|---|
| Attribute |
() |
float
coupon_code : string
| var | |
|---|---|
| Attribute |
() |
string
marketplace_owner : integer
| var | |
|---|---|
| Attribute |
() |
integer
integrator_id : string
| var | |
|---|---|
| Attribute |
() |
string
corporation_id : string
| var | |
|---|---|
| Attribute |
() |
string
platform_id : string
| var | |
|---|---|
| Attribute |
() |
string
charges_details : object
| var | |
|---|---|
| Attribute |
() |
object
taxes : array
| Attribute |
(type = "array") |
|---|---|
| var |
array
net_amount : float
| var | |
|---|---|
| Attribute |
(type = "float") |
float