All operations regarding money are mapped as a Transaction on our platform.
Transactions have TransactionEvents which happen along the Transaction lifetime.
This is what a transaction would look like in terms of payload (in this case, a PIX Transaction):
{
"transaction": {
"id": "123-456-789",
"merchant_id": "123-456-789",
"user_id": "123-456-789",
"processor_id": "123-456-789",
"merchant_transaction_id": "0000001",
"transaction_type": "pix",
"first_name": "Foo",
"last_name": "Bar",
"email": "[email protected]",
"updated_at": "2022-02-02T21:36:03+0000",
"created_at": "2022-02-02T21:34:07+0000",
"events": [
{
"id": "123-456-789",
"success": true,
"event_type": "capture",
"amount": "1.00",
"qrcode": null,
"qrcode_image": null,
"pix_key_type": null,
"pix_key_value": null,
"pix_message": null,
"updated_at": "2022-02-02T21:36:03+0000",
"created_at": "2022-02-02T21:36:03+0000"
},
{
"id": "123-456-789",
"success": true,
"event_type": "auth",
"amount": "1.00",
"processor_transaction_id": "123-456-789",
"qrcode": "COPYPASTEPIXCODE",
"qrcode_image": "data:image/png;base64,123123456546789789",
"pix_key_type": null,
"pix_key_value": null,
"pix_message": null,
"updated_at": "2022-02-02T21:34:10+0000",
"created_at": "2022-02-02T21:34:07+0000"
}
],
"status": "success",
"flow_type": "cashin",
"error": "null",
"e2e_id": "E11647HHHDHBDBDHDBBB"
}
}
You can find more details exploring the endpoints in the following sessions.