Referência da API

Notificações automática de status (Retorno automático) - PIX

A EXPAY BRASIL enviará uma notificação para a notification_url, fornecida durante a solicitação de criação da fatura. Essa notificação consiste no envio de um post simples para a notification_url contendo informações básicas (date_notification, invoice_id, token). Ao receber essa solicitação, o servidor do comerciante deve responder com token junto da merchant_key do comerciante e enviá-las ao endpoint https://expaybrasil.com/en/request/status.

A EXPAY BRASIL apresentará as informações da notificação no formato JSON assim que receber o token e a merchant_key do comerciante.

Endpoint
https://expaybrasil.com/en/request/status
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para acessar este Endpoint, é necessário ter uma chave de comerciante (merchant_key).
Essas informações podem ser encontradas no painel de credenciais da EXPAY BRASIL.
Tipo de Conteúdo
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Parte 01 - Post Simples (JSON) realizado pela EXPAY BRASIL à URL de notification_url do comerciante, contendo dados iniciais referentes à notificação.

{
'date_notification': '20/06/2008 16:23',
'invoice_id': '1234567',
'token': '1675874595'
}

Parte 02 – Resposta da loja no formato ARRAY com o token + merchant_key do comerciante.

[
    'merchant_key' => '$2y$10$Y8G0Z.yKxy2NCC7xXWi3yO0vqcrSFLLBuELNZsogtX.hyE.s.l3lq',
    'token' => '1676243355'
  ]

Parte 03 – Resposta da EXPAY BRASIL no formato JSON, exibindo todo o conteúdo da notificação.

{
  "result": true,
  "success_message": "Sucess!",
  "transaction_request": {
    "items": [
      {
        "name": "Product 1",
        "price": 20,
        "description": "Product 1 description",
        "qty": 1
      },
      {
        "name": "Product 2",
        "price": 10,
        "description": "Product 2 description",
        "qty": 1
      },
      {
        "name": "Product 3",
        "price": 10,
        "description": "Product 3 description",
        "qty": 1
      }
    ],
    "invoice_id": 1000,
    "invoice_description": "Pedido da Fatura 1000",
    "total": 40,
    "devedor": "João Cavalcante",
    "email": "[email protected]",
    "cpf_cnpj": "71604721448",
    "notification_url": "https://meusite.com/notification/",
    "telefone": "87981776688",
    "status": "paid",
    "pix_code": null
  }
}

Especificações dos campos que a EXPAY BRASIL irá enviar na primeira parte

Campo Tamanho Tipo Descrição
date_notification DATETIME Data em que a notificação foi gerada.
invoice_id String O "invoice_id" é a Identificação da Fatura feita pelo Vendedor.
token Esperado 10 caracteres. String O "token" é um identificador numérico único gerado para cada transação, usado para rastrear e validar operações específicas.

Especificações dos campos da mensagem de resposta da EXPAY BRASIL

Campo Tamanho Tipo Descrição
token Esperado 10 caracteres. String O "token" é um identificador numérico único gerado para cada transação, usado para rastrear e validar operações específicas.
merchant_key Até 90 caracteres String A "merchant_key" é uma chave criptografada única e segura, usada para identificar e autenticar um comerciante em transações online. Exemplo de valor: "$2y$10$Y8G0Z.yKxy2NCC7xXWi3yO0vqcrSFLLBuELNZsogtX.hyE.s.l3lq".

Especificações dos campos da mensagem de resposta da EXPAY BRASIL

Campo Tamanho Tipo Descrição
result Boolean Campo que identifica se houve êxito na busca e se os parâmetros estão corretos.

Esperado:
true
false
response_message Até 128 caracteres String Descreve em detalhes se houver algum erro ou se a transação foi encontrada.

verificar item mensagens de retorno
items object

retorna seus itens e detalhes

Esperado:

'name' : 'String'
'price' : Float
'description' : 'String'
'qty' : Int
invoice_id Até 64 caracteres String Código de referência da venda

