Documentação da API PixPlayBr

Depósito Pix

Introdução

Este endpoint permite a criação de um pagamento Pix. Ao enviar os dados do pagador, a API retorna as informações necessárias para gerar o QR Code ou o Pix Copia e Cola, que o usuário final pode utilizar para efetuar o pagamento.

Endpoint

POST https://api.pixplaybr.com/api/v1/deposito.php

Autenticação

Este endpoint requer autenticação via Bearer Token. O token deve ser fornecido no cabeçalho da requisição.

Authorization: Bearer SEU_TOKEN_DE_AUTENTICACAO

SEU_TOKEN_DE_AUTENTICACAO: A chave de API fornecida por você aos seus clientes.

Cabeçalhos da Requisição (Headers)

Chave	Valor	Descrição
`Content-Type`	`application/json`	O formato do corpo da requisição.
`Authorization`	`Bearer SEU_TOKEN`	Token de autenticação da API.

Corpo da Requisição (Body)

O corpo da requisição deve ser um objeto JSON contendo os seguintes campos:

Campo	Tipo	Obrigatório	Descrição
`valor`	`string`	Sim	O valor do depósito. Ex: `"10.00"`.
`nome`	`string`	Sim	Nome completo do pagador.
`email`	`string`	Sim	Endereço de e-mail do pagador.
`doc_tipo`	`string`	Sim	Tipo do documento do pagador (`"cpf"` ou `"cnpj"`).
`doc_numero`	`string`	Sim	Número do documento do pagador. Deve ser válido.
`external_reference`	`string`	Sim	ID único da transação no sistema do cliente. Essencial para o rastreamento.

Atenção: O campo external_reference deve ser único para cada requisição. Reutilizar o mesmo valor resultará em um erro.

Exemplo de Requisição (com `curl`)

curl --location 'https://api.pixplaybr.com/api/v1/deposito.php' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SEU_TOKEN_DE_AUTENTICACAO' \
--data '{
    "valor": "10.00",
    "nome": "João da Silva",
    "email": "joao.silva@exemplo.com",
    "doc_tipo": "cpf",
    "doc_numero": "12345678900",
    "external_reference": "pedido_12345"
}'

Resposta de Sucesso (200 OK)

Em caso de sucesso, a API retornará o código 200 com um objeto JSON contendo as informações para o pagamento Pix.

{
  "status": "success",
  "qr_code": "https://api.mercadopago.com/v1/payments/pix/qr_code/...",
  "qr_code_text": "00020126420014br.gov.bcb.pix0120exemplo@exemplo.com.br52040000530398654060.005802BR5913...",
  "external_reference": "pedido_12345"
}

Respostas de Erro

Código	Descrição do Erro	Possível Causa
`400`	`Dados de entrada incompletos.`	O JSON da requisição está faltando um ou mais campos obrigatórios.
`401`	`Não autorizado.`	O token de autenticação não foi fornecido ou é inválido.
`409`	`Erro interno do servidor: ... Duplicate entry ...`	O `external_reference` enviado já existe no banco de dados.
`500`	`Erro interno do servidor.`	Erro inesperado no processamento da requisição. Verifique os logs do servidor.

O Fluxo Pós-Pagamento

Após o cliente efetuar o pagamento, a PixPlayBr enviará uma notificação para o seu endpoint de webhook (webhook.php). Sua API deve processar essa notificação, identificar a transação através do external_reference e atualizar o status do pagamento em seu sistema.