Retornar Cash-Out por Id

Esta rota pode ser usada para verificar uma operação específica de Cash-Out com o array operations contendo todos os status de atualização com suas datas e horários.

GETv1/chash-out/:cash_out_id

Request Variável Path

Atributo	Tipo	Descrição
cash_out_id	string	Marlim ID da operação Cash-Out.

Response Object

Propriedade	Tipo	Descrição
status	string	Representa o estado atual da operação de saque. Valores possíveis: processing, fulfilled, pending, failed e cancelled.
status_description	string	Descrição para esclarecer sobre o status da transferência.
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.
cash_out_id	string	Número identificador da operação Marlim.
amount	int32 || float	Valor a ser transferido para a conta do cliente.
paid_off_amount	int32 || float	Valor final transferido para a conta do cliente de acordo com o status atual.
customer_name	string	Nome da pessoa responsável pela conta de transferência.
customer_document_number	string	Número do documento do responsável pela conta de transferência.
operations	array	Objetos contendo todos os status do mais novo ao mais antigo.

Samples

Cash-Out Encontrado

Request

curl -X GET -G "https://api.pix.marlim.co/v1/chash-out/1xC3EH9OKNLk9GH5FfA1" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response200

{
  "status": "fulfilled",
  "status_description": "Transfer completed successfully and the amount was transferred to the customer's account.",
  "date_created": "2023-01-01T00:00:00.000Z",
  "date_updated": "2023-01-01T02:00:00.000Z",
  "cash_out_id": "1xC3EH9OKNLk9GH5FfA1",
  "amount": 250,
  "paid_off_amount": 250,
  "customer_name": "Leia S. O. Solo",
  "customer_document_number": "99988877766",
  "operations": [
    {
      "operation_at": "2023-01-01T02:00:00.000Z",
      "type": "fulfilled"
    },
    {
      "operation_at": "2023-01-01T01:00:00.000Z",
      "type": "pending"
    },
    {
      "operation_at": "2023-01-01T00:00:00.000Z",
      "type": "processing"
    }
  ]
}

Cash-Out Não Encontrado

Request

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

Response400

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