/preapproval
BASE URI https://api.mercadopago.com/preapproval
HTTP Request
curl
curl --location --request POST 'https://api.mercadopago.com/preapproval?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
"auto_recurring": {
"currency_id": "ARS",
"transaction_amount": 10,
"frequency": 1,
"frequency_type": "months",
"end_date": "2022-07-20T11:59:52.581-04:00",
},
"back_url": "https://www.mercadopago.com.ar",
"collector_id": 555435388,
"external_reference": "1245AT234562",
"payer_email": "test_user@testuser.com",
"reason": "Suscripción particular",
"status": "pending"
}' Request Params
ParameterTypeDescription
payer_email
String
Email do pagador.
back_url
String
url de retorno.
collector_id
String
Identificador de fornecedor.
status
String
Status de assinatura.
reason
String
Título da assinatura.
external_reference
String
Valor de referência de assinatura.
auto_recurring
Object
Dados de recorrência de assinatura.
frequency
Integer
Número de dias de recorrência.
frequency_type
String
Tipo de recorrência (dias ou meses).
transaction_amount
Number
Valor da assinatura.
currency_id
String
Identificador de moeda local.
start_date
Date(ISO_8601)
Data de início da assinatura.
end_date
Date(ISO_8601)
Data de término da assinatura.
HTTP Response
json
{
"id": "2c938084726fca480172750000000000",
"payer_id": 123123123,
"payer_email": "test_user@testuser.com",
"back_url": "https://www.mercadopago.com.ar",
"collector_id": 100200300,
"application_id": 1234567812345678,
"status": "pending",
"reason": "Suscripcion Particular",
"external_reference": "23546246234",
"date_created": "2020-06-02T09:07:14.260-04:00",
"last_modified": "2020-06-02T09:07:14.263-04:00",
"init_point": "https://www.mercadopago.com/[FAKER][GLOBALIZE][UPPER_SITE_ID]/debits/new?preapproval_id=2c938084726fca480172750000000000",
"sandbox_init_point": "https://sandbox.mercadopago.com/[FAKER][GLOBALIZE][UPPER_SITE_ID]/debits/new?preapproval_id=2c938084726fca480172750000000000",
"auto_recurring": {
"frequency": 1,
"frequency_type": "months",
"transaction_amount": 10,
"currency_id": "ARS",
"start_date": "2020-06-02T09:07:14.260-04:00",
"end_date": "2022-07-20T11:59:52.581-04:00"
},
"version": 0
} Error Codes
CodeDescription
400 BAD_REQUEST
Card token was used, please generate new
O token do cartão já foi usado, um novo deve ser criado.
Card token was generated without cvv validation
Pagamentos sem cvv não são aceitos.
Subscriptions are not available for this country yet
Aplicação de um site diferente de MLA ou MLB ou MLM.
The payment method account money is not available in your country
Você não pode criar assinaturas com dinheiro em conta no seu país.
Collector and Application cannot be from different countries
Um aplicativo que não corresponde ao site do coletor está sendo usado.
card_token_id is required
Se a assinatura for criada com um modelo associado, o ID do token do cartão é necessário.
payer_email is required
O e-mail do pagador é obrigatório.
Invalid value for payer_email, must be a valid email address
O email do pagador é inválido.
Invalid value for transaction amount, must be a positive number
O valor da assinatura é inválido, deve ser um número positivo.
Invalid value for transaction amount, only two decimals are allowed
O valor da assinatura é inválido, apenas 2 casas decimais são permitidas.
Cannot pay an amount lower than ${currency_id} ${min amount}
O valor da assinatura é inválido, o limite para o país é menor.
Cannot pay an amount greater than ${currency_id} ${max amount}
O valor da assinatura é inválido, o limite para o país é maior.
The transaction_amount must be the same as preapproval_plan
O valor da assinatura e o plano associado devem ser os mesmos.
You cannot create a new preapproval from a cancelled/inactive template
O plano ou modelo associado deve estar ativo.
back_url is required
O url de retorno é obrigatório.
Invalid value for back url, must be a valid URL
O url de retorno é inválido, deve ser um url válido.
reason is required
O título da assinatura é obrigatório.
reason has more than 255 characters
O título da assinatura deve conter até 255 caracteres.
reason has unsupported characters
O título da assinatura contém caracteres inválidos.
auto_recurring.frequency is required
A frequência é necessária.
Invalid value for frequency, must be a positive integer
A frequência deve ser um valor positivo.
Invalid value for frequency type, valid ones are [days, months]
O tipo de frequência deve ser dias ou meses.
auto_recurring.frequency_type is required
O tipo de frequência é obrigatório.
auto_recurring.transaction_amount is required
O valor da assinatura é necessário.
auto_recurring.currency_id is required
O identificador de moeda é obrigatório.
Invalid field -> auto_recurring.currency_id
O identificador da moeda é inválido.
Invalid value for auto_recurring.end_date, the date must be after today
A data de término da assinatura deve ser posterior à data atual.
auto_recurring.end_date must be after auto_recurring.start_date
A data de término da assinatura não pode ser inferior à data de início.
Invalid value for auto_recurring.start_date, the date must be after today
A data de início não pode ser posterior à data atual.
Invalid format in auto_recurring.start_date or auto_recurring.end_date
As datas devem estar em um formato válido.
external_reference has more than 255 characters
A referência externa deve conter até 255 caracteres.
external_reference has unsupported characters
A referência externa contém caracteres inválidos.
Already exists a preapproval for user ${payer_email} and application ${application_id}
Não pode haver mais de uma assinatura para o mesmo pagador, você deve cancelar a anterior.
Cannot operate between different countries
O pagador e o vendedor devem pertencer ao mesmo site.
Payer and collector cannot be the same user
O pagador e o vendedor devem ser usuários diferentes.
Both payer and collector must be real or test users
Não é possível combinar usuários reais com usuários de teste.
This preapproval cannot be created: The seller does not accept account_money
O meio de pagamento em dinheiro na conta não é suportado pelo vendedor.
This preapproval cannot be created only with payment method account_money
Você não pode criar uma assinatura com apenas dinheiro na conta.
You cannot create a preapproval with payment_method in status pending
Uma assinatura criada pelo cliente não pode ter um meio de pagamento associado.
Cannot create preapproval pending, the feature with account money is disabled for your country.
Você não pode criar assinaturas pendentes no momento em seu país.
Invalid request data
Detalhes de assinatura inválidos.
401 UNAUTHORIZED
CC_VAL_433
Método de pagamento rejeitado, você deve usar outro método de pagamento.
Verification of collectors personal data is in process, come back later
O vendedor está sendo analisado pela KYC.
Unauthorized access to resource
Token de acesso não enviado ou expirado.
This app cannot create preapprovals without a plan
A pré-aprovação deve ter recorrência automática.
403 UNAUTHORIZED
The collector does not meet the personal data verification requirements
O vendedor não realizou as validações KYC.
The caller is not authorized to access this resource
Uma pré-aprovação está sendo usada e não pertence a esse vendedor.
AM_VAL_01 Unauthorized seller for this feature
O cobrador deve estar na whitelist para utilizar o meio de pagamento dinheiro na conta.
404 NOT_FOUND
The preapproval with id ${preapproval id} does not exist
A assinatura com id $ {id} não existe.
Card token service not found
Você está usando um token de cartão que não existe.