Estornar um Cash-In Pix

Endpoint dedicado para estornar uma transação paga utilizando meio de pagamento Pix, é necessário passar o cash_in_id no PATH da URL.

POST/v1/chash-in/:cash_in_id/refund

Request Variável Path

Atributo	Tipo	Descrição
cash_in_id	string	ID Marlim da operação Cash-In.

Response Object

Propriedade	Tipo	Descrição
status	string	Representa o estado atual do estorno cash-in. Valores possíveis: processing.
cash_in_id	string	Número identificador da operação Marlim.
item_id	string	ID de cobrança/pedido em sua plataforma.
date_created	dateTime	Data de criação da operação no formato ISODateTime.
date_updated	dateTime	Data de atualização do status da operação no formato ISODateTime.
amount	int32 || float	Valor a ser cobrado do cliente pagante.
paid_amount	int32 || float	Valor pago pelo cliente pagante.
refunded_amount	int32 || float	Valor estornado pelo cliente pagante.
customer_name	string	Nome do cliente pagante.
customer_document_number	string	Número do documento do cliente pagador.

Webhooks

Todo o processo de alteração do status de uma operação de estorno é assíncrono. Portanto, é importante que você passe um webhook_url durante o processo de criação de uma operação para que sua aplicação receba todas as alterações de status. Esta url da sua aplicação pode ser aberta para receber payloads dos Servidores Marlim (você pode validar os payloads recebidos pela nossa aplicação), ou caso esta url exija autenticação, você pode passar um webhook_auth_token para o Marlim enviar os webhooks com autenticação no HEADER da requisição.

Valor	Descrição
refunded	Operação estornada com sucesso.

info

Se for passado algum valor no parâmetro webhook_auth_token a Marlim vai enviar o token para a sua aplicação usando o padrão no Header da requisição: Authorization: Bearer {webhook_auth_token}.

Exemplos

Estorno Autorizado

Request

curl -X POST -G "https://api.pix.marlim.co/v1/chash-in/os7WT0bCGbWxAjAv2eT6/refund" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response200

{
  "status": "processing",
  "cash_in_id": "os7WT0bCGbWxAjAv2eT6",
  "item_id": "123456789",
  "date_created": "2023-12-08T17:36:19.683Z",
  "date_updated": "2023-12-08T17:36:19.683Z",
  "amount": 10,
  "paid_amount": 10,
  "refunded_amount": 0,
  "customer_name": "Luke Skywalker",
  "customer_document_number": "00099988877"
}

Cash-in Não Encontrado

Request

curl -X POST -G "https://api.pix.marlim.co/v1/chash-in/sameOtherId/refund" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response400

{
  "errors": {
    "type": "not_found",
    "message": "Cash-In with ID 'sameOtherId' was not found."
  }
}

Cash-in Ainda Não Foi Pago

Request

curl -X POST -G "https://api.pix.marlim.co/v1/chash-in/sameOtherId/refund" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response400

{
  "errors": {
    "type": "forbidden_refund",
    "message": "You cannot request a refund for a transaction that has not yet been paid."
  }
}