This document describes the expected response from an API call that generates a transfer.
JSON
{
"success": true,
"msg": "Transfer generated with success",
"body": {
"id": "a1b2c3d4-5678-90ab-cdef-1234567890ac",
"original_amount": 120.75,
"status": "created",
"amount": 120.75,
"resource": "transfer",
"type": null,
"method": "p2p|pix|brcode|manual",
"reference_id": null,
"tax_value": 0,
"fees_client": 0,
"client": {
"id": "z9y8x7w6-v5u4-t3s2-r1q0-p9o8i7u6y5t6",
"taxpayer_id": "98765432100",
"name": "Maria Silva Oliveira"
},
"transaction": {
"id": "1a2b3c4d-5678-90ef-ghij-klmnopqrstuy",
"resource": "transfer",
"type": "p2p",
"end_to_end_id": null,
"amount": "120.7500",
"descripition": null,
"created_at": "2025-02-04T15:00:00.000000Z",
"updated_at": "2025-02-04T15:00:00.000000Z",
"description": null
},
"part_Key_id": null,
"part_name": "Fernando Lima Souza",
"part_taxpayer_id": "**\*.123.456-**",
"part_bank_name": "XYZBank",
"part_account_type": "checking",
"part_Branch_code": "1234",
"part_account_number": "567890123457",
"part_bank_code": "00123456",
"description": null,
"created_at": "2025-02-04 12:00:00",
"updated_at": "2025-02-04 12:00:00"
}
}Attribute Description success (boolean)Indicates whether the transfer was successfully generated. msg (string)Return message indicating the status of the operation.
Attribute Description id (string)Unique identifier of the generated transfer. original_amount (int)Original transfer amount before fees. status (string)Current status of the transfer, e.g.: 'created'. amount (int)Total transfer amount after fees. resource (string)Related resource type, in this case, 'transfer'. type (string | null)Type of transfer; may be null. method (string)Transfer method used, e.g.: 'p2p'. reference_id (string | null)Reference ID, if applicable. tax_value (float)Amount of fees applied to the transfer. fees_client (float)Amount of fees charged to the client.
Attribute Description id (string)Unique identifier of the client. taxpayer_id (string)Client's CPF or CNPJ, unformatted. name (string)Full name of the client.
Attribute Description id (string)Unique identifier of the transaction. resource (string)Type of resource, e.g.: 'transfer'. type (string)Type of transaction, e.g.: 'p2p'. end_to_end_id (string | null)End-to-end ID of the transaction. amount (string)Transaction amount in decimal format. description (string | null)Optional description of the transaction. created_at (string)Date and time of transaction creation in ISO 8601 format. updated_at (string)Date and time of last update in ISO 8601 format.
Attribute Description part_Key_id (string | null)Counterparty key ID, if applicable. part_name (string)Full name of the counterparty. part_taxpayer_id (string)CPF or CNPJ of the counterparty, partially masked for privacy. part_bank_name (string)Name of the counterparty's bank. part_account_type (string)Type of counterparty's account, e.g.: 'checking'. part_Branch_code (string)Counterparty bank branch code. part_account_number (string)Counterparty account number. part_bank_code (string)Counterparty bank code. description (string | null)Optional description of the transfer. created_at (string)Date and time of transfer record creation. updated_at (string)Date and time of last update to the transfer record.
