Pular para o conteúdo principal

Simular Pagamento de Cobrança Pix

Realiza a simulação do pagamento de uma cobrança Pix para fins de teste. Para fazê-lo deve ser efetuada a chamada para o serviço de simulação de pagamento de cobrança Pix, enviando como parâmetro o identificador único (transaction_id).

aviso

Disponível apenas em ambiente Sandbox.
NÃO DISPONÍVEL EM PRODUÇÃO.

Request​

A chamada deverá ser feita utilizando o método GET.

URL
{BaseUrl}/api/v1/pix/collections/:transaction_id/simulate
HTTP Headers - Exemplo:
Authorization: Basic {base64(client_id:client_secret)}
Content-Type: application/json
Exemplo cURL - bash:
curl -X GET https://api.moneyguard.com.br/api/v1/pix/collections/QR-abc123def456/simulate
    -H "Authorization: Bearer seu_access_token" \
    -H "User-Agent: seu_user_agent"

Response​

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo
{
    "status": "ok"
}

Descrição dos Atributos​

ATRIBUTODESCRIÇÃOTIPO
status
(Obrigatório)		Status da requisiçãoSTRING
limite de 255 caracteres

Error​

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido invalidada.

HTTP 404 Response Body - Exemplo
{
    "error": "Qrcode not found."
}