Referência da API

Estornar parcela

A partir deste endpoint, inicie a solicitação de estorno sem a nescessidade de entrar em contato com a raims pay. Este endpoint facilita o processo de estorno, sendo obrigatório apenas o identificador da parcela que desejar estornar ( digitado na url ).

É possivel definir um motivo para o estorno no campo "reason":
BE08: Devolvido como resultado de um erro bancário.
FR01: Devolução por suspeita de fraude.
MD06: Devolução solicitada pelo cliente final.
SL02: Devolução do valor em dinheiro devido a um erro relacionado ao Pix Saque ou Pix Troco

Ao enviar o json sem nenhuma chave ( vazio ), entenderemos que deve ser estornado o valor total pago e que o motivo foi uma solicitação do cliente.

{
}

Segue abaixo uma forma de estornar R$ 18.50. Devolvido como resultado de um erro bancário ( BE08 )

{
  "amount":18.50,
  "reason":"BE08"
}

Caso nenhum de nossos códigos de motivo seja exatamente a razão do estorno, você poderá escolher uma que melhor se adapta e preencher os campos opcionais:
reversalDescription - Informar ao cliente o motivo do estorno
additionalInformation - Informar a RaimsPay o motivo do estorno.

Segue abaixo, uma forma de estornar R$ 15.30, Devolução solicitada pelo cliente final ( MD06 ).

{
  "amount": 15.30,
  "reason":"MD06",
  "reversalDescription":"Estorno referente a venda do computador.",
  "additionalInformation": "Cliente insatesfeito com o produto solicitou estorno."
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 32 and 32
^[a-zA-Z0-9]+$

Identificador único digitado no patch da URL.

Ex: 0e01234567890b01ed0123456fghi1cf0

Body Params
float

Valor a ser estornado
Ex: 50.80

string | null
enum
Defaults to MD06

Código da razão do extorno ( o que melhor explicar )

BE08: Devolvido como resultado de um erro bancário.
FR01: Devolução por suspeita de fraude.
MD06: Devolução solicitada pelo cliente final.
SL02: Devolução do valor em dinheiro devido a um erro relacionado ao Pix Saque ou Pix Troco
Ex: MD06

Allowed:
string | null
Defaults to null

Explicação sobre o estorno para o cliente.
Ex: Extorno da parcela 0e01234567890b01ed0123456fghi1cf0

string | null

Explicação sobre o estorno para a Raims.
Ex: Cliente insatisfeito com o produto.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json