Read Cash-Out by ID

This route can be used to check a specific Cash-Out operation with the operations array containing all update statuses with their dates and times.

GETv1/chash-out/:cash_out_id

Request Variable Path

Attribute	Type	Description
cash_out_id	string	Marlim ID of the Cash-Out operation.

Response Object

Property	Type	Description
status	string	Represents the current state of the cash-out operation. Possible values: processing, fulfilled, pending, failed and cancelled.
status_description	string	Description to clarify about the status of the transfer.
date_created	dateTime	Operation creation date in ISODateTime format.
date_updated	dateTime	Operation status updated date in ISODateTime format.
cash_out_id	string	Marlim operation identifier number.
amount	int32 || float	Amount to be transferred to the customer account.
paid_off_amount	int32 || float	Final amount transferred to the customer's account according to the current status.
customer_name	string	Name of person responsible for the transfer account.
customer_document_number	string	Document number of the person responsible for the transfer account.
operations	array	Objects containing all statuses from newest to oldest.

Samples

Cash-Out Found

Request

curl -X GET -G "https://api.bet.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 Not Found

Request

curl -X GET -G "https://api.bet.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."
  }
}