Skip to content

Latest commit

 

History

History
297 lines (228 loc) · 5.82 KB

core-methods.md

File metadata and controls

297 lines (228 loc) · 5.82 KB
Raw

MercadoPago(public_key[, options])

SDK instantiation method.

Params:

public_key | string, REQUIRED

It is the public key for your account.


options | object, OPTIONAL

Option name Values Default Type Description
locale es-AR
es-CL
es-CO
es-MX
es-VE
es-UY
es-PE
pt-BR
en-US		 Browser default locale string Set the locale OPTIONAL
advancedFraudPrevention true|false true boolean Set the advanced fraud prevention status OPTIONAL
trackingDisabled true|false false boolean Enable/disable tracking of generic usage metrics OPTIONAL

Example:

const mp = new MercadoPago('PUBLIC_KEY', {
  locale: 'en-US',
  advancedFraudPrevention: true,
})

Return: mp instance
getIdentificationTypes METHOD
getPaymentMethods METHOD
getIssuers METHOD
getInstallments METHOD
createCardToken METHOD
cardForm MODULE
checkout MODULE
fields MODULE


mp instance.getIdentificationTypes()

Return all the document types based on the public_key

Example:

const identificationTypes = await mp.getIdentificationTypes()

Return: PROMISE

[{
  id: string,
  name: string,
  type: string,
  min_length: number,
  max_length: number
}]


mp instance.getPaymentMethods(paymentMethodsParams)

Returns a payment methods list


Params:

paymentMethodsParams | object, REQUIRED

Option Key Type Description
bin STRING Card number first 8 digits REQUIRED
processingMode "aggregator" | "gateway" Process mode OPTIONAL

Example:

const paymentMethods = await mp.getPaymentMethods({ bin: '41111111' })

Return: PROMISE (showing most common used results.)

{
  paging: {
    total: number,
      limit: number,
      offset: number,
    },
  results: [{
    secure_thumbnail: string,
    min_accreditation_days: number,
    max_accreditation_days: number,
    id: string,
    payment_type_id: string,
    accreditation_time: number,
    thumbnail: string,
    marketplace: string,
    deferred_capture: string,
    labels: string[],
    name: string,
    site_id: string,
    processing_mode: string,
    additional_info_needed: string[],
    status: string,
    settings: [{
        security_code: {
            mode: string,
            card_location: string,
            length: number
        },
        card_number: {
            length: number,
            validation: string
        },
        bin: {
            pattern: string,
            installments_pattern: string,
            exclusion_pattern: string,
        }
    }],
    issuer: {
        default: boolean,
        name: string,
        id: number
    },
}


mp instance.getIssuers(issuersParams)

Returns a issuers list


Params:

issuersParams | object, REQUIRED

Option Key Type Description
paymentMethodId STRING Payment method ID REQUIRED
bin STRING Card number first 8 digits REQUIRED

Example:

const issuers = await mp.getIssuers({ paymentMethodId: 'visa', bin: '411111111' })

Return: PROMISE

[{
  id: string,
  name: string,
  secure_thumbnail: string,
  thumbnail: string,
  processing_mode: string,
  merchant_account_id?: string,
}]


mp instance.getInstallments(installmentsParams)

Returns all installments available


Params:

installmentsParams | object, REQUIRED

Option Key Type Description
amount STRING Payment total amount REQUIRED
bin STRING Card number first 8 digits REQUIRED
locale STRING Set the response message language OPTIONAL
processingMode "aggregator" | "gateway" Process mode OPTIONAL

Example:

const installments = await mp.getInstallments({
  amount: '1000',
  locale: 'pt-BR',
  bin: '41111111',
  processingMode: 'aggregator'
})

Return: PROMISE

[{
  ...
  merchant_account_id?: string,
  payer_costs: [{
    installments: number,
    installment_rate: number,
    discount_rate: number,
    labels: string[],
    installment_rate_collector: string[],
    min_allowed_amount: number,
    max_allowed_amount: number,
    recommended_message: string,
    installment_amount: number,
    total_amount: number,
    payment_method_option_id: string
  }]
}]


mp instance.createCardToken(cardTokenParams)

Return a token card

Params:

cardTokenParams | object, REQUIRED

Option Key Type Description
cardNumber STRING Card number OPTIONAL
cardholderName STRING Cardholder name OPTIONAL
cardExpirationMonth STRING Expiration month OPTIONAL
cardExpirationYear STRING Expiration year OPTIONAL
securityCode STRING Security code REQUIRED
identificationType STRING Type of document OPTIONAL
identificationNumber STRING Value of document OPTIONAL
cardId STRING Id of a saved card OPTIONAL

Example:

const cardToken = await mp.createCardToken({
    cardNumber: '5031433215406351' ,
    cardholderName: 'APRO',
    cardExpirationMonth: '11',
    cardExpirationYear: '2025',
    securityCode: '123',
    identificationType: 'CPF',
    identificationNumber: '12345678912',
})

Return: PROMISE

{
  ...
  id: string
}