Esse código foi atribuído pelo vendedor no momento da requisição.
invoice_description Até 240 caracteres String Descrição informada pelo vendedor para a fatura
total Até 15 caracteres Float Valor informado pelo vendedor para a fatura.
devedor Até 255 caracteres String Nome do cliente devedor
email Até 255 caracteres String e-mail do cliente pagador
cpf_cnpj Até 14 caracteres String CPF ou CNPJ do pagador

apenas os números do cpf ou cnpj
notification_url Até 87 caracteres String URL para Notificação definido pelo vendedor
telefone Até 15 caracteres Int Número de telefone ou celular do cliente
Exemplo: 1140638785
status Até 16 caracteres String

Retorna o status da fatura.

Esperado:

status significado
pending aguardando
canceled cancelado
paid aprovado
refunded estornado
Detalhes do pix_code
qrcode_base64 Esperado entre 1000 a 3000 caracteres String Imagem Codificada em Base64

Exemplo:
iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACxElEQVR4Xu2Xy20kMQ
xExUTE/LPYUKREpK1XMjDyHIw9uLmXEXr6o34GCmSRbLf98/rT3nfe1gc46wOc9QHO
+jdgtBace66uX+OYZ7MMmDpGjxWrx+g95ooRbFYCejzyhLTwo8/FgB54SbgIVM//AC
ByzqUMrfgKXS2gY67UGx3KVu4R3iwE8Od8X++ufn//ywBLPlWgpEuXlUNCz6oCRgsi
I6NKWmCcJoSA1QHyhlKl6k3ddkyrl05aHTCwScqkAyJ1Hr3RSCoBapUMhdU1WUVPaq
aFgFQSn1ATc6CkT0I3TaUMkKK0V4/S49h5LmWAZ0ly7RQsCVNrfwWqABiERmeblUZG
L2W4VgLkiDFC9SplDBaaSSUgBH0SZ5lOWd7JKgA00SSPiSZ5pElla7IQ2HgGTaoaak
aSVcB38T4PqGi0R9OQVuQh+S7eCsA9Q4UyCY+6iXKG0iwEhChPtLHNfEMjN/uK5OPA
9ERxdPxmuILH5agCYFK0vKObJ43VeCXgoMin1jaN0NRexVsAbL7sGtP0JIuy/ZasAk
A3cilxUYBWYBc5dl3Jeh6gXdDKV8e72tdGuJALgaSFUL30MtdQ51+SrATkDh3JeSpj
sqvCtS+RzwNO0UIZ1rFb0sILAT0oOkkjccX4sX1P1tOARG6qN0ElVLfyzZWsAmCxKa
sGv8VXL+VzB6oASDUNeVba0k7ZOPgu3gKgBy4lSuqei0Ju3EchwHc26ZG04IdA/iwL
ga8QdWpGucK9tJE7ks8DCo2UuXDtE+wj6CXyeYAOZr94tKmOWridVwIsjOqLhzvlfI
ksAIYVLQZJEJ/BZCFWhcCkhdExNFw3w+SIzFKAQT6UoX6SJfuge1YDgwZCF0+ShZEb
l1pApbtJ0OQbR2g6V3XA5hUN3XtU0tFcCNi01njqlrGmqnElVQE/rQ9w1gc46wOc9Q
vAX+6y+aZjvEg1AAAAAElFTkSuQmCC
emv Até 255 caracteres String Em resumo permite copiar o Código QrCode

Exemplo:
[email protected]
0102111000530398654036408B7C54520B5802BR5923
Pagamento%20de%20teste6304
pix_url Até 255 caracteres String Url onde é possível visualizar o Pix

Exemplo:
indisponivel
bacen_url Até 255 caracteres String Url Bacen Pix

Exemplo:
https://www.bcb.gov.br/content/estabilidadefinanceira/pix/
YuQkNCLlBJWDI1NTVhcGkuaXRhdS9waXgvcXIvdjEvY2U3Zjk3NDMtNjU3NS00OD
?txid=00020101021126540014example%40expaybrasil.
com0102111000530398654036408B7C54520B5802BR5923Pagamento%2520de%2520teste6304