Recursos para IA
Obter informações sobre um lote

Este endpoint permite consultar o status e o resumo consolidado de um lote de transações (payout) criado anteriormente com base no seu ID, incluindo quantas transações foram concluídas com sucesso, estão pendentes ou apresentaram erro. Em caso de sucesso, a requisição retornará uma resposta com o status 200.

GET

https://api.mercadopago.com/v1/payouts/{payout_id}
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
Path
payout_id
string

OBRIGATÓRIO

Identificador do payout que deseja consultar, retornado no campo id da resposta a POST /v1/payouts.
Response parameters
id
string
Identificador único do payout, gerado automaticamente.
status
string
Status atual do payout.
created: O payout foi criado com sucesso.
pending: O payout está pendente e aguardando processamento adicional.
in_process: O payout está em processamento.
external_reference
string
Referência externa do payout, gerada pelo integrador no momento da criação.
config
object
Objeto que contém as configurações do payout, como a URL que recebe notificações sobre mudanças no status das transações.
Erros

400Requisição inválida. Os parâmetros enviados não são válidos.

invalid_payout_id

Dados inválidos foram enviados no body da requisição. O payout não foi encontrado. Tente enviar a solicitação novamente, validando todos os campos.

invalid_transaction_id

Dados inválidos foram enviados no body da requisição. A transação não foi encontrada. Tente enviar a solicitação novamente, validando todos os campos.

invalid_signature

Dados inválidos foram enviados no body da requisição. Verifique se a secret foi gerada corretamente e está registrada com o Mercado Pago. Verifique também se o body que está enviando é o que foi criptografado.

idempotency_key_required

Dados inválidos foram enviados no body da requisição. A chave de idempotência (idempotency_key) está ausente. Tente enviar a solicitação novamente, validando todos os campos.

invalid_account

O objeto `account` foi enviado sem os dados obrigatórios para identificar a conta de destino. Informe `email` para uma conta Mercado Pago ou os dados bancários obrigatórios de uma conta externa, incluindo `number` e `bank_id`. Para uma transferência via Pix, defina `transactions.type` como `pix` e envie os dados da chave em `transactions.pix` em vez de `account`.

invalid_account_type

O campo account_type foi enviado com um valor não suportado. Os valores aceitos são checking_account ou savings.

401Erro. Access Token não autorizado.

invalid_token

O Access Token enviado está incorreto. Revise o valor e tente enviar a requisição novamente com a informação correta.

403Proibido. Não tem permissões para acessar este recurso.

forbidden

Sem permissão para acessar o recurso.

404Erro. Payout não encontrado.

not_found

Payout não encontrado. Verifique se o ID enviado está correto.

500Erro interno do servidor.

internal_server_error

Ocorreu um erro inesperado no servidor. Tente enviar a requisição novamente.

502Erro de gateway. Falha na integração com um serviço externo.

bad_gateway

Ocorreu um erro na integração com um serviço externo. Tente enviar a requisição novamente.

Request
curl -X GET \
    'https://api.mercadopago.com/v1/payouts/{payout_id}'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-8*********88776-122*********fc20dede6*********a497d7225*********64' \
    
Response
{
  "id": "POP01KV681P6SJ38NQHWX3XK162SS",
  "status": "completed",
  "external_reference": "MP0197",
  "config": {
    "notification_url": "https://link-your-webhook-notification.com"
  },
  "summary": {
    "pending": {
      "items": 0
    },
    "canceled": {
      "items": 0
    },
    "success": {
      "items": 0
    },
    "error": {
      "items": 2
    }
  }
}