Cards
Detalla la asignación de una tarjeta a un cliente final, dentro de un lote de tarjetas de Odybank. La tarjeta luego de ser asignada su estado es INACTIVE.
POST /api-hub/v1/client-cards/assign
Las credenciales otorgadas para realizar el login obtienen el producto el cual se le asignará al cliente final.
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
client_id*
String
El identificador del cliente debe de ser en formato UUID.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
Definición del response
status: El estado tiene que estar no activa, ya existe un endpoint que se encarga de activar la tarjeta de un cliente.
card_tracking_code: El código de seguimiento de la tarjeta, es generada desde Odybank.
{
"code": "00000",
"message": "Successful",
"data": {
"id": "176fb137-9298-be03-42f6-a31c4faa3616",
"status": "INACTIVE",
"created_at": "2022-09-22T20:01:19.095306+00:00",
"updated_at": "2022-09-22T20:01:21.587199+00:00",
"deleted_at": null,
"is_deleted": false,
"is_deleted_by": null,
"provider_name": "ODYBANK",
"card_tracking_code": "0332206224610292",
"merchant_product_id": "b349ee01-8d7d-6c51-ca3d-7b98deac14ac",
"client_id": "6e28b4dc-a81c-6464-8534-ec489c221a58",
"reason": null,
"currencies": [
{
"account": "0332206224610316",
"currency": "PEN"
}
],
"blocked_at": null,
"replacement_by": null,
"card_pan": "222980******0739"
}
}Detalla la activación de una tarjeta, el estado es modificado a ACTIVE.
PATCH /api-hub/v1/client-cards/activation
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code*
String
El código de seguimiento de la tarjeta.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
status : El estado ahora es activa.
{
"code": "00000",
"message": "Successful",
"data": {
"id": "176fb137-9298-be03-42f6-a31c4faa3616",
"status": "ACTIVE",
"created_at": "2022-09-22T20:01:19.095306+00:00",
"updated_at": "2022-09-22T20:01:21.587199+00:00",
"deleted_at": null,
"is_deleted": false,
"is_deleted_by": null,
"provider_name": "ODYBANK",
"card_tracking_code": "0332206224610292",
"merchant_product_id": "b349ee01-8d7d-6c51-ca3d-7b98deac14ac",
"client_id": "6e28b4dc-a81c-6464-8534-ec489c221a58"
}
}Detalla la información de una tarjeta.
GET /api-hub/v1/client-cards/details
Query Parameters
card_tracking_code*
String
El código de seguimiento de la tarjeta.
key_id*
UUID
El identificador de la llave, para encriptar los datos.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Definición del response
date_expiration: La fecha de caducidad de la tarjeta, se encuentra encriptada por seguridad.
number_card: El número de la tarjeta, se encuentra encriptada por seguridad.
{
"code": "00000",
"message": "Successful",
"data": {
"card_tracking_code": "0332206224610292",
"currency": {
"number": "604",
"string": "SOLES"
},
"date_block": "2022-09-28 20:21:09.16",
"date_expiration": "P0QFz5bJEWzjvdea7IalCnvZ7gJd9BqDB+K/fyLgO1k67IcpnI5ErwU7Hf5wHSCgUdrVmKfMR781HnoCBrXl/y0bwaVhYuvpJBPf+0qaj2VHarSsyd0PVlxwXCn98/TAAKOJlGBhnu8XaKlQviYp8XccjtHJ4zWzwzbl71uWkiRuamN9GzxcC8+eWNBEBwVkovUO+1Qc/YVfEVlG/Lx3EBeZ6Q4okg0bp5QAQ5/XNGVSme5ItBIFbp5hBF0PNsuMsGEp5+GHO8Ka2mZVvUUOHabkGsA0l0M33FONKEZZH1SU8InzJ3Pa00q5SqjqpdJ9xkPATyVhIxiGPsjsrvunaLtzIGGkZNobOzwhsbvQjX77Wxeh+JFOrXxbJmOCpSgm4caFvrv9KExecypQDFxQSVG2/NM3oTtgnMCwDnD8WZe7eP79Y4OjUpu05utPXbJeImBB3iYRt6qUmTQi+eStVSkyF5e6bPx8jRpTEK0pPrS9N8ekjoHuizRDYjwhHItaxHZpHAnbIRqleyg1rroctgqHGTRUxjbe/CQeWaQ99f3DFgDx1LvhE1HZpYfY2iyb0vy0ThpfdB+5njyg4bw1l6NpjL+RJQxEaPuwPr8CGgjigsxmMpfb8GHE8jGWgFw8Tx+O8uNaFCK7ROUtNYhIpIL+9Liw7k1Uk8DXZE60p3E=",
"number_card": "WlZlRE3yNmah3DSXA6eUozNp1vFEu9ROgX4RBcF3llYF+SChpDtXzoS05wC6aCQ3v1Pq1RbLM7xSwhoaQ5d4Ubihfc6NjBQbGbvs7gxgg+6y896A557cRdSE0l2wEs+oKzA3advpy45g+TEH4cY3SmCEkcFSC+F/+kWR3bs712PxgmzGSYFbwU/fDKyvo+FHwxW2dBM6j3xVwySVzDj2H26OlaKQTbIbnif7SoCu+sT7toQN2exxEZ9KWpcI8uiFed09a8OCO02auJWVZTOdoEFsg054y87LAaExEqAkeGSyA3ZMYUUXf8JbXbfzH0dhlT86POdccJ4eCMFHakzkm/hdh9UsGvhjnb/MKbI/Q7EW9XgPnGJa5EM5ttA7hV47mTg1ZSYFZtMmuplA6TC99cn7qO4MC6wsg+96IzH15WDGNR0Xp3FtWfOA5aNY7jLJvWhIoKRrD7foPnn6xCUafrdhttWbcfrIVOPh+bP+2rUG5Y1/kOWRmqgIEnLeh9g/mqBbJcr3NtvtdlaZNMgdhx4rtmRohD1gV53MgpkXaZma+dFrjmZvvat737NKlmVfZuGasox+L9Xz5hUQFwUYZ8tJK4DUMowA7ihrfdvwM3+1SSbjoj6ZKrUjFZEugAn6tx2dQlfkLnJffsXObWMITrC4RcCNmHcQLYr50n36h9s=",
"reason_block": "CANCELACIÓN",
"status": "CANCELED",
"status_description": "CANCELED (CANCELADA)"
}
}Detalla el cvv2 de una tarjeta.
GET /api-hub/v1/client-cards/cvv2
Query Parameters
card_tracking_code*
String
El código de seguimiento de la tarjeta.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
key_id*
UUID
El identificador de la llave, para encriptar los datos.
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Definición del response
cvv2: El código de seguridad de la tarjeta, se encuentra encriptada por seguridad.
{
"code": "00000",
"message": "Successful",
"data": {
"cvv2": "OUD6apORicAur/cM0plT4skz/ICWWLerdlyx5x3Z3Ltc4jJYfaHOipDQdT/IF1eSySmzfSwMlQY7lgsDQmmU8ZnGN3HrLbBUlpqOJpSednbcSQ0yH6v3CN+LIHaVKDdJNejibJjbKpKm/ZCD9CP7OWe9gm4c5qM7mop4wtE0stb/kutx9PJtxTTp4VfiGA/lC6jTwmy9zGuewRc/phKN9T3uru68Hrv+kaPVbIaOw4jg2sskALszImU5fJhNH1Aaj+mCLJ5tUgK6GoUQ25FxIY0Rfy8HMxSrFHVb9c7PqvmkFs6PWu4N4V3r7wx5nocAJw7MBesHuWJxXmOX3TGVHQeCQBNlOkkgGphp9uau4057amHjc7GyKppoBOczNUAdbxvE88N2i7RitZR/gZDTdsnTkY+9q0nurkxkDad2WXVnpOquAV7MIspCc2MWXlNSWUO9UJ3laFLRSSnynUZC8Q6rMzJcobPIbemOgKyrzrVS2NNIQbtiTvxZVD0WmUGCbYCSWoIoq/B0c+qufuLjpjdvL/2w/QDKKasYm2WB55wrgLVGq2/CAI7jFSBHBgw/iTxVR0Dm35zuYdEYyjqUBWGkAtvQrrsf+KC9rCS5DQ79kUfxYA5OhO0tD3mlNI0LaN7edMz+jek6ybbfQHh8pLgXS0aGHF1LLons1rKO8Zo="
}
}Detalla la información de las transacciones de una tarjeta.
GET /api-hub/v1/client-cards/transactions
Query Parameters
card_tracking_code*
String
El código de seguimiento de la tarjeta.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Definición del response
card_tracking_code : El código de seguimiento de la tarjeta.
{
"code": "00000",
"message": "Successful",
"data": [{
"sequence": "129877",
"type": "Compra ",
"amount": "179.40",
"cost": "0.00",
"hour": "16:58:32",
"date": "2022/10/07",
"commerce": "PLAZA VEA Lima PER",
"commerce_category": null,
"pan_trunc": "22298003****0071",
"currency": "PEN"
}]
}Detalla la suspensión de una tarjeta, el estado es modificado a SUSPENDED.
PATCH /api-hub/v1/client-cards/suspend
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code
String
Código de seguimiento de una tarjeta
timestamp
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
reason
String(50)
Razón de suspensión
Definición del response
status El estado ahora es SUSPENDED.
{
"code": "00000",
"message": "Successful",
"data": {
"id": "176fb137-9298-be03-42f6-a31c4faa3616",
"status": "SUSPENDED",
"created_at": "2022-09-22T20:01:19.095306+00:00",
"updated_at": "2022-09-28T17:07:47.926054+00:00",
"deleted_at": null,
"is_deleted": false,
"is_deleted_by": null,
"provider_name": "ODYBANK",
"card_tracking_code": "0332206224610292",
"merchant_product_id": "b349ee01-8d7d-6c51-ca3d-7b98deac14ac",
"client_id": "6e28b4dc-a81c-6464-8534-ec489c221a58"
}
}Detalla la activación de una tarjeta, el estado es modificado a BLOCKED.
PATCH /api-hub/v1/client-cards/blocked
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code*
String
Código de seguimiento de una tarjeta
reason*
String
Razón de bloqueo
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
Definición del response
status El estado ahora es BLOCKED.
{
"code": "00000",
"message": "Successful",
"data": {
"id": "176fb137-9298-be03-42f6-a31c4faa3616",
"status": "BLOCKED",
"created_at": "2022-09-22T20:01:19.095306+00:00",
"updated_at": "2022-09-28T17:07:47.926054+00:00",
"deleted_at": null,
"is_deleted": false,
"is_deleted_by": null,
"provider_name": "ODYBANK",
"card_tracking_code": "0332206224610292",
"merchant_product_id": "b349ee01-8d7d-6c51-ca3d-7b98deac14ac",
"client_id": "6e28b4dc-a81c-6464-8534-ec489c221a58"
}
}Detalla la cancelación de una tarjeta, el estado es modificado a CANCELED.
PATCH /api-hub/v1/client-cards/cancel
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code*
String
El código de seguimiento de la tarjeta.
reason*
String(50)
Razón (motivo) de cancelar
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
Definición del response
status El estado ahora es CANCELED.
{
"code": "00000",
"message": "Successful",
"data": {
"id": "176fb137-9298-be03-42f6-a31c4faa3616",
"status": "CANCELED",
"created_at": "2022-09-22T20:01:19.095306+00:00",
"updated_at": "2022-09-30T20:50:26.851541+00:00",
"deleted_at": null,
"is_deleted": false,
"is_deleted_by": null,
"provider_name": "ODYBANK",
"card_tracking_code": "0332206224610292",
"merchant_product_id": "b349ee01-8d7d-6c51-ca3d-7b98deac14ac",
"client_id": "6e28b4dc-a81c-6464-8534-ec489c221a58",
"reason": "Cancelación de prueba"
}
}Detalla la recarga de saldo de una tarjeta.
POST /api-hub/v1/client-cards/recharge-balance
Headers
authorization-token*
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code*
String
El código de seguimiento de la tarjeta.
currency*
String [PEN | USD]
ISO 4217. Actualmente solo hay para PEN y USD.
amount*
Decimal
El monto debe ser un decimal por punto. Ejemplo: 20.50. Si no contiene decimal mandar solo el entero 20.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
{
"code": "00000",
"message": "Successful",
"data": {
"transaction_id": "83fg7e0c-1b68-5t07-4ac9-b3106faf537a",
"sequence": "1231444234"
}
}Detalla el debito de una tarjeta (cash out).
POST /api-hub/v1/client-cards/cash-out-balance
Headers
authorization*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code*
String
El código de seguimiento de la tarjeta.
currency*
String [PEN | USD]
ISO 4217. Actualmente solo hay para PEN y USD.
amount*
Decimal
El monto debe ser un decimal por punto. Ejemplo: 20.50. Si no contiene decimal mandar solo el entero 20.
timestamp*
Number String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
{
"code": "00000",
"message": "Successful",
"data": {
"transaction_id": "83ff7e0c-5b68-5c07-4ac9-b0106faf457a",
"sequence": "123123237"
}
}Muestra el saldo de una tarjeta
GET /api-hub/v1/client-cards/balance
Query Parameters
card_tracking_code*
String
El código de seguimiento de la tarjeta.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
La firma depende del timestamp y el secret-key.
Definición del response
card_tracking_code : El código de seguimiento de la tarjeta.
{
"code": "00000",
"message": "Successful",
"data": {
"sequence": "000409",
"currency": "PEN",
"balance": "1812.10"
}
}Reposición de tarjeta (Bloqueada)
POST /api-hub/v1/client-cards/replacement-card
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code_blocked*
String
El código de seguimiento de la tarjeta bloqueada.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
{
"code": "00000",
"message": "Successful",
"data": {
"id": "d336849b-e8ca-07fe-58b2-b10cbf0ce2b6",
"status": "INACTIVE",
"created_at": "2022-10-17T22:46:21.658455+00:00",
"updated_at": "2022-10-17T22:46:21.658455+00:00",
"deleted_at": null,
"is_deleted": false,
"is_deleted_by": null,
"provider_name": "ODYBANK",
"card_tracking_code": "0332206224610316",
"merchant_product_id": "b349ee01-8d7d-6c51-ca3d-7b98deac14ac",
"client_id": "6e28b4dc-a81c-6464-8534-ec489c221a58",
"reason": null,
"currencies": [
{
"account": "0332206224610316",
"currency": "PEN"
}
],
"blocked_at": null,
"replacement_by": null,
"card_pan": "222980******0739"
}
}Transferencia de saldo tarjeta a tarjeta
POST /api-hub/v1/client-cards/transfer-balance-card-to-card
Headers
authorization-token*
String
Se envía el token generado luego del Login, se debe enviar con el siguiente formato:
"Bearer JHgytHG67687JHG..."
signature*
String
La firma depende del timestamp y el secret-key.
Request Body
card_tracking_code_target*
String
Código de seguimiento de la tarjeta de destino, a la cual se le abonara el monto
card_tracking_code_source*
String
Código de seguimiento de la tarjeta de origen, de la cual se debitará el monto
currency*
String [PEN | USD]
ISO 4217. Actualmente solo hay para PEN y USD.
amount*
Decimal
El monto debe ser un decimal por punto. Ejemplo: 20.50. Si no contiene decimal mandar solo el entero 20.
timestamp*
String
El valor debe ser en formato NOW comprendido por 13 dígitos, en javascript se puede usar la función Date.now() = 1664568045547
{
"code": "00000",
"message": "Successful",
"data": {
"transaction_id": "83ff7e0c-5b68-5c07-4ac9-b0106faf457a",
"sequence": "123123237"
}
}Last updated