Payment
Attributes
AttributeTypeDescription
id
Long
Payment identifier.
date_created
Date(ISO_8601)
Payment’s creation date.
date_approved
Date(ISO_8601)
Payment’s approval date.
date_last_updated
Date(ISO_8601)
Last modified date.
money_release_date
Date(ISO_8601)
Release date of payment.
collector_id
Integer
Identifies the seller.
operation_type
String
Payment type.
regular_payment
Typification by default of a purchase being paid using Mercado Pago.
money_transfer
Funds transfer between two users.
recurring_payment
Automatic recurring payment due to an active user subscription.
account_fund
Money income in the user's account.
payment_addition
Addition of money to an existing payment, done in Mercado Pago's site.
cellphone_recharge
Recharge of a user's cellphone account.
pos_payment
Payment done through a Point Of Sale.
payer
Object
Identifies the buyer.
entity_type
String
Entity type of the payer (only for bank transfers).
individual
Payer is individual.
association
Payer is an association.
type
String
Identification type of the associated payer (mandatory if the Payer is a Customer).
customer
Payer is a Customer and belongs to the collector.
registered
The account corresponds to a Mercado Pago registered user.
guest
The payer doesn't have an account.
id
String
Identification of the associated payer.
email
String
Email. (Required)
identification
Object
Personal identification.
type
String
Identification type.
number
String
Identification number.
phone
Object
Phone of the associated payer.
area_code
String
Phone area code.
number
String
Phone number.
extension
String
Phone number's extension.
first_name
String
First name of the associated payer.
last_name
String
Last name of the associated payer.
binary_mode
Boolean
When set to true, the payment can only be approved or rejected. Otherwise in_process status is added.
live_mode
Boolean
Whether the payment will be processed in sandbox or in production mode.
order
Object
Order identifier.
type
String
Type of order.
mercadolibre
The order is from Mercado Libre.
mercadopago
It is a Mercado Pago merchant_order.
id
Long
Id of the associated purchase order.
external_reference
String
ID given by the merchant in their system.
description
String
Payment reason or item title.
metadata
Object
Valid JSON that can be attached to the payment to record additional attributes of the merchant.
currency_id
String(3)
ID of the currency used in the payment.
ARS
Argentine peso.
BRL
Brazilian real.
CLP
Chilean peso.
MXN
Mexican peso.
COP
Colombian peso.
PEN
Peruvian sol.
UYU
Uruguayan peso.
transaction_amount
Float
Product cost. (Required)
transaction_amount_refunded
Float
Total refunded amount in this payment.
coupon_amount
Float
Amount of the coupon discount.
date_of_expiration
Date(ISO_8601)
Payment’s expiration date.
campaign_id
Integer
Discount campaign ID.
coupon_code
String
Discount campaign with a specific code.
transaction_details
Object
Groups the details of the transaction.
financial_institution
String
External financial institution identifier (e.g.: company id for atm)
net_received_amount
Float
Amount received by the seller.
total_paid_amount
Float
Total amount paid by the buyer (includes fees).
installment_amount
Float
Total installments amount.
overpaid_amount
Float
Amount overpaid (only for tickets).
external_resource_url
String
Identifies the resource in the payment processor.
payment_method_reference_id
String
For credit card payments is the USN. For offline payment methods, is the reference to give to the cashier or to input into the ATM.
fee_details
Array(Object)
List of fees.
type
String
Fee detail.
mercadopago_fee
Cost for using Mercado Pago.
coupon_fee
Discount given by a coupon.
financing_fee
Cost of financing.
shipping_fee
Shipping cost.
application_fee
Marketplace comision for the service.
discount_fee
Discount given by the seller through cost absorption.
fee_payer
String
Who absorbs the cost.
collector
The seller absorbs the cost.
payer
The buyer absorbs the cost.
amount
Float
Fee amount.
differential_pricing_id
Integer
Id of the scheme for the absorption of financing fee.
application_fee
Float
Fee collected by a marketplace or Mercado Pago Application.
status
String
Payment status.
pending
The user has not yet completed the payment process.
approved
The payment has been approved and accredited.
authorized
The payment has been authorized but not captured yet.
in_process
Payment is being reviewed.
in_mediation
Users have initiated a dispute.
rejected
Payment was rejected. The user may retry payment.
cancelled
Payment was cancelled by one of the parties or because time for payment has expired
refunded
Payment was refunded to the user.
charged_back
Was made a chargeback in the buyer’s credit card.
status_detail
String
Gives more detailed information on the current state or rejection cause.
capture
Boolean
Determines if the payment should be captured (true, default value) or just reserved (false).
captured
Boolean
Determines if the capture operation was performed (just for credit cards).
call_for_authorize_id
String
Identifier that must be provided to the issuing bank to authorize the payment.
payment_method_id
String
Payment method chosen to do the payment. (Required)
issuer_id
String
Payment method issuer.
payment_type_id
String
Type of payment method chosen.
account_money
Money in the MercadoPago account.
ticket
Printed ticket.
bank_transfer
Wire transfer.
atm
Payment by ATM.
credit_card
Payment by credit card.
debit_card
Payment by debit card.
prepaid_card
Payment by prepaid card.
token
String
Card token ID. (Required for credit card)
card
Object
Details of the card used.
id
Number
Id of the card.
last_four_digits
String
Last four digits of card number.
first_six_digits
String
First six digit of card number.
expiration_year
Integer
Card expiration year.
expiration_month
Integer
Card expiration month.
date_created
Date(ISO_8601)
Creation date of card.
date_last_updated
Date(ISO_8601)
Last update of data from the card.
cardholder
Object
Card's owner data.
name
String
Cardholder Name.
identification
Object
ID of the cardholder.
number
String
Document number.
type
String
Document type.
statement_descriptor
String
How will look the payment in the card bill (e.g.: MERCADOPAGO).
installments
Integer
Selected quantity of installments. (Required)
notification_url
String
URL where Mercado Pago will send notifications associated to changes in this payment
callback_url
String
URL where mercadopago does the final redirect (only for bank transfers).
refunds
Array(Object)
List of refunds that were made to this payment.
id
Number
Refund identifier.
payment_id
Number
Payment on which the return was made.
amount
Float
Amount refunded.
metadata
Object
Valid JSON that can be attached to the payment to record additional attributes of the merchant.
source
Object
Who made the refund.
id
String
User ID who issued the refund.
name
String
User who issued the refund.
type
String
Type of user who issued the refund.
collector
The collector issued the refund.
operator
The refund was made by an account's operator.
admin
The refund was made by a Mercado Pago administrator.
bpp
The refund was made by the Mercado Pago's Buyer Protection Program
date_created
Date(ISO_8601)
Date of refund.
unique_sequence_number
String
Refund identifier given by the card processor.
additional_info
Object
Data that could improve fraud analysis and conversion rates. Try to send as much information as possible.
ip_address
String
IP from where the request comes from (only for bank transfers).
items
Array(Object)
List of items to be paid.
id
String
Item code.
title
String
Item name.
description
String
Long item description.
picture_url
String
Image URL.
category_id
String
Category of the item.
quantity
Integer
Item's quantity.
unit_price
Float
Unit price.
payer
Object
Buyer's information.
first_name
String
Buyer's name.
last_name
String
Buyer's last name.
phone
Object
Buyer's phone.
area_code
String
Area code.
number
String
Phone number.
address
Object
Address.
zip_code
String
Zip code.
street_name
String
Street name.
street_number
Integer
Number.
registration_date
Date
Date of registration of the buyer on your site.
shipments
Object
Shipping information.
receiver_address
Object
Buyer's address.
zip_code
String
Zip code.
state_name
String
State.
city_name
String
City Name.
street_name
String
Street name.
street_number
Integer
Number
floor
String
Floor.
apartment
String
Department.
barcode
Object
Barcode information.
type
String
Encoding type.
UCC/EAN 128
Encodes data using the Code 128 symbology.
Code128C
High-density alphanumeric code.
Code39
Media density code.
content
String
Barcode generated.
width
Integer
Width of barcode.
height
Integer
Height of barcode.