RECEIPTS
Servicio para la administración de comprobantes. Por medio de este endpdoint se podrán informar depósitos y solicitar extracciones.
POST/ withdraw-requests
Endpoint para solicitar una extracción de la cuenta comitente, hacia su cuenta bancaria.
- URL del Endpoint:
POST/{{baseUrl}}/api/receipts/withdraw-requests/
Campo | Tipo | Descripción |
---|---|---|
investment_account_id | int | Código del comitente en ApiBroker. |
currency_id | str | Master-tables: currencies. |
amount | float | Importe de la transacción. |
bank_account_id | int | Código identificador de la cuenta bancaria. |
external_id | str | Identificador único de la petición. Lo envía el cliente, y sirve para evitar duplicados |
created_at | datetime | Fecha de la creación de la solicitud. |
updated_at | datetime | Fecha de última actualización de la solicitud. |
status_id | str | Estado de la solicitud. |
status_message | str | Mensaje acerca del estado de la extracción. |
Posibles estados de la extracción:
status_id | descripción |
---|---|
IN_PROGRESS | En proceso. |
REJECTED | Rechazada. |
COMPLETED | Completada. |
Request:
{
"investment_account_id": "int",
"currency_id": "str",
"amount": "float",
"bank_account_id": "int",
"external_id": "str"
}
Response:
{
"items": [
{
"withdraw_request_id": "int",
"investment_account_id": "int",
"currency_id": "str",
"amount": "float",
"bank_account_id": "int",
"status_id": "str",
"status_message": "str",
"created_at": "datetime",
"updated_at": "datetime",
"external_id": "str"
}
]
}
GET/ withdraw-requests
Endpoint para consultar los datos y el estado de una solicitud de extracción.
- URL del Endpoint:
GET/{{baseUrl}}/api/receipts/withdraw-requests/
Donde se enviara por pathParam el "withdraw_request_id"
Request:
- URL del Endpoint:
GET/{{baseUrl}}/api/receipts/withdraw-requests/{withdraw_request_id}/
Response:
{
"items": [
{
"withdraw_request_id": "int",
"investment_account_id": "int",
"currency_id": "str",
"amount": "float",
"bank_account_id": "int",
"status_id": "str",
"status_message": "str",
"created_at": "datetime",
"updated_at": "datetime",
"external_id": "str"
}
]
}