Cuentas

Crear cuenta

El endpoint /core/accounts/v1 te permite crear una cuenta digital para un usuario de Pomelo.
Parámetros disponibles
Header Parameters
X-Idempotency-Keystringrequired
Identificador idempotente de creación de cuenta. Deberás generar este valor para cada cuenta que quieras crear. Si dos requests idénticos tienen el mismo identificador de idempotencia solo crearás una cuenta, aunque ambos reciban una respuesta exitosa.
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
owner_typestringrequired
Tipo de dueño de la cuenta.
Ejemplo: USER
Enum: USERCLIENT
user_idstring
ID del titular de la cuenta. Este campo es requerido si se trata de una cuenta de usuario.
Ejemplo: usr-20I2tIqG3buTsvHKKORrtY2MkFH
company_idstring
ID de la compañia titular de la cuenta. Este campo es requerido si se trata de una cuenta para persona juridica.
Ejemplo: cmp-MdUfg48A2H2rvoX7CV3toE0Z72fX
countrystringrequired
País de la cuenta.
Enum: ARGBRAMEX
currencystringrequired
Moneda de la cuenta.
Enum: ARSBRLMXN
metadataobject
Es un campo opcional para que puedas agregar los datos extra que quieras.
Ejemplo: {"extra_property_1":"My value"}
Detalle de respuestas
dataobjectrequired

¿Te resultó útil esta sección?

POST/core/accounts/v1
{
"owner_type":
"USER"
"user_id":
"usr-20I2tIqG3buTsvHKKORrtY2MkFH"
"company_id":
"cmp-MdUfg48A2H2rvoX7CV3toE0Z72fX"
"country":
"ARG"
"currency":
"ARS"
"metadata":{
"extra_property_1":
"My value"
}
}
Ejemplo de respuestas
{
"data":{
"id":
"acc-20I5vMjljS3VEyafcX8lA3T3g0c"
"country":
"ARG"
"data":{
...
}
"currency":
"ARS"
"metadata":{
...
}
"status":
"ACTIVE"
"owner_type":
"USER"
"owner_data":{
...
}
"created_at":
"2024-05-22T16:50:58.143Z"
}
}

Eliminar Cuenta

El endpoint /core/accounts/v1/{id} te permitirá eliminar una cuenta específica. Al hacerlo, su estado pasará a DELETED y ya no se podrá usar para hacer transacciones.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
status_update_motivestringrequired
Enum: OTHERINTERNAL_REASONUSER_REQUESTFRAUD
status_update_commentstring(maxLength: 512, minLength: 0)
Este campo es obligatorio cuando el status_update_motive es OTHER.
Ejemplo: Motivo de actualización del estado de la cuenta.
Path Parameters
idstring(maxLength: 256, minLength: 0)required
Ejemplo: acc-20I4qJinTCudWvJULZygeC257wy
Detalle de respuestas
dataobjectrequired

¿Te resultó útil esta sección?

DELETE/core/accounts/v1/{id}
{
"status_update_motive":
"OTHER"
"status_update_comment":
"Motivo de actualización del estado de la ..."
}
Ejemplo de respuestas
{
"data":{
"id":
"acc-20I5vMjljS3VEyafcX8lA3T3g0c"
"country":
"ARG"
"data":{
...
}
"currency":
"ARS"
"metadata":{
...
}
"status":
"DELETED"
"owner_type":
"USER"
"owner_data":{
...
}
"created_at":
"2024-05-22T16:50:58.144Z"
"updated_at":
"2024-05-22T16:50:58.144Z"
"status_update_motive":
"OTHER"
"status_update_comment":
"Motivo de actualizacion del estado de la ..."
}
}

Actualizar estado de cuenta

El endpoint /core/accounts/v1/{id} te servirá para cambiar el estado de una cuenta. Los estados de la cuenta pueden alterarse entre ACTIVE, FROZEN o DISABLED. Para los últimos dos estados es necesario indicar el motivo del cambio de estado utilizando la propiedad status_update_motive.Encuentra más información sobre los estados de una cuenta en nuestra documentación.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
statusstringrequired
Enum: ACTIVEDISABLEDFROZEN
status_update_motivestring
Este campo es obligatorio cuando el status no es ACTIVE.
Enum: OTHERLOSTINTERNAL_REASONSTOLENFRAUDINHIBITIONSEIZUREUSER_REQUEST
status_update_commentstring(maxLength: 512, minLength: 0)
Este campo es obligatorio cuando el status_update_motive es OTHER.
Ejemplo: Motivo de actualización del estado de la cuenta.
Path Parameters
idstringrequired
Ejemplo: acc-20I4qJinTCudWvJULZygeC257wy
Detalle de respuestas
dataobjectrequired

¿Te resultó útil esta sección?

PATCH/core/accounts/v1/{id}
{
"status":
"ACTIVE"
"status_update_motive":
"OTHER"
"status_update_comment":
"Motivo de actualización del estado de la ..."
}
Ejemplo de respuestas
{
"data":{
"id":
"acc-20I5vMjljS3VEyafcX8lA3T3g0c"
"country":
"ARG"
"data":{
...
}
"currency":
"ARS"
"metadata":{
...
}
"status":
"ACTIVE"
"owner_type":
"USER"
"owner_data":{
...
}
"created_at":
"2024-05-22T16:50:58.145Z"
"updated_at":
"2024-05-22T16:50:58.145Z"
"status_update_motive":
"OTHER"
"status_update_comment":
"Motivo de actualización del estado de la ..."
}
}