Introdução
Esta seção descreve: Pay Mundi Api PIX : gateway pagamento via API.
Pay Mundi Api PIX : API fácil de integrar em seu software. Nossa API tem URLs bem formatadas, aceita solicitações de curl e retorna as respostas do JSON.
Você pode usar a API no modo de teste, o que não afeta seus dados ativos. A chave da API é usada para autenticar a solicitação e determina se a solicitação é um pagamento válido ou não. Para o modo de teste, basta usar a URL do sandbox e, no caso do modo ativo, use a URL ativa da seção Iniciar pagamento .
Moedas suportadas
Esta seção descreve as moedas suportadas por Pay Mundi Api PIX
Pay Mundi Api PIX permite fazer transações com as moedas abaixo. Qualquer nova moeda pode ser atualizada no futuro.
| Nome Moeda | Símbolo Moeda | Código Moeda |
|---|---|---|
| Real Brasileiro | R$ | BRL |
Obtenha a chave da API
Esta seção descreve como você pode obter sua chave de API.
Faça login em : Pay Mundi Api PIX na Conta tipo Comerciante. Quer ter acesso ? Clique aqui
O próximo passo é encontrar : Api Key Pix menu na barra lateral do seu painel. Clique no MENU->Api Key Pix.
As chaves da API podem ser encontradas lá: "Public KEY : Chave Pública" e "Secret KEY : Chave Secreta". Use essas CHAVES para iniciar a solicitação da API. Você pode gerar nova chave API clicando no botão MENU->Api Key | PIX API KEY: Gerar Nova Chave | . Lembre-se: Não compartilhe essas chaves com ninguém! JAMAIS!
Iniciar pagamento CASH-OUT
Esta seção descreve o processo de "Iniciar o Pagamento CASH-OUT".
Para iniciar o pagamento, siga o código de exemplo e tenha cuidado com os parâmetros. Você precisará fazer a solicitação com os seguintes ENDPOINTS da API.
EndPoint Produção (real): Solicitar URL com suporte
EndPoint SandBox (teste demo) : Solicitar URL com suporte
Método de solicitação: POST
Pedido (request) para o EndPoint com os seguintes parâmetros abaixo.
| Parâmetro Nome | Tipo de parâmetro | Descrição |
|---|---|---|
| type | string (50) | Obrigatório Tipo PIX |
| nickname_connection | string (50) | Obrigatório Apelido da conexão - No Painel MENU->Webhook e IP se econtra o "Apelido da Conexâo" |
| public_key | string (50) | Obrigatório Sua Chave pública API key |
| secret_key | string (50) | Obrigatório Sua Chave Secreta API key |
| payment | string | |
| pixKey | decimal | Obrigatório Valor do pagamento. |
| currency | string (4) | Obrigatório Código Moeda: deve estar em maiúsculo, exemplo: BRL |
| amount | decimal | Obrigatório Valor do pagamento. |
| name_documentor | string (30) | Opcional Nome do cliente. |
| email_documentor | string (30) | Opcional E-mail válido do cliente. |
| documentor | string (30) | Opcional CPF ou CNPJ do cliente. |
//application/json
{
"type": "PIX",
"nickname_connection": "Cash-Out",
"public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"secret_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"payment": {
"pixKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"currency": "BRL",
"amount": 0.01
},
"name_documentor": "Pedro H",
"email_documentor": "dev@paymundi.com.br",
"documentor": "12345678901"
}
//application/json
{
"EndToEndId": "E0549161620240918001554994779ed4",
"eventDate": "2024-09-18T00:15:54.994+00:00",
"payerType": "PIX",
"status": "PENDING",
"payment": {
"currency": "BRL",
"amount": 0.01
}
}
Consultar transação CASH-OUT
Esta seção descreve o processo para obter sua notificação de pagamento instantâneo.
Para iniciar o pagamento, siga o código de exemplo e tenha cuidado com os parâmetros. Você precisará fazer a solicitação com os seguintes ENDPOINTS da API.
EndPoint: Solicitar URL com suporte
Método de solicitação: POST
Você receberá os seguintes parâmetros abaixo.
| Parâmetro Nome | Tipo de parâmetro | Descrição |
|---|---|---|
| endToEndId | string (50) | Obrigatório Identificador "endToEndId" gerado no webhook quanto cliente efetua pagamento. |
| public_key | string (50) | Obrigatório Sua Chave pública API key |
| secret_key | string (50) | Obrigatório Sua Chave Secreta API key |
//application/json
{
"endToEndId": "E0549161620240917023126899a26da8",
"public_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"secret_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
//application/json
{
"status": "LIQUIDATED",
"endToEndId": "E0549161620240918001554994779ed4",
"data": {
"payout_id": 34867,
"amount": "0.01000000",
"charge": "0.04000000",
"final_amount": "0.05000000",
"account_holder": "I.B.A.",
"payout_create_timestamp": "2024-09-18T00:15:55.000000Z",
"payout_update_timestamp": "2024-09-18T00:15:58.000000Z",
"currency": {
"code": "BRL",
"symbol": "R$"
}
}
}
WebHooks CASH-OUT
Esta seção descreve o processo para obter sua notificação de pagamento instantâneo.
Para iniciar o pagamento, siga o código de exemplo e tenha cuidado com os parâmetros. Você precisará fazer a solicitação com os seguintes ENDPOINTS da API.
EndPoint: URL do seu site de aplicação
Método de solicitação: POST
//application/json
//CASH-OUT Concluído
{
"type": "Transferencias",
"status": "LIQUIDATED",
"connection": "Cash-Out",
"payment": {
"amount": 0.01,
"charge": 0.04,
"currency": "BRL",
"final_amount": 0.05
},
"trxidOut": "E0549161620240918015001319a4d765",
"eventDate": "2024-09-18T01:50:07.000000Z",
"payerType": "PIX"
}
//CASH-OUT Cancelado
{
"type": "Transferencias",
"status": "CANCELED",
"connection": "Cash-Out",
"payment": {
"amount": 0.01,
"currency": "BRL"
},
"trxidOut": "E0549161620240918015001319a4d765",
"eventDate": "2024-09-18T01:50:07.000000Z",
"payerType": "PIX"
}