Module: MercadoPago::Collection

Defined in:
lib/mercadopago/collection.rb

Class Method Summary collapse

Class Method Details

.notification(access_token, payment_id, sandbox = false) ⇒ Object

Receives an access_token and a payment id and retrieves information of the payment. This is useful, for example, to check the status of a payment.

  • access_token: an access_token of the MercadoPago account associated with the payment to be checked.

  • payment_id: the id of the payment to be checked.

  • sandbox: whether or not the sandbox mode should be activated.



14
15
16
17
 
# File 'lib/mercadopago/collection.rb', line 14

def self.notification(access_token, payment_id, sandbox = false)
  uri_prefix = sandbox ? '/sandbox' : ''
  MercadoPago::Request.wrap_get("#{uri_prefix}/collections/notifications/#{payment_id}?access_token=#{access_token}", { accept: 'application/json' })
end

.notification_authorized(access_token, authorized_id) ⇒ Object

  • access_token: an access_token of the MercadoPago account associated with the payment to be checked.

  • authorized_id: the id of the authorized payment to be checked.



23
24
25
 
# File 'lib/mercadopago/collection.rb', line 23

def self.notification_authorized(access_token, authorized_id)
  MercadoPago::Request.wrap_get("/authorized_payments/#{authorized_id}?access_token=#{access_token}", { accept: 'application/json' })
end

.notification_preapproval(access_token, preapproval_id) ⇒ Object

  • access_token: an access_token of the MercadoPago account associated with the payment to be checked.

  • preapproval_id: the id of the recurring payment to be checked.



31
32
33
 
# File 'lib/mercadopago/collection.rb', line 31

def self.notification_preapproval(access_token, preapproval_id)
  MercadoPago::Request.wrap_get("/preapproval/#{preapproval_id}?access_token=#{access_token}", { accept: 'application/json' })
end

.search(access_token, search_hash = {}, sandbox = false) ⇒ Object

Receives an access_token and a search_hash and returns matching payments, according to the search params.

  • access_token: an access_token of the MercadoPago account associated with the payment to be checked.

  • search_hash: querystring in hash format.

  • sandbox: whether or not the sandbox mode should be activated.

Search parameter valid keys:

id

Payment identifier.

site_id

Country identifier: Argentina: MLA; Brasil: MLB.

date_created

Creation date. Ej: range=date_created&begin_date=NOW-1DAYS&end_date=NOW (Ver ISO-8601).

date_approved

Approval date. Ej: range=date_approved&begin_date=NOW-1DAYS&end_date=NOW (Ver ISO-8601).

last_modified

Last modified date. Ej: range=last_modified&begin_date=NOW-1DAYS&end_date=NOW (Ver ISO-8601).

money_release_date

Date of the payment’s release. Ej: range=money_release_date&begin_date=NOW-1DAYS&end_date=NOW (Ver ISO-8601).

payer_id

Buyer’s identifier.

reason

Description of what’s being payed.

transaction_amount

Amount of the transaction.

currency_id

Currency type. Argentina: ARS (peso argentino);‘ USD (Dólar estadounidense); Brasil: BRL (Real).

external_reference

Field used by the seller as aditional reference.

mercadopago_fee

MercadoPago’s comission fee.

net_received_amount

Amount payable to the seller without mercadopago_fee.

total_paid_amount

Obtained by adding: transaction_amount, shipping_cost and the amount payed by the buyer (including credit card’s financing).

shipping_cost

Shipping cost.

status

Status of the payment:

pending

The payment process is incomplete.

approved

The payment has been credited.

in_process

The payment is under review.

rejected

The payment has been rejected.

cancelled

The payment is canceled after timeout or by either party.

refunded

The payment has been refunded.

in_mediation

The payment is in dispute.

status_detail

Payment status detail.

released

Wether the amount is available or not. Possible values are yes or no.

operation_type

Type of operation:

regular_payment

A payment.

money_transfer

A money wire.

recurring_payment

Active subscription recurring payment.

subscription_payment

Subscription fee.



104
105
106
107
108
109
 
# File 'lib/mercadopago/collection.rb', line 104

def self.search(access_token, search_hash = {}, sandbox = false)
  query = search_hash.map { |e| e.join('=') }.join('&')

  uri_prefix = sandbox ? '/sandbox' : ''
  MercadoPago::Request.wrap_get("#{uri_prefix}/collections/search?access_token=#{access_token}&#{query}", { accept: 'application/json' })
end