Retornar Cash-In por Id

Para retornar os parâmetros pix_copy_paste e pix_image_base64 de uma operação Cash-In, é necessário passar o cash_in_id no PATH da URL.

GETv1/chash-in/:cash_in_id

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 cash-in. Valores possíveis: paid, failed, cancelled e expired.
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.
customer_name	string	Nome do cliente pagante.
customer_document_number	string	Número do documento do cliente pagador.
pix_copy_paste	string	String para o cliente copiar e colar para efetuar o pagamento no aplicativo do banco.
pix_image_base64	string	String para criar o QR Code na UI da sua aplicação para o cliente efetuar o pagamento no aplicativo do banco.

Exemplos

Cash-In Found

Request

curl -X GET -G "https://api.pix.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-10-05T12:51:47.457Z",
  "date_updated": "2023-10-05T12:51:47.457Z",
  "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.pix.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."
  }
}