Solicitar devolução.

PUT

/pix/{e2eid}/devolucao/{id}

Pix

Endpoint para solicitar uma devolução através de um e2eid do Pix e do ID da devolução. O motivo que será atribuído à PACS.004 será "MD06" ou "SL02" de acordo com a aba RTReason da PACS.004 que consta no Catálogo de Mensagens do Pix a depender da natureza da devolução (Vide a descrição deste campo).

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://infopago.apidog.io//pix//devolucao/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "valor": "7.89"
}'

Response Example

201 - Exemplo de devolução 1

{
    "id": "123456",
    "rtrId": "D12345678202009091000abcde123456",
    "valor": "7.89",
    "horario": {
        "solicitacao": "2020-09-11T15:25:59.411Z"
    },
    "status": "EM_PROCESSAMENTO"
}

Requisição

Parâmetros Path

e2eid

string

requerido

string

requerido

Parâmetros Bodyapplication/json

valor

string

Valor

requerido

Valor solicitado para devolução. A soma dos valores de todas as devolucões não podem ultrapassar o valor total do Pix.

Padrão de combinação:

\d{1,10}\.\d{2}

natureza

enum<string>

opcional

Indica qual é a natureza da devolução solicitada. Uma solicitação de devolução pelo usuário recebedor pode ser relacionada a um Pix
comum (com código: MD06 da pacs.004), ou a um Pix de Saque ou Troco (com códigos possíveis: MD06 e SL02 da pacs.004). Na ausência
deste campo a natureza deve ser interpretada como sendo de um Pix comum (ORIGINAL).

As naturezas são assim definidas:

ORIGINAL: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix comum ou ao valor da compra em um Pix Troco (MD06);

RETIRADA: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix Saque ou ao valor do troco em um Pix Troco (SL02).

Os valores de devoluções são sempre limitados aos valores máximos a seguir:

Pix comum: o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso deve ser: ORIGINAL);

Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: RETIRADA); e

Pix Troco: o valor da devolução é limitado ao valor relativo à compra ou ao troco:

Quando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser ORIGINAL); e

Quando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser RETIRADA).

Valores permitidos:

ORIGINALRETIRADA

descricao

string

Mensagem ao pagador relativa à devolução.

opcional

O campo descricao, opcional, determina um texto a ser apresentado ao pagador contendo informações sobre a devolução. Esse texto será preenchido, na pacs.004, pelo PSP do recebedor, no campo RemittanceInformation. O tamanho do campo na pacs.004 está limitado a 140 caracteres.

<= 140 Caracteres

Examples

Respostas

🟢201Created

application/json

Dados da devolução.

Body

string

requerido

Id gerado pelo cliente para representar unicamente uma devolução.

Padrão de combinação:

[a-zA-Z0-9]{1,35}

rtrId

string

RtrId

requerido

ReturnIdentification que transita na PACS004.

>= 32 Caracteres<= 32 Caracteres

Exemplo:

D12345678202009091000abcde123456

Padrão de combinação:

[a-zA-Z0-9]{32}

valor

string

Valor a devolver.

requerido

Valor a devolver.

Padrão de combinação:

\d{1,10}\.\d{2}

natureza

enum<string>

opcional

Indica qual é a natureza da devolução. Uma devolução pode ser relacionada a um Pix comum (com códigos possíveis: MD06, BE08 e FR01 da pacs.004),
ou a um Pix de Saque ou Troco (com códigos possíveis: MD06 e SL02 da pacs.004). Na ausência deste campo a natureza deve ser interpretada como
sendo de um Pix comum (ORIGINAL).

As naturezas são assim definidas:

ORIGINAL: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix comum ou ao valor da compra em um Pix Troco (MD06);

RETIRADA: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix Saque ou ao valor do troco em um Pix Troco (SL02);

MED_OPERACIONAL: quando a devolução ocorre no âmbito do MED por motivo de falha operacional e se refere a um Pix comum (BE08);

MED_FRAUDE: quando a devolução ocorre no âmbito do MED por fundada suspeita de fraude e se refere a um Pix comum (FR01).

Os valores de devoluções são sempre limitados aos valores máximos a seguir:

Pix comum: o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso pode ser: ORIGINAL, MED_OPERACIONAL ou MED_FRAUDE);

Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: RETIRADA); e

Pix Troco: o valor da devolução é limitado ao valor relativo à compra ou ao troco:

Quando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser ORIGINAL); e

Quando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser RETIRADA).

Valores permitidos:

ORIGINALRETIRADAMED_OPERACIONALMED_FRAUDE

descricao

string

Mensagem ao pagador relativa à devolução.

opcional

<= 140 Caracteres

horario

object

requerido

solicitacao

string <date-time>

Horário de solicitação

opcional

Horário no qual a devolução foi solicitada no PSP.

liquidacao

string <date-time>

Horário de liquidacao

opcional

Horário no qual a devolução foi liquidada no PSP.

status

enum<string>

Status

requerido

Status da devolução.

Valores permitidos:

EM_PROCESSAMENTODEVOLVIDONAO_REALIZADO

motivo

string

Descrição do status.

opcional

Status da Devolução

Campo opcional que pode ser utilizado pelo PSP recebedor para detalhar os motivos
de a devolução ter atingido o status em questão.
Pode ser utilizado, por exemplo, para detalhar o motivo de a devolução não ter sido realizada.

<= 140 Caracteres

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🔴503Service Unavailable

Página anterior

Consultar Pix recebidos.

Próxima página

Consultar devolução.