Versions Compared

Old Version 23

changes.mady.by.user Alejandro Martínez

Saved on

compared with

New Version Current

changes.mady.by.user Ángeles Díaz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

IMPORTANTE:

El servicio de Aggregation es el que se usarán para las pruebas correspondientes en ambientes de QA y ST:

Account + Customer en Genesys

Card en Spin

Detalle de endpoints

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

Ejemplo body:

El detalle que se muestra es el camino deseado (happy path) de los endpoints desarrollados.

El código esperado es un 200 + un body, en estos casos

Ejemplo de body - EnableToken (POST /tokens/key):

Body - Request

{

    "deviceId": "15703c1c-352a-11ee-be56-0242ac120002",

    "keyId": "05616256-352a-11ee-be56-0242ac120002",

    "publicKey": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCR9+qdg/HrRLzgkbphCnQpN+NscOEY8vQO/M+/U4erX3ZK9IcV9MulLyY4faIBV2LeJpeUDzemFygjz/e+as6gKjbrJ7jHldl0stpfyUv6Se5iwC2wunevURLjnyk31Af9QtJr5KGsNrtyVzNYis92LGUY64tHEVNoL6DmrD/JJwIDAQAB",

    "publicKeyAlgorithm": "RSA"

}

 

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#FFBDAD

Body - Response

{

"seed": "PGh9l4M6kfEWQPSAlB2ELD9p1GTMZ/lQSzkBg2n/lhTOsZtNh2lvhoRkCCBnsGuZgjBGPIfHFye3yi/b5YUKl+2CA673Fg66WruKTU58ywk/rZYUKXOku2NI8PliZG9P9/nrgrZ75D5SxsuUv0DIj8A0WfdYu16PLFnH4MGhD6A="

}

Mirror

Account

Info

Consulta de bloqueos​

Repositorio sincronizado con Fiserv​

Disminuye peticiones al Proveedor​

GetAccountDetails

...

Descripción

...

Request

...

Response

...

Aggregation

Estos son los componentes que se estarán usando para la ejecución de pruebas en el proyecto:

Account Aggregation Service

Info

Incorpora los servicios de Account Mirror y Balance Mirror​

Validación de campos mandatorios antes del envío a Fiserv​

Expone endpoints a través de un API REST y gRPC​

POST → /v1/accounts/details

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza la consulta de bloqueos de cuenta Activa

Code Block
{
  "accountNumber": "9500507060523627372"
}
Code Block
{
    "accountData": {
        "accountNumber": "9500507060523627372",
        "customerNumber": "0995000000000078206"
    }
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

3 Bad Request: Request con campos no válidos.

13 Internal Server Error: Servicios no disponibles.

Realiza la consulta de bloqueos de cuenta

.

Inactiva

Code Block
{
  "accountNumber": "
9500501520328494829
9500501403742215502"
}
Code Block
{
    "accountData": {
        "accountNumber": "
9500501520328494829
9500501403742215502",
        "customerNumber": "
0995000000000035249
0995000000000080639",
        "blockCode1": "
M
U",
        "blockCode1Date": "2023-09-
07
12",
"blockCode2":
"M", 
   "
blockCode2Date
blockCode2": "
2023-08-11
X",
"accountMakerDateOfBirth":
"",
   
"
availableCredit
blockCode2Date":
0, 
 "
userAmounts9
2023-09-13"
:
0,
"userAmounts10": 0, "userAmounts7": 0 } }2 
}
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

4

3 Bad Request: Request con campos no válidos.

5

13 Internal Server Error: Servicios no disponibles.

SetAccountBlock

Descripción

Request

Response

HTTP Codes

Realiza la consulta de bloqueos

/desbloqueo

de cuenta

.

Expirada

Code Block
{
  "
blockCode
accountNumber": "9500501566817108768"
,
"blockCodeIndicator": 1,
}
Code Block
{
    "
foreignUse
accountData": {
0,
"functionCode":
"U",
   "accountNumber": "
9500501520328494829
9500501566817108768",
} Code Block{
"functionCode":
"B",
   "
accountNumber
customerNumber": "
9500501520328494829", "blockCode1Local": "M",
0995000000000040921"
"localOrganization":
950
}
}
2 
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
4 
3 Bad Request: Request con campos no válidos.
5 
Descripción
Request
Response
HTTP Codes
Sincroniza el mirror de account con la información de Fiserv.
 Code Block{
13 Internal Server Error: Servicios no disponibles.
SynchronizeMirrorAccount
Realiza la consulta de bloqueos de cuenta Bloqueada
 Code Block
{
  "accountNumber": "
9500501520328494829
9500509377699205330"
}
 Code Block
{
    "accountData": {
  
  "accountNumber":
 
"9500501520328494829",
     "
customerNumber
accountNumber": "
0995000000000035249
9500509377699205330",



  
 "blockCode1":
 
"M",
     "
blockCode1Date
customerNumber": "
2023-09-07
0995000000000080636",

 

  
"blockCode2":
 
"M",
     "
blockCode2Date
blockCode1": "
2023-08-11
Z",
    
"accountMakerDateOfBirth":
 
"",
   
  
"
availableCredit
blockCode1Date":
 0,
   
 "
userAmounts9
2023-09-12"
:


0,
    
 "userAmounts10": 0,
    "userAmounts7": 0
  }
}2 
}
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
4 
3 Bad Request: Request con campos no válidos.
5 
13 Internal Server Error: Servicios no disponibles.
Balance
 Info
Consulta de balance​
Repositorio sincronizado con Fiserv​
Disminuye peticiones al Proveedor
...
POST → /v1/accounts/blocks
Descripción
Request
Response
HTTP Codes
Realiza la consulta de balance de cuenta.
GRPC Codes
Realiza bloqueos/desbloqueo de cuenta - Bloquear (foreignUse= 0)
 Code Block
{
  "
accountNumber
blockCode": "
9500501520328494829"
} Code Block{
M",
  "
accountOrCardNumber
blockCodeIndicator": 
"9500501520328494829"
0,
  "
currentBalance
foreignUse": 
998176210159
0,
  "
availableCreditLimit
functionCode": 
32237425576994724
"B",
  "
frozenBalance
accountNumber": 
26000
"9500501520328494829"
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
SynchronizeMirrorBalance
Descripción
Request
Response
HTTP Codes
Sincroniza el mirror de balance con la información de Fiserv.
code
 Code Block
{
    "
accountNumber
functionCode": "
9500501520328494829
B",
 
} Code Block{
   "
accountOrCardNumber
accountNumber": "9500501520328494829",
    "
currentBalance
blockCode1Local": 
998176210159
"M",

 


"availableCreditLimit":
 
32237425576994724,
   "
frozenBalance
localOrganization": 
26000
950
}
2 OK
200: Solicitud exitosa.
4 Bad Request
400: Request con campos no válidos.
5 Internal Server Error
Descripción
Request
Response
HTTP Codes
Realiza una transferencia .
401: Apy Key no válida.
500: Servicios no disponibles.
TransferBalance
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Realiza bloqueos/desbloqueo de cuenta - Bloquear (foreignUse= 1)
 Code Block
{
  "
transactionData
blockCode":
 {
 
    
"
transactionAmount
U"
: 1
,

 

  "
actionCode
blockCodeIndicator": 
"8012"
0,

 

  "
authorizationCode
foreignUse": 
"311S3q"
1,

 

  "
effectiveDate
functionCode": "
2023-06-21
B",
  
  
"
description
accountNumber": "
P2P",
9500501520328494829"
}
 Code Block
{
    "
paidConcept
functionCode": "
test
B",
    "
memoPostedIndicator
accountNumber": "
qqq
9500501520328494829",
    "
suppressMonetaryTransaction
localOrganization": 
"qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
950
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Realiza bloqueos/desbloqueo de cuenta - Desbloquear
 Code Block
{
  "blockCode": "",
  "blockCodeIndicator": 2,
  "foreignUse": 0,
  "functionCode": "U",
  "accountNumber": "9500501520328494829"
}
 Code Block
{
    "
senderAccount
functionCode": "
senderAccount012345
U",
    "
beneficiaryAccount
accountNumber": "
beneficiaryAccount1
9500501520328494829",
    "
counterpartInstitution
blockCode1Local": "
aaaaa
M",
    "
operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500501545918394337"
}
 Code Block
{
  "historyDate": "2023-09-12",
  "historyTime": "111208",
  "transactionData": {
    "transactionCode": "8012",
    "transactionDescription": "P2P RECIEVER",
    "currentBalance": "-2122495",
    "openToBuy": "2122548"
  }
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
TransferPeerToPeer
Descripción
Request
Response
HTTP Codes
Realiza una transferencia P2P.
 Code Block
{
  "from": {
    "accountNumber": "9500508496924050930",
    "actionCode": "8008",
    "transactionDescription": "P2P_TRANSFER_SOURCE",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
  "to": {
    "accountNumber": "9500502030236002994",
    "actionCode": "8012",
    "transactionDescription": "P2P_TRANSFER_TARGET",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
    "effectiveDate": "2022-01-30",
    "transactionAmount": 100,
    "device": "abcfghjfghjklghjkfghjk5678956789",
    "ip": "198.162.123.148",
    "latitude": 123.56565656,
    "longitude": -23.565656,
    "xTransactionId": "123"
}
 Code Block
{
  "effectiveDate": "2022-01-30",
  "transactionAmount": "100",
  "actionOutputArea": {
    "actionData": [
      {
        "authorizationCode": "1234",
        "accountNumber": "9500508496924050930",
        "transactionDescription": "P2P SENDER",
        "feeAmount": "0",
        "transactionCode": 8008,
        "currentBalance": -5988391,
        "creditLimit": 0,
        "openToBuy": 598649100,
        "authorizationNumber": "507925"
      },
      {
        "authorizationCode": "1234",
        "accountNumber": "9500502030236002994",
        "transactionDescription": "P2P RECIEVER",
        "feeAmount": "0",
        "transactionCode": 8012,
        "currentBalance": -169434,
        "creditLimit": 0,
        "openToBuy": 17133400,
        "authorizationNumber": "332272"
      }
    ]
  }
}
2 OK: Solicitud exitosa.
4 
localOrganization": 950
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Para éste endpoint se requieren los siguientes valores:
  • blockCode: Código de bloqueo proporcionado por Spin.
  • blockCodeIndicator: Indica el código de bloqueo a usar: 0-1 primer código de bloqueo, 2 segundo código de bloqueo. 
  • foreignUse: 0
  • functionCode: indica si se va bloquear (“B“) o desbloquear (“U“)
  • accountNumber: código de cuenta.
...
POST → /v1/accounts/syncs
Descripción
Request
Response
HTTP Codes
GRPC Codes
Sincroniza el mirror de account con la información de Fiserv - Número de cuenta Activa
 Code Block
{
  "accountNumber": "9500503048928881284"
}
 Code Block
{
    "accountData": {
        "accountNumber": "9500503048928881284",
        "customerNumber": "0995000000000076294",
        "accountMakerDateOfBirth": "1994-05-06",
        "availableCredit": 10000.0,
        "userAmounts9": -50000.0,
        "userAmounts10": -40000.0
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.POST → /v1/balances
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Sincroniza el mirror de account con la información de Fiserv - Número de cuenta Inactiva
 Code Block
{
  "accountNumber": "9500501403742215502"
}
 Code Block
{
    "accountData": {
        "accountNumber": "9500501403742215502",
        "customerNumber": "0995000000000080639",
        "blockCode1": "U",
        "blockCode1Date": "2023-09-12",
        "blockCode2": "X",
        "blockCode2Date": "2023-09-13",
        "accountMakerDateOfBirth": "1994-05-06"
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.POST → /v1/balances
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Sincroniza el mirror de account con la información de Fiserv - Número de cuenta Expirada
 Code Block
{
  "accountNumber": "9500508152383529456"
}
 Code Block
{
    "accountData": {
        "accountNumber": "9500508152383529456",
        "customerNumber": "0995000000000040667",
        "accountMakerDateOfBirth": "2000-01-01",
        "availableCredit": 10000.0,
        "userAmounts9": -170000.0,
        "userAmounts10": -130000.0,
        "userAmounts7": -10000.0
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.POST → /v1/balances
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Sincroniza el mirror de account con la información de Fiserv - Número de cuenta Bloqueada
 Code Block
{
  "accountNumber": "9500508176491773011"
}
 Code Block
{
    "accountData": {
        "accountNumber": "9500508176491773011",
        "customerNumber": "0995000000000080637",
        "blockCode1": "Z",
        "blockCode1Date": "2023-09-12",
        "blockCode2Date": "2023-09-18",
        "accountMakerDateOfBirth": "1994-05-06"
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.POST → /v1/balances
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
POST → /v1/balances
Descripción
Request
Response
HTTP Codes
GRPC Codes
Realiza la consulta de balance de cuenta.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
	"accountOrCardNumber": "9500501520328494829",
	"currentBalance": 998176209259,
	"availableCreditLimit": 1823760996,
	"frozenBalance": 26000.0
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
POST → /v1/balances/syncs
Descripción
Request
Response
HTTP Codes
GRPC Codes
Sincroniza el mirror de balance con la información de Fiserv - Número de cuenta Activa
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
    "accountOrCardNumber": "9500503048928881284",
    "currentBalance": -10000.0,
    "availableCreditLimit": 10000.0
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Sincroniza el mirror de balance con la información de Fiserv - Número de cuenta Inactiva
 Code Block
{
  "accountNumber": "9500501403742215502"
}
 Code Block
{
    "accountOrCardNumber": "9500501403742215502"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Sincroniza el mirror de balance con la información de Fiserv - Número de cuenta Expirada
 Code Block
{
  "accountNumber": "9500508152383529456"
}
 Code Block
{
    "accountOrCardNumber": "9500508152383529456",
    "currentBalance": -10000.0,
    "availableCreditLimit": 10000.0
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Sincroniza el mirror de balance con la información de Fiserv - Número de cuenta Bloqueada
 Code Block
{
  "accountNumber": "9500508176491773011"
}
 Code Block
{
    "accountOrCardNumber": "9500508176491773011"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
PUT → /v1/balances/transfers
Descripción
Request
Response
HTTP Codes
GRPC Codes
Realiza una transferencia - Número de cuenta Activa 
 Code Block
{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500503048928881284", 
  "operationType": "D"
 }
 Code Block
{
    "historyDate": "2023-09-18",
    "historyTime": "164440",
    "transactionData": {
        "transactionCode": "8000",
        "currentBalance": "-10000",
        "openToBuy": "13000"
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Realiza una transferencia - Número de cuenta Inactiva 
 Code Block
{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500501403742215502", 
  "operationType": "D"
 }
 Code Block
{
    "historyDate": "2023-09-18",
    "historyTime": "164651",
    "transactionData": {
        "transactionCode": "8000",
        "openToBuy": "2000"
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Realiza una transferencia - Número de cuenta Expirada 
 Code Block
{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508152383529456", 
  "operationType": "D"
 }
 Code Block
{
    "historyDate": "2023-09-18",
    "historyTime": "164734",
    "transactionData": {
        "transactionCode": "8000",
        "currentBalance": "-10000",
        "openToBuy": "12000"
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
Realiza una transferencia - Número de cuenta Bloqueada 
 Code Block
{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508176491773011", 
  "operationType": "D"
 }
 Code Block
{
    "historyDate": "2023-09-18",
    "historyTime": "164818",
    "transactionData": {
        "transactionCode": "8000",
        "openToBuy": "2000"
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
PUT → /v1/balances/transfers-p2p
Descripción
Request
Response
HTTP Codes
GRPC Codes
Realiza una transferencia P2P.
 Code Block
{
  "from": {
    "accountNumber": "9500508496924050930",
    "actionCode": "8008",
    "transactionDescription": "P2P_TRANSFER_SOURCE",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
  "to": {
    "accountNumber": "9500502030236002994",
    "actionCode": "8012",
    "transactionDescription": "P2P_TRANSFER_TARGET",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
    "effectiveDate": "2022-01-30",
    "transactionAmount": 100,
    "device": "abcfghjfghjklghjkfghjk5678956789",
    "ip": "198.162.123.148",
    "latitude": 123.56565656,
    "longitude": -23.565656,
    "xTransactionId": "123"
}
 Code Block
{
	"effectiveDate": "2022-01-30",
	"transactionAmount": "100",
	"actionOutputArea": {
		"actionData": [
			{
				"authorizationCode": "1234",
				"accountNumber": "9500508496924050930",
				"transactionDescription": "P2P SENDER",
				"transactionCode": 8008,
				"currentBalance": -5988391.0,
				"openToBuy": 5.987391E8,
				"authorizationNumber": "205229"
			},
			{
				"authorizationCode": "1234",
				"accountNumber": "9500502030236002994",
				"transactionDescription": "P2P RECIEVER",
				"transactionCode": 8012,
				"currentBalance": -169434.0,
				"openToBuy": 1.70434E7,
				"authorizationNumber": "923589"
			}
		]
	}
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
PUT → /v1/balances/transfers-qr
Descripción
Request
Response
HTTP Codes
GRPC Codes
Realiza una transferencia QR.
 Code Block
{
  "transactionData": {
    "transactionAmount": 20,
    "actionCode": "8038",
    "authorizationCode": "Q1er44",
    "effectiveDate": "2022-08-24",
    "description": "QR code test - normal hours",
    "paidConcept": "Hello",
    "memoPostedIndicator": " ",
    "suppressMonetaryTransaction": "Y",
    "n1n2ByPass": "N",
    "identifier": 0,
    "box": "1",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "Hello",
    "beneficiaryAccount": "Hello",
    "senderAccount": "Hello",
    "counterpartInstitution": "Hello",
    "operatingInstitution": "Hello",
    "frcUprkBeneficiary": "Hello",
    "orderingFrcUprk": "Hello",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "Hello",
    "orderingName": "Hello",
    "paymentSourceId": "bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508020127353147"
}
 Code Block
{
	"historyDate": "2023-09-08",
	"historyTime": "122732",
	"transactionData": {
		"transactionCode": "8038",
		"transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
		"currentBalance": "-1382946",
		"openToBuy": "1382486"
	}
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
...
Customer Aggregation service
 Info
Incorpora los endpoints de Customer​
Validación de campos mandatorios antes del envío a Fiserv​
Expone endpoints a través de un API REST y gRPC
POST → /customers
Descripción
Request
Response
HTTP Codes
GRPC Codes
Registro del cliente en la el proveedor de clientes.
 Code Block
{
    "logo": "60",
    "address": "Ciruelas",
    "houseNumber": "12345",
    "externalNumber": "8007",
    "colony": "Lomas",
    "city": "Lomas de Alvarez",
    "state": "COL",
    "postalCode": "99980",
    "dateOfBirth": "2000-08-06",
    "stateOfBirth": "CDMX",
    "email": "lmedina@palo-it.com",
    "firstName": "Judith",
    "lastName": "Medina",
    "maternalLastName": "Ruiz",
    "mobilePhoneNumber": "5521163588",
    "identificationNumber": "4152554487415113698",
    "ine": "1234117890099",
    "occupation": "Tester",
    "genderCode": "1",
    "user4":"1",
    "identificationNumberFlag": "2"
}
 Code Block
{
    "customerNumber": "0995000000000080589"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
5 
13 Internal Server Error: Servicios no disponibles.
...
PUT → /customers
Descripción
Request
Response
HTTP Codes
Realiza una transferencia QR
GRPC Codes
Actualización de los datos del cliente en el proveedor de clientes.
 Code Block
{
    "
transactionData
email": 
{
"lmedina@palo-it.com",
    "
transactionAmount
numberType": 
20
1,
    "
actionCode
customerNumber": "
8038
0995000000000077863",
    "
authorizationCode
address": "
Q1er44
Ciruelas",
    "
effectiveDate
dateOfBirth": "
2022
1999-
08
02-
24
06",
    "
description
city": "
QR
Villa 
code test - normal hours
de Alvarez",
    "
paidConcept
countryCode": "
Hello
MEX",
    "
memoPostedIndicator
county": "
 
CDMX",
    "
suppressMonetaryTransaction
colony": "
Y
ADOLFO LOPEZ MATEOS",
    "
n1n2ByPass
externalNumber": "
N
1007",
    "
identifier
firstName": 
0
"Sandra",
    "
box
genderCode": 
"1"
2,
    "
crPlaza
houseNumber": "
10MON
123",
    "
crStore
ine": "
50WHN
1234117890099",
    "
keyTracking
lastName": "
Hello
Velasco",
    "
beneficiaryAccount
maritalStatus": 
"Hello"
0,
    "
senderAccount
maternalLastName": "
Hello
Medina",
    "
counterpartInstitution
middleName": "
Hello
Rosa",
    "
operatingInstitution
mobilePhoneIndicator": 
"Hello"
1,
    "
frcUprkBeneficiary
mobilePhoneNumber": "
Hello
31211635899",
    "
orderingFrcUprk
occupation": "
Hello
NURSE",
    "
device
ownOrRentResidenceFlag": 
"123456789-123456789-123456789-12"
0,
    "
ip
postalCode": 
"198.162.200.200"
54070,
    "
latitude
stateOfBirth":
 -109.699,
 "DF"
}
 Code Block
{
    "
longitude
outputArea":
 23.062,
 {
        "
recipientName
customerNumber": "
Hello
0995000000000077863",
        "
orderingName
accountNumber": "
Hello
0995000000000077863",
        "
paymentSourceId
responseCode": "
bf0469d7-b507-44d6-af7d-d4edea6340f1"
",
     
},
   "
xTransactionId
level": "
123
",
   
"accountNumber":
 
"9500508020127353147"
 
} Code Block{
   "
historyDate
transactionAmount": 
"2023-09-12",
0,
    
"historyTime":
 
"111311",
   "
transactionData
countryLimit": {
            "
transactionCode
dailyLimitLoad":
 "8038",
 0,
            "
transactionDescription
monthlyLimitLoad": 
"CASHOUT WITH QR-CODE(FREE BAL)",
0,
      
"currentBalance":
 
"-1382946",
     "
openToBuy
dailyLimitCash": 
"1382326"
  }
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
Card
 Info
Incorpora los endpoints de Card Mirror​
Sincronización de datos con el Mirror​
Expone endpoints a través de un API REST 
POST → /v1/cards/embossers/details 
Descripción
Request
Response
HTTP Codes
Obtener cuenta mediante Pantoken
 Code Block{
0,
            "
panToken
monthlyLimitCash": 
"0004217470595215803",
0,
            "
cardSequence
limitForDepositTransactions":
 2147483647,
 0
        },
        "
foreignUse
accountLimit":
 0
} Code Block{
	"postToAccount": "9500508261544464147",
	"blockCode": "Z",
	"cardNumber": "***************0252",
	"currentCardActivation": "N",
	"dateBlock": "2023-09-04"
 {
            "accountDailyAmountLoad": 0,
            "accountMonthlyAmountLoad": 0,
            "accountDailyAmountCash": 0,
            "accountMonthlyAmountCash": 0
        }
    }
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
...
POST → /
...
customers/account
 Code Block{
Descripción
Request
Response
HTTP Codes
GRPC Codes
Bloqueo de tarjetas
Vinculación del cliente en la cuenta de Spin.
 Code Block
{
    "accountNumber": "0004217470138987703",
    "
blockCode
customerNumber": "
Z
0995000000000045698",
    "
panToken
qualification": "1",
    "
0004217470885923553
customerTypeIndicator": 0,
    "
cardSequence
foreignUseIndicator": 
1
0,
    "
functionCode
alternateCustomer": {
        "
B
expirationDate": "2023/12/
B
30"

para
 
bloquear
 
-
 
u
 
Desbloquear
}
}
 Code Block
{
    "customerNumber": "0995000000000045697",
    "accountNumber": "1650"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
0 OK: Solicitud exitosa.
400
3 Bad Request: Request con campos no válidos.
401: Apy Key no válida.
500
13 Internal Server Error: Servicios no disponibles.
Gateway
Account Adapter
 Info
Permite tener la comunicación entre Spin y Fiserv para los módulos de account y balance.
...
Card Aggregation service
 Info
Incorpora los endpoints de Card​
Validación de campos mandatorios antes del envío a Fiserv​
Expone endpoints a través de un API REST y gRPC​
​POST /cards/embosser/details
Descripción
Request
Response
HTTP Codes
Realiza la consulta de bloqueos de cuenta.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block{
  "accountData": {
    "accountNumber": "9500501520328494829",
 
Obtener cuenta mediante Pantoken
 Code Block
{
  "
customerNumber
panToken": "
0995000000000035249
0004217470595215803",
  
  
"
blockCode1
cardSequence": 
"M"
2147483647,

 

  "
blockCode1Date
foreignUse": 
"2023-09-07",
    "blockCode2
0
}
 Code Block
{
	"postToAccount": "
M
9500508261544464147",

    "blockCode2Date
	"blockCode": "
2023-08-11
Z",

    "accountMakerDateOfBirth
	"cardNumber": "***************0252",

    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 0
  }
}2 OK
	"currentCardActivation": "N",
	"dateBlock": "2023-09-04"
}
200: Solicitud exitosa.
4 Bad Request
400: Request con campos no válidos.
401: Apy Key no válida.
5 Internal Server Error
500: Servicios no disponibles.
...
PUT /cards/account
Descripción
Request
Response
HTTP Codes
Realiza bloqueos/desbloqueo de cuenta.
Vinculación de tarjetas a cuenta
 Code Block
 {
  "
blockCode
customerOrAccountNumber": "1234567890123456800",
  "
blockCodeIndicator
cardNumber":
 1,
 
 "
foreignUse
000123456ID5IXX1234"
: 0
,
  "
functionCode
cardholderType": 
"U",
  "accountNumber": "9500501520328494829"

1
}
 Code Block
{
  "
functionCode
customerOrAccountNumber": "
B
1234567890123456800",
  "
accountNumber
cardNumber": "
9500501520328494829",
  "blockCode1Local": "M
000123456ID5IXX1234",

 


"localOrganization": 950

}
2 OK
200: Solicitud exitosa.
4 Bad Request
400: Request con campos no válidos.
5 Internal Server Error
401: Apy Key no válida.
500: Servicios no disponibles.
...
POST /cards/account
Descripción
Request
Response
HTTP Codes
Realiza una transferencia .
Recuperación del numero de cuenta 
 Code Block
{
  "
transactionData
cardNumber":
 {
 
    
"
transactionAmount
000123456ID5IXX1234"
: 1
,

    "actionCode": "8012",
}

 Code Block
{
    "
authorizationCode
accountNumber": "
311S3q
0004217470041850252"
,
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456

}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
 Info
El cardNumber debe tener tres ceros a la izquierda para completar el tamaño de 19 dígitos solicitado por el operador bancario.
Image Added
PUT /cards/activation​ [Equipo de Spin]
Descripción
Request
Response
HTTP Codes
Activación de tarjetas
 Code Block
{
  "organizationNumber": 999,
  "cardNumber": "000123456ID5IXX1234",
  "serviceType": "A",
  "userData": "string"
}
 Code Block
{
  "organizationNumber": 999,
  "logo": 1,
  "cardNumber": "000123456ID5IXX1234",
  "serviceType": "A",
  "numberCardsActivated": 1,
  "foreignOrg": 1,
  "numberForeignCardsActivated": 0
}

200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
PUT /cards/embosser/block
Descripción
Request
Response
HTTP Codes
Bloqueo de tarjetas
 Code Block
{
  "blockCode": "Z",
  "panToken": "0004217470885923553",
  "cardSequence": 1,
  "functionCode": "B" //B para bloquear - u Desbloquear
}
 Code Block
{}

200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
...
Mirror
Account 
 Info
Consulta de bloqueos​
Repositorio sincronizado con Fiserv​
Disminuye peticiones al Proveedor​
GetAccountDetails
Descripción
Request
Response
GRPC Codes
Realiza la consulta de bloqueos de cuenta.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
  "accountData": {
    "accountNumber": "9500501520328494829",
    "
orderingName
customerNumber": "
orderingName012345678901234567
0995000000000035249",
    "
paymentSourceId
blockCode1": "
paymentSourceId012345
M"


,
 
},
   "
xTransactionId
blockCode1Date": "
123
2023-09-07",
    "
accountNumber
blockCode2": "
9500501545918394337
M",
 
} Code Block{
   "
historyDate
blockCode2Date": "2023-
09
08-
12
11",
    "
historyTime
accountMakerDateOfBirth": "
111208
",

  "transactionData": {

    "
transactionCode
availableCredit": 
"8012"
0,
    "
transactionDescription
userAmounts9": 
"P2P RECIEVER"
0,
    "
currentBalance
userAmounts10": 
"-2122495"
0,
    "
openToBuy
userAmounts7": 
"2122548"
0
  }
}
2 
0 OK: Solicitud exitosa.
4 
3 Bad Request: Request con campos no válidos.
5 
13 Internal Server Error: Servicios no disponibles.
...
SetAccountBlock
Descripción
Request
Response
HTTP 
GRPC Codes
Realiza 
 una transferencia P2P
bloqueos/desbloqueo de cuenta.
 Code Block
{
  "
from
blockCode": 
{
"",
  
  
"
accountNumber
blockCodeIndicator":
 "9500508496924050930",
 
 1,
  "
actionCode
foreignUse": 
"8008"
0,



  
 
"
transactionDescription
functionCode": "
P2P_TRANSFER_SOURCE
U",

 

  "
description
accountNumber": "
P2P_TRANSFER_SOURCE
9500501520328494829"
,


 
}
 Code Block
{
  "
authorizationCode
functionCode": "
1234
B"

  }
,
  "
to
accountNumber": 
{
"9500501520328494829",
  
  
"
accountNumber
blockCode1Local": "
9500502030236002994
M",

 

  "
actionCode
localOrganization":
 "8012",
 
 950
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
SynchronizeMirrorAccount
Descripción
Request
Response
GRPC Codes
Sincroniza el mirror de account con la información de Fiserv.
 Code Block
{
  "
transactionDescription
accountNumber": "
P2P_TRANSFER_TARGET
9500501520328494829"
,


 
}
 Code Block
{
  "
description
accountData": 
"P2P_TRANSFER_SOURCE",
{
    "
authorizationCode
accountNumber": "
1234
9500501520328494829"

  }
,
    "
effectiveDate
customerNumber": "
2022-01-30
0995000000000035249",
    "
transactionAmount
blockCode1":
 100,
 
    "device": "abcfghjfghjklghjkfghjk5678956789
"M",
    "
ip
blockCode1Date": "
198.162.123.148
2023-09-07",
    "
latitude
blockCode2": 
123.56565656,
    "longitude": -23.565656
"M",
    "
xTransactionId
blockCode2Date": "
123"
} Code Block{
  "effectiveDate": "2022-01-30",
2023-08-11",
    "
transactionAmount
accountMakerDateOfBirth": "
100
",
    "
actionOutputArea
availableCredit": 
{
0,
    "
actionData
userAmounts9": 
[
      {
   
0,
    "
authorizationCode
userAmounts10": 
"1234"
0,
    
    
"
accountNumber
userAmounts7": 
"9500508496924050930",
0
  
   
}
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
...
Balance
 Info
Consulta de balance​
Repositorio sincronizado con Fiserv​
Disminuye peticiones al Proveedor
GetAccountBalance
Descripción
Request
Response
GRPC Codes
Realiza la consulta de balance de cuenta.
 Code Block
{
  "
transactionDescription
accountNumber": "
P2P SENDER
9500501520328494829"
,
     

}
 Code Block
{
  "
feeAmount
accountOrCardNumber": "
0
9500501520328494829",
  
   
"currentBalance": 998176210159,
  "
transactionCode
availableCreditLimit": 
8008
32237425576994724,
  "frozenBalance": 
  
26000
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
SynchronizeMirrorBalance
Descripción
Request
Response
GRPC Codes
Sincroniza el mirror de balance con la información de Fiserv.
 Code Block
{
  "
currentBalance
accountNumber": 
-5988391,
  
"9500501520328494829"
}
 Code Block
{
  
   
"
creditLimit
accountOrCardNumber": 
0
"9500501520328494829",
  "currentBalance": 998176210159,
  
  
"
openToBuy
availableCreditLimit": 
598649100
32237425576994724,
  "frozenBalance": 26000
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
TransferBalance
Descripción
Request
Response
GRPC Codes
Realiza una transferencia .
 Code Block
{
  
 
"
authorizationNumber
transactionData": 
"507925"
{
    
  }
"transactionAmount": 1,
    
  {
   
"actionCode": "8012",
    "authorizationCode": "
1234
311S3q",
    
    
"
accountNumber
effectiveDate": "
9500502030236002994
2023-06-21",

  

    
 
"
transactionDescription
description": "P2P
 RECIEVER",
   
",
    "
feeAmount
paidConcept": "
0
test",
    
    
"
transactionCode
memoPostedIndicator": 
8012,
   
"qqq",
    "
currentBalance
suppressMonetaryTransaction": 
-169434,
   
"qqq",
    "
creditLimit
n1n2ByPass": 
0
"qqq",
    
    
"
openToBuy
identifier": 
17133400,
 
"S_IN",
    
  
"
authorizationNumber
box": "
332272
3",
    "crPlaza": "10MON",
 
}
   "crStore": "50WHN",

]
   
}
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
FrozenBalanceTransfer
Descripción
Request
Response
HTTP Codes
Realiza una transferencia QR.
 Code Block{
 "keyTracking": "KEYTRACKING0123456789",
    "
transactionData
senderAccount": 
{
"senderAccount012345",
    "
transactionAmount
beneficiaryAccount": 
20
"beneficiaryAccount1",
    "
actionCode
counterpartInstitution": "
8038
aaaaa",
    "
authorizationCode
operatingInstitution": "
Q1er44
bbbbb",
    "
effectiveDate
frcUprkBeneficiary": "
2022-08-24
frcUprkBenefi",
    "
description
orderingFrcUprk": 
"QR code test - normal hours
"orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "
paidConcept
latitude": -109.699,
    "
Hello
longitude": 23.062,
    "
memoPostedIndicator
recipientName": "
 
recipientName01234567890123456",
    "
suppressMonetaryTransaction
orderingName": "
Y
orderingName012345678901234567",
    "
n1n2ByPass
paymentSourceId": "
N
paymentSourceId012345",
  
 
"operationType": "
identifier
W"
:


0,
  },
  "
box
xTransactionId": "
1
123",

 

  "
crPlaza
accountNumber": "
10MON
9500501545918394337"
,

}
 Code Block
{
  
 
"
crStore
historyDate": "
50WHN
2023-09-12",
  
  
"
keyTracking
historyTime": "
Hello
111208",

 

  "
beneficiaryAccount
transactionData": 
"Hello",
{
    "
senderAccount
transactionCode": "
Hello
8012",
    "
counterpartInstitution
transactionDescription": "
Hello
P2P RECIEVER",
    "
operatingInstitution
currentBalance": "
Hello
-2122495",
    "
frcUprkBeneficiary
openToBuy": "
Hello
2122548"
,

  
  "orderingFrcUprk": "Hello",
 
}
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
TransferPeerToPeer
Descripción
Request
Response
GRPC Codes
Realiza una transferencia P2P.
 Code Block
{
  "
device
from": 
"123456789-123456789-123456789-12",
{
    "
ip
accountNumber": "
198.162.200.200
9500508496924050930",
    "
latitude
actionCode":
 -109.699,
   
 "
longitude
8008"
: 23.062
,
    "
recipientName
transactionDescription": "
Hello
P2P_TRANSFER_SOURCE",
    "
orderingName
description": "
Hello
P2P_TRANSFER_SOURCE",
    "
paymentSourceId
authorizationCode": "
bf0469d7-b507-44d6-af7d-d4edea6340f1
1234"
  },
  "
xTransactionId
to":
 "123",
 {
    "accountNumber": "
9500508020127353147"
} Code Block{
  "historyDate": "2023-09-12",
9500502030236002994",
    "
historyTime
actionCode": "
111311
8012",
    "
transactionData
transactionDescription": 
{
"P2P_TRANSFER_TARGET",
    "
transactionCode
description": "
8038
P2P_TRANSFER_SOURCE",
    "
transactionDescription
authorizationCode": "1234"
CASHOUT


WITH
 
QR-CODE(FREE BAL)"
 },
    "
currentBalance
effectiveDate": "2022-01-
1382946
30",
    "
openToBuy
transactionAmount": 
"1382326"
  }
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
GetAccountBalance
Descripción
Request
Response
HTTP Codes
Realiza la consulta de balance de cuenta.
 Code Block{
100,
    "
accountNumber
device": "
9500501520328494829
abcfghjfghjklghjkfghjk5678956789",

} Code Block{
    "
accountOrCardNumber
ip": "
9500501520328494829
198.162.123.148",
    "
currentBalance
latitude": 
998176210159
123.56565656,
    "
availableCreditLimit
longitude": 
32237425576994724
-23.565656,
    "
frozenBalance
xTransactionId": 
26000
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
Customer Adapter
 Info
Permite tener la comunicación entre Spin y Fiserv para los módulos de customer.​
​Este componente se desarrolló para desacoplar los procesos core de Spin y el proveedor financiero para lograr una mayor escalabilidad.​
CreateCustomer
Descripción
Request
Response
HTTP Codes
Creación del cliente
 Code Block{
"123"
}
 Code Block
{
  "effectiveDate": "2022-01-30",
  "transactionAmount": "100",
  "actionOutputArea": {
    "actionData": [
      {
        "authorizationCode": "1234",
        "
logo
accountNumber": "
50
9500508496924050930",
        "
address
transactionDescription": "
Ciruelo
P2P SENDER",
        "
houseNumber
feeAmount": "0",
        "
123",
transactionCode": 8008,
        "
externalNumber
currentBalance": 
"1007",
-5988391,
        "
colony
creditLimit": 
"Residencial",
0,
        "
city
openToBuy": 
"Villa de Alvarez",
598649100,
        "
state
authorizationNumber": "
COL
507925"
,

     
"postalCode": "28980",
 },
      
 "dateOfBirth": "1994-05-06",
{
        "
stateOfBirth
authorizationCode": "
Colima
1234",
        "
email
accountNumber": "
lmedina@palo-it.com
9500502030236002994",
        "
firstName
transactionDescription": "
Judith
P2P RECIEVER",
        "
lastName
feeAmount": "
Medina
0",
        "
maternalLastName
transactionCode": 
"Ruiz"
8012,



   
"mobilePhoneNumber": "3121163582",
     "
identificationNumber
currentBalance": 
"4152556987415113698"
-169434,
        "
ine
creditLimit": 
"1234117890099",
0,
        "
occupation
openToBuy": 
"Tester",
17133400,
        "
genderCode
authorizationNumber": "
1",
332272"
      }
 
"user4":"1",
   ]
 
"identificationNumberFlag": "2"
 }
}
2 
0 OK: Solicitud exitosa.
4 
3 Bad Request: Request con campos no válidos.
5 
13 Internal Server Error: Servicios no disponibles.
...
FrozenBalanceTransfer
Descripción
Request
Response
HTTP Codes
Actualizar cliente
 Code Block{
Request
Response
GRPC Codes
Realiza una transferencia QR.
 Code Block
{
  "transactionData": {
    "transactionAmount": 20,
    "actionCode": "8038",
    "authorizationCode": "Q1er44",
    "
email
effectiveDate": "
lmedina@palo-it.com
2022-08-24",
    "
numberType
description":
 1
 "QR code test - normal hours",
    "
customerNumber
paidConcept": "
0995000000000077863
Hello",
    "
address
memoPostedIndicator": "
Ciruelo
 ",
    "
dateOfBirth
suppressMonetaryTransaction": "
1994-05-06
Y",
    "
city
n1n2ByPass": 
"Villa de Alvarez"
"N",
    "identifier": 0,
    "
countryCode
box": "
MEX
1",
    "
county
crPlaza": "
Colima
10MON",
    "
colony
crStore": "
ADOLFO LOPEZ MATEOS
50WHN",
    "
externalNumber
keyTracking": "
1007
Hello",
    "
firstName
beneficiaryAccount": "
Victoria
Hello",
    "
genderCode
senderAccount": 
2
"Hello",
    "
houseNumber
counterpartInstitution": "
123
Hello",
    "
ine
operatingInstitution": "
1234117890099
Hello",
    "
lastName
frcUprkBeneficiary": "
Velasco
Hello",
    "
maritalStatus
orderingFrcUprk": 
0
"Hello",
    "
maternalLastName
device": "
Medina
123456789-123456789-123456789-12",
    "
middleName
ip": "
Valeria
198.162.200.200",
    "
mobilePhoneIndicator
latitude": 
1
-109.699,
    "
mobilePhoneNumber
longitude": 
"31211635821"
23.062,
    "
occupation
recipientName": "
NURSE
Hello",
    "
ownOrRentResidenceFlag
orderingName": 
0
"Hello",
    "
postalCode
paymentSourceId":
 54070,
 "bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "
stateOfBirth
xTransactionId": "
DF
123"

}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
LinkAccountToCustomer
Descripción
Request
Response
HTTP Codes
Vincular cuenta al cliente
,
  "accountNumber": "9500508020127353147"
}
 Code Block
{
  "
accountNumber
historyDate": "
9500505675946730065
2023-09-12",
  "
alternateCustomer
historyTime": "111311",
  "transactionData": {
    "
expirationDate
transactionCode": "
2023-08-22"

8038",
 
},
   "
customerNumber
transactionDescription": "
0995000000000075954
CASHOUT WITH QR-CODE(FREE BAL)",
    "
qualification
currentBalance": "
2
-1382946",
    "
customerTypeIndicator
openToBuy": 
0,
"1382326"
  
"foreignUseIndicator": 0

}
}
2 
0 OK: Solicitud exitosa.
4 
3 Bad Request: Request con campos no válidos.
5 
13 Internal Server Error: Servicios no 
 disponibles.
Card Gateway
 Info
Permite tener la comunicación entre Spin y Fiserv para los módulos de card.​
POST → /v1/cards/embosser
Descripción
Request
Response
HTTP Codes
Add a new card to account
disponibles.
...
Card
 Info
Incorpora los endpoints de Card Mirror​
Sincronización de datos con el Mirror​
Expone endpoints a través de un API REST 
POST → /v1/cards/
...
embossers/details 
Descripción
Request
Response
HTTP Codes
Obtener cuenta mediante Pantoken
 Code Block
{
  "panToken": "0004217470595215803",
  "cardSequence": 2147483647,
  "foreignUse": 0
}
 Code Block
{
	"postToAccount": "9500508261544464147",
	"blockCode": "Z",
	"cardNumber": "***************0252",
	"currentCardActivation": "N",
	"dateBlock": "2023-09-04"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
...
PUT → /v1/cards/
...
embossers/block
Descripción
Request
Response
HTTP Codes
Bloqueo de tarjetas
 Code Block
{
  "blockCode": "Z",
  "panToken": "0004217470885923553",
  "cardSequence": 1,
  "functionCode": "B" //B para bloquear - u Desbloquear
}
 Code Block
{}

200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
Aggregation
Estos son los componentes que se estarán usando para la ejecución de pruebas en el proyecto:
Account Aggregation Service
 Info
Incorpora los servicios de Account Mirror y Balance Mirror​
Validación de campos mandatorios antes del envío a Fiserv​
Expone endpoints a través de un API REST y gRPC​
POST → /v1/accounts/details
...
Gateway
Account Adapter
 Info
Permite tener la comunicación entre Spin y Fiserv para los módulos de account y balance.
GetAccountDetails
Descripción
Request
Response
HTTP 
GRPC Codes
Realiza la consulta de bloqueos de cuenta.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{

	
  "accountData": {
    
		
"accountNumber": "9500501520328494829",
 
		
   "customerNumber": "0995000000000035249",
    
		
"blockCode1": "M",
    
		
"blockCode1Date": "2023-09-
06
07",
    
		
"blockCode2": "M",
    
		
"blockCode2Date": "2023-08-11",
    "accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 
	
0
  }
}
200
0 OK: Solicitud exitosa.
400500
3 Bad Request: Request con campos no válidos.
401: Apy Key no válida.
13 Internal Server Error: Servicios no disponibles.
...
SetAccountBlock
Descripción
Request
Response
HTTP 
GRPC Codes
Realiza bloqueos/desbloqueo de cuenta.
 Code Block
{
  "blockCode": "",
  "blockCodeIndicator": 1,
  "foreignUse": 0,
  "functionCode": "U",
  "accountNumber": "9500501520328494829"
}
 Code Block
{
  
	
"functionCode": "
U
B",
  
	
"accountNumber": "9500501520328494829",
  "blockCode1Local": "M",
  
	
"localOrganization": 950
}
200
0 OK: Solicitud exitosa.
400500: 
3 Bad Request: Request con campos no válidos.
401: Apy Key no válida.
13 Internal Server Error: Servicios no disponibles.
...
TransferBalance
Descripción
Request
Response
HTTP 
GRPC Codes
Sincroniza el mirror de account con la información de Fiserv
Realiza una transferencia .
 Code Block
{
  "
accountNumber
transactionData": 
"9500501520328494829"
} Code Block{
	"accountData": {
		"accountNumber": "9500501520328494829",
		"customerNumber
{
    "transactionAmount": 1,
    "actionCode": "
0995000000000035249
8012",
    
		
"
blockCode1
authorizationCode": "
M
311S3q",
 
		"blockCode1Date
   "effectiveDate": "2023-
09
06-
06
21",
    
		
"
blockCode2
description": "
M
P2P",
    
		
"
blockCode2Date
paidConcept": "
2023-08-11"
	}
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.POST → /v1/balances
POST → /v1/balances
Descripción
Request
Response
HTTP Codes
Realiza la consulta de balance de cuenta.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
	"accountOrCardNumber": "9500501520328494829",
	"currentBalance": 998176209259,
	"availableCreditLimit": 1823760996,
	"frozenBalance": 26000.0
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
POST → /v1/balances/syncs
Descripción
Request
Response
HTTP Codes
Sincroniza el mirror de balance con la información de Fiserv.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
	"accountOrCardNumber": "9500501520328494829",
	"currentBalance": 998176209259,
	"availableCreditLimit": 1823760996,
	"frozenBalance": 26000.0
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
PUT → /v1/balances/transfers
Descripción
Request
Response
HTTP Codes
Realiza una transferencia .
 Code Block{
  "transactionData": {
    "transactionAmount": 1
test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "
actionCode
orderingFrcUprk": "
8012
orderingFrcUp",
    "
authorizationCode
device": "
311S3q
123456789-123456789-123456789-12",
    "
effectiveDate
ip": "198.162.200.200",
 
"2023-06-21"
   "latitude": -109.699,
    "longitude": 23.062,
    "
description
recipientName": "
P2P
recipientName01234567890123456",
    "
paidConcept
orderingName": "
test
orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "
memoPostedIndicator
xTransactionId": "
qqq
123",
  "accountNumber": "9500501545918394337"
}
 Code Block
{
  "
suppressMonetaryTransaction
historyDate": "
qqq
2023-09-12",

 

  "
n1n2ByPass
historyTime": "
qqq
111208",

 

  "
identifier
transactionData": 
"S_IN",
{
    "
box
transactionCode": "
3
8012",
    "
crPlaza
transactionDescription": "
10MON
P2P RECIEVER",
    "
crStore
currentBalance": "
50WHN
-2122495",
    "
keyTracking
openToBuy": "
KEYTRACKING0123456789
2122548"
,
 

  }
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
TransferPeerToPeer 
Descripción
Request
Response
GRPC Codes
Realiza una transferencia P2P.
 Code Block
{
  "
senderAccount
from": 
"senderAccount012345",
{
    "
beneficiaryAccount
accountNumber": "
beneficiaryAccount1
9500508496924050930",
    "
counterpartInstitution
actionCode": "
aaaaa
8008",
    "
operatingInstitution
transactionDescription": "
bbbbb
P2P_TRANSFER_SOURCE",
    "
frcUprkBeneficiary
description": "
frcUprkBenefi
P2P_TRANSFER_SOURCE",
    "
orderingFrcUprk
authorizationCode": "
orderingFrcUp
1234"
,

  },
  "
device
to": 
"123456789-123456789-123456789-12",
{
    "
ip
accountNumber": "
198.162.200.200
9500502030236002994",
    "
latitude
actionCode": 
-109.699
"8012",
    "
longitude
transactionDescription": 
23.062
"P2P_TRANSFER_TARGET",
    "
recipientName
description": "
recipientName01234567890123456
P2P_TRANSFER_SOURCE",
    "
orderingName
authorizationCode": "
orderingName012345678901234567
1234"
  },
    "
paymentSourceId
effectiveDate": "
paymentSourceId012345"

2022-01-30",
 
},
   "
xTransactionId
transactionAmount": 
"123"
100,
    "
accountNumber
device": "
9500501545918394337
abcfghjfghjklghjkfghjk5678956789"

} Code Block{
	"historyDate
,
    "ip": "
2023-09-08",
	"historyTime": "122250",
	"transactionData": {
		"transactionCode": "8012",
		"transactionDescription": "P2P RECIEVER",
		"currentBalance": "-2122495",
		"openToBuy": "2122546"
	}
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
PUT → /v1/balances/transfers-p2p
Descripción
Request
Response
HTTP Codes
Realiza una transferencia P2P.
 Code Block{
  "from": {
198.162.123.148",
    "latitude": 123.56565656,
    "longitude": -23.565656,
    "xTransactionId": "123"
}
 Code Block
{
  "effectiveDate": "2022-01-30",
  "transactionAmount": "100",
  "actionOutputArea": {
    "actionData": [
      {
        "
accountNumber
authorizationCode": "
9500508496924050930
1234",
        "
actionCode
accountNumber": "
8008
9500508496924050930",
        "transactionDescription": "P2P
_TRANSFER_SOURCE
 SENDER",
        "
description
feeAmount": "
P2P_TRANSFER_SOURCE
0",
        "
authorizationCode
transactionCode": 8008,
        "
1234"
currentBalance": -5988391,
     
},
   "
to
creditLimit": 0,
   
{
     "
accountNumber
openToBuy": 
"9500502030236002994"
598649100,
        "
actionCode
authorizationNumber": "
8012
507925"
,

     
"transactionDescription": "P2P_TRANSFER_TARGET",
 
 },
      {
  
"description":
 
"P2P_TRANSFER_SOURCE",
     "authorizationCode": "1234",
   
},
     "
effectiveDate
accountNumber": "
2022-01-30
9500502030236002994",

 

  
"transactionAmount":
 
100,
     "
device
transactionDescription": "
abcfghjfghjklghjkfghjk5678956789
P2P RECIEVER",
        "
ip
feeAmount": "
198.162.123.148
0",
        "
latitude
transactionCode": 
123.56565656
8012,
        "
longitude
currentBalance": -
23.565656
169434,
    
"xTransactionId":
 
"123"
} Code Block{
 
	"effectiveDate":
 
"2022-01-30",
 
	
"
transactionAmount
creditLimit": 
"100"
0,

	"actionOutputArea": {
		"actionData": [
			{
				"authorizationCode

        "openToBuy": 17133400,
        "authorizationNumber": "
1234",
				"accountNumber": "9500508496924050930",
				"transactionDescription": "P2P SENDER",
				"transactionCode": 8008,
				"currentBalance": -5988391.0,
				"openToBuy": 5.987391E8,
				"authorizationNumber": "205229"
			},
			{
				
332272"
      }
    ]
  }
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
FrozenBalanceTransfer
Descripción
Request
Response
GRPC Codes
Realiza una transferencia QR.
 Code Block
{
  "transactionData": {
    "transactionAmount": 20,
    "actionCode": "8038",
    "authorizationCode": "
1234
Q1er44",

				"accountNumber

    "effectiveDate": "
9500502030236002994
2022-08-24",

				"transactionDescription":


"P2P
 
RECIEVER",
 
				"transactionCode":
 
8012,
 
				
"
currentBalance
description": 
-169434.0,
				"openToBuy": 1.70434E7,
				"authorizationNumber
"QR code test - normal hours",
    "paidConcept": "
923589
Hello",
 
			}
 
		]
 
	}
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
PUT → /v1/balances/transfers-qr
Descripción
Request
Response
HTTP Codes
Realiza una transferencia QR.
 Code Block{
 "memoPostedIndicator": " ",
    "
transactionData
suppressMonetaryTransaction": 
{
"Y",
    "
transactionAmount
n1n2ByPass": 
20
"N",
    "
actionCode
identifier": 
"8038"
0,
    "
authorizationCode
box": "
Q1er44
1",
    "
effectiveDate
crPlaza": "
2022-08-24
10MON",
    "
description
crStore": "
QR
50WHN",
 
code
 
test
 
-
 
normal hours
"keyTracking": "Hello",
    "
paidConcept
beneficiaryAccount": "Hello",
    "
memoPostedIndicator
senderAccount": "
 
Hello",
    "
suppressMonetaryTransaction
counterpartInstitution": "
Y
Hello",
    "
n1n2ByPass
operatingInstitution": "
N
Hello",
    "
identifier
frcUprkBeneficiary": 
0
"Hello",
    "
box
orderingFrcUprk": "
1
Hello",
    "
crPlaza
device": "
10MON
123456789-123456789-123456789-12",
    "
crStore
ip": "
50WHN
198.162.200.200",
    "
keyTracking
latitude": 
"Hello"
-109.699,
    "
beneficiaryAccount
longitude": 
"Hello"
23.062,
    "
senderAccount
recipientName": "Hello",
    "
counterpartInstitution
orderingName": "Hello",
    "
operatingInstitution
paymentSourceId": "
Hello",
bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "
frcUprkBeneficiary
xTransactionId": "
Hello
123",

 

  "
orderingFrcUprk
accountNumber": "
Hello
9500508020127353147"
,


 
}
 Code Block
{
  "
device
historyDate": "
123456789
2023-
123456789
09-
123456789-
12",

 

  "
ip
historyTime": "
198.162.200.200
111311",



  
 
"
latitude
transactionData": 
-109.699,
{
    "
longitude
transactionCode": 
23.062
"8038",
    "
recipientName
transactionDescription": "
Hello
CASHOUT WITH QR-CODE(FREE BAL)",
    "
orderingName
currentBalance": "
Hello
-1382946",
    "
paymentSourceId
openToBuy": "
bf0469d7-b507-44d6-af7d-d4edea6340f1
1382326"
  }
,
  "xTransactionId": "123",

}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
GetAccountBalance
Descripción
Request
Response
GRPC Codes
Realiza la consulta de balance de cuenta.
 Code Block
{
  "accountNumber": "
9500508020127353147
9500501520328494829"
}
 Code Block
{

	"historyDate":
 
"2023-09-08",
 
	
"
historyTime
accountOrCardNumber": "
122732
9500501520328494829",

	"transactionData":
 
{
 
		
"
transactionCode
currentBalance": 
"8038"
998176210159,
  
		
"
transactionDescription
availableCreditLimit": 
"CASHOUT WITH QR-CODE(FREE BAL)",
		"currentBalance": "-1382946",
		"openToBuy": "1382486"
	}
}200
32237425576994724,
  "frozenBalance": 26000
}
0 OK: Solicitud exitosa.
400500
3 Bad Request: Request con campos no válidos.
401: Apy Key no válida.
13 Internal Server Error: Servicios no disponibles.
...
Customer 
...
Adapter
 Info
Incorpora los endpoints de Customer​
Validación de campos mandatorios antes del envío a Fiserv​
Expone endpoints a través de un API REST y gRPC
...
Permite tener la comunicación entre Spin y Fiserv para los módulos de customer.​
​Este componente se desarrolló para desacoplar los procesos core de Spin y el proveedor financiero para lograr una mayor escalabilidad.​
CreateCustomer
Descripción
Request
Response
HTTP 
GRPC Codes
Registro 
Creación del cliente
 en la el proveedor de clientes.
 Code Block
{
    "logo": "
50
60",
    "address": "
Ciruelo
Ciruelas",
    "houseNumber": "
123
12345",
    "externalNumber": "
1007
8007",
    "colony": "
Residencial
Lomas",
    "city": "
Villa
Lomas de Alvarez",
    "state": "COL",
    "postalCode": "
28980
99980",
    "dateOfBirth": "
1994
2000-
05
08-06",
    "stateOfBirth": "
Colima
CDMX",
    "email": "lmedina@palo-it.com",
    "firstName": "Judith",
    "lastName": "Medina",
    "maternalLastName": "Ruiz",
    "mobilePhoneNumber": "
3121163582
5521163588",
    "identificationNumber": "
4152556987415113698
4152554487415113698",
    "ine": "1234117890099",
    "occupation": "Tester",
    "genderCode": "1",
    "user4":"1",
    "identificationNumberFlag": "2"
}
 Code Block
{
    "
logo
customerNumber": "
60",
0995000000000080589"
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
UpdateCustomer
Descripción
Request
Response
GRPC Codes
Actualizar cliente
 Code Block
{
    "
address
email": "lmedina@palo-it.com",
    "
Ciruelas
numberType": 1,
    "
houseNumber
customerNumber": "
12345
0995000000000077863",
    "
externalNumber
address": "
8007
Ciruelas",
    "
colony
dateOfBirth": "
Lomas
1999-02-06",
    "city": "
Lomas
Villa de Alvarez",
    "
state
countryCode": "
COL
MEX",
    "
postalCode
county": "
99980
CDMX",
    "
dateOfBirth
colony": "ADOLFO LOPEZ 
"2000-08-06
MATEOS",
    "externalNumber": "1007",
    "
stateOfBirth
firstName": "
CDMX
Sandra",
    "
email
genderCode": 
"lmedina@palo-it.com"
2,
    "
firstName
houseNumber": "
Judith
123",
    "
lastName
ine": "
Medina
1234117890099",
    "
maternalLastName
lastName": "
Ruiz
Velasco",
    "
mobilePhoneNumber
maritalStatus": 
"5521163588"
0,
    "
identificationNumber
maternalLastName": "
4152554487415113698
Medina",
    "
ine
middleName": "
1234117890099
Rosa",
    "
occupation
mobilePhoneIndicator": 
"Tester"
1,
    "
genderCode
mobilePhoneNumber": "
1
31211635899",
    "
user4
occupation": "
1
NURSE",
    "
identificationNumberFlag
ownOrRentResidenceFlag": 0,

"2"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
PUT → /customers
Descripción
Request
Response
HTTP Codes
Actualización de los datos del cliente en el proveedor de clientes.
 Code Block{
    "postalCode": 54070,
    "
email
stateOfBirth": "
lmedina@palo-it.com",
DF"
}
 Code Block
{
    "
numberType
outputArea": 
1,
{
        "customerNumber": "0995000000000077863",
        "
address
accountNumber": "
Ciruelo
0995000000000077863",
        "
dateOfBirth
responseCode": "
1994-05-06
",
        "
city
level": 
"Villa de Alvarez",
"",
        "transactionAmount": 0,
        "
countryCode
countryLimit": {
            
"MEX",
"dailyLimitLoad": 0,
            "
county
monthlyLimitLoad": 
"Colima"
0,
    
"colony":
 
"ADOLFO
 
LOPEZ
 
MATEOS",
     "
externalNumber
dailyLimitCash": 
"1007"
0,
     
"firstName": "Victoria",
       "
genderCode
monthlyLimitCash": 
2
0,
      
"houseNumber":
 
"123",
     "
ine
limitForDepositTransactions":
 "1234117890099",
 0
       
"lastName": "Velasco"
 },
        "
maritalStatus
accountLimit": {
 
0,
     
"maternalLastName":
 
"Medina",
     "
middleName
accountDailyAmountLoad": 
"Valeria"
0,
      
"mobilePhoneIndicator":
 
1,
     "
mobilePhoneNumber
accountMonthlyAmountLoad": 
"31211635821"
0,
      
"occupation":
 
"NURSE",
     "
ownOrRentResidenceFlag
accountDailyAmountCash": 0,
      
"postalCode":
 
54070,
     "
stateOfBirth
accountMonthlyAmountCash": 
"DF"
} Code Block{
0
     
"email":
 
"lmedina@palo-it.com",
  }
  
"numberType":
 
1,
 }
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
LinkAccountToCustomer
Descripción
Request
Response
GRPC Codes
Vincular cuenta al cliente
 Code Block
{
  "
customerNumber
accountNumber": "
0995000000000077863
9500505675946730065",

 

  "
address
alternateCustomer":
 "Ciruelas",
 
  {
    "
dateOfBirth
expirationDate": "
1999
2023-
02
08-
06
22"
,

  },
  "
city
customerNumber": "
Villa de Alvarez
0995000000000075954",

 

  "
countryCode
qualification": "
MEX
2",
  "customerTypeIndicator": 0,
  "
county
foreignUseIndicator":
 "CDMX",
 0
}
 Code Block
{
    "
colony
customerNumber": "
ADOLFO LOPEZ MATEOS
0995000000000045697",
    "
externalNumber
accountNumber": "
1007",
 
1650"
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
...
Card Gateway
 Info
Permite tener la comunicación entre Spin y Fiserv para los módulos de card.​
POST → /cards/account
Descripción
Request
Response
HTTP Codes
Vincular una tarjeta con un número de cuenta
 Code Block
{
  "
firstName
cardNumber": "
Sandra
0004217470072001676"
,
    "genderCode": 2,

}
 Code Block
{
    
  
"
houseNumber
accountNumber": "
123
0004217470072001676"
,
    "ine": "1234117890099",
    "lastName": "Velasco",
    "maritalStatus": 0,
    "maternalLastName": "Medina",
    "middleName": "Rosa",
    "mobilePhoneIndicator": 1,
    "mobilePhoneNumber": "31211635899",
    "occupation": "NURSE

}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
PUT → /cards/account
Descripción
Request
Response
HTTP Codes
Desvincular una tarjeta de un número de cuenta
 Code Block
{
  "customerOrAccountNumber": "9500507060523627372",
  "cardNumber": "0004217470969640887",
  "cardholderType": 1
}
 Code Block
{
    "cardNumber": "***************4568",
    "
ownOrRentResidenceFlag": 0,
    "postalCode": 54070,
    "stateOfBirth
customerOrAccountNumber": "
DF
9500507060523627372"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
POST → /v1/
...
cards/embosser/
...
details
Descripción
Request
Response
HTTP Codes
Vinculación del cliente en la cuenta de Spin.
Obtener cuenta mediante Pantoken Activo
 Code Block
{
  "
accountNumber
panToken": "
9500505675946730065
0004217470595215803",
  "
alternateCustomer
cardSequence": 2147483647,
  
{
    "expirationDate
"foreignUse": 0
}
 Code Block
{
	"postToAccount": "
2023-08-22"
  }
9500508261544464147",

  
	"
customerNumber
blockCode": "
0995000000000075954
Z",

  
	"
qualification
cardNumber": "
2
***************0252",

  
	"
customerTypeIndicator
currentCardActivation": 
0
"N",

  
	"
foreignUseIndicator
dateBlock": 
0
}
"2023-09-04"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
Obtener cuenta mediante Pantoken Inactivo
 Code Block
{

 

  "
accountNumber
panToken": "
0004217470138987703
0004217470595215803",
  "cardSequence": 1,
  "
customerNumber
foreignUse":
 "0995000000000045698",
 1
}
 Code Block
{
    "
qualification
postToAccount": "
1
9500507060523627372",
    "
customerTypeIndicator
blockCode": 
0
"Z",
    "
foreignUseIndicator
cardNumber": 
0
"***************0252",
    "
alternateCustomer
currentCardActivation": 
{

"N",
    
   
"
expirationDate
dateBlock": "2023
/12/30"
    }

-09-04"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios 
 no disponibles.
Card Aggregation service
 Info
Incorpora los endpoints de Card​
Validación de campos mandatorios antes del envío a Fiserv​
Expone endpoints a través de un API REST y gRPC​
​POST /cards/embosser/details
Descripción
Request
Response
HTTP Codes
no disponibles.
Obtener cuenta mediante Pantoken Expirado
 Code Block
{
  "panToken": "
0004217470595215803
0004217470200073271",
  "cardSequence": 
2147483647
1,
  "foreignUse": 
0
1
}
 Code Block
{
    
	
"postToAccount": "
9500508261544464147
9500507060523627372",
 
	"blockCode": "Z",
	
   "cardNumber": "***************
*0252",
	"currentCardActivation": "N",
	"dateBlock": "2023-09-04"

8578",
    "currentCardActivation": "N"
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
POST → /v1/cards/embosser/block
Descripción
Request
Response
HTTP Codes
Bloqueo de tarjetas - Bloqueo
 Code Block
{
  "blockCode": "Z",
  "panToken": "0004217470885923553",
  "cardSequence": 1,
  "functionCode": "B" //B para bloquear - u Desbloquear
}
 Code Block
{}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
PUT /account/prepaid
...
Descripción
...
Request
...
Response
...
HTTP Codes
GET /cards/account
...
Descripción
...
Request
...
Response
...
HTTP Codes
PUT /cards/activation​
...
Descripción
...
Request
...
Response
...
HTTP Codes
PUT /cards/embosser/block
Descripción
Request
Response
HTTP Codes
Bloqueo de tarjetas - Desbloqueo
 Code Block
{
  "blockCode": "
Z
",
  "panToken": "
0004217470885923553
0004217470752022413",
  "cardSequence": 1,
  "functionCode": "
B
U" //B para bloquear - u Desbloquear
}
 Code Block
{}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
...