Read Cash-In by ID

To return the pix_copy_paste and pix_image_base64 parameters of a Cash-In operation, it is necessary to pass the cash_in_id in the PATH URL.

GETv1/chash-in/:cash_in_id

Request Variable Path

Attribute	Type	Description
cash_in_id	string	Marlim ID of the Cash-In operation.

Response Object

Property	Type	Description
status	string	Represents the current state of the cash-in. Possible values: paid, failed, cancelled, and expired.
cash_in_id	string	Marlim operation identifier number.
item_id	string	Charge/Order ID on your platform.
date_created	dateTime	Operation creation date in ISODateTime format.
date_updated	dateTime	Operation status updated date in ISODateTime format.
amount	int32 || float	Amount to be charged to the paying customer.
paid_amount	int32 || float	Amount paid by the paying customer.
customer_name	string	Paying customer name.
customer_document_number	string	Paying customer document number.
pix_copy_paste	string	String for the customer to copy and paste to make the payment in the bank application.
pix_image_base64	string	String to create the QR Code in the UI of your application for the customer to make the payment in the bank application.

Samples

Cash-In Found

Request

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

Response200

{
  "status": "active",
  "cash_in_id": "os7WT0bCGbWxAjAv2eT6",
  "item_id": "123456789",
  "date_created": "2023-09-11T12:30:28.777Z",
  "date_updated": "2023-09-11T12:30:28.777Z",
  "amount": 10,
  "paid_amount": 0,
  "customer_name": "Luke Skywalker",
  "customer_document_number": "00099988877",
  "pix_copy_paste": "00020101021226930014 --- 6304B67D",
  "pix_image_base64": "iVBORw0KGgoAAAANSUhE --- rkJggg=="
}

Cash-In Not Found

Request

curl -X GET -G "https://api.bet.marlim.co/v1/chash-in/sameOtherId" \
-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."
  }
}