Versions Compared

Old Version 20

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

...

HTTP Codes

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",
   
"
blockCode1Date
blockCode1": "
2023-09-07
U",
"blockCode2":
"M",
     "
blockCode2Date
blockCode1Date": "2023-
08
09-
11
12",
"accountMakerDateOfBirth":
"",
   
"
availableCredit
blockCode2":
0
"X",
"userAmounts9":
0,
     "
userAmounts10
blockCode2Date":
0, 
 
"
userAmounts7": 0
2023-09-13"
    }
}
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
Realiza bloqueos/desbloqueo de cuenta.
13 Internal Server Error: Servicios no disponibles.
SetAccountBlock
Realiza la consulta de bloqueos 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
0995000000000040921"
,

  
"blockCode1Local":
 
"M",
  "localOrganization": 950
}2 OK
 }
}
200: Solicitud exitosa.
4 Bad Request
400: Request con campos no válidos.
401: Apy Key no válida.
5 Internal Server Error
Descripción
Request
Response
HTTP Codes
Sincroniza el mirror de account con la información de Fiserv.
500: Servicios no disponibles.
SynchronizeMirrorAccount
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 Bloqueada
 Code Block
{
  "accountNumber": "
9500501520328494829
9500509377699205330"
}
 Code Block
{
    "accountData": {
        "accountNumber": "
9500501520328494829
9500509377699205330",
        "customerNumber": "
0995000000000035249
0995000000000080636",
    
"blockCode1":
 
"M",
 
   "
blockCode1Date
blockCode1": "
2023-09-07
Z",
    
"blockCode2": "M",

    "
blockCode2Date
blockCode1Date": "2023-
08
09-
11
12"
,

    
"accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 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
GetAccountBalance
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
M"

} Code Block{
 
,
  "
accountOrCardNumber
blockCodeIndicator": 
"9500501520328494829"
0,
  "
currentBalance
foreignUse": 
998176210159
0,
  "
availableCreditLimit
functionCode": 
32237425576994724
"B",
  "
frozenBalance
accountNumber": 
26000
"9500501520328494829"
}
2 OK: Solicitud exitosa.
Descripción
Request
Response
HTTP Codes
Sincroniza el mirror de balance con la información de Fiserv.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
SynchronizeMirrorBalance
 Code Block
{
    "
accountNumber
functionCode": "
9500501520328494829
B",

} Code Block{
    "
accountOrCardNumber
accountNumber": "9500501520328494829",
    "
currentBalance
blockCode1Local": 
998176210159
"M",

 


"availableCreditLimit":
 
32237425576994724,
   "
frozenBalance
localOrganization": 
26000
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 
13 Internal Server Error: Servicios no disponibles.
...
Descripción
Request
Response
HTTP Codes
Realiza una transferencia .
Realiza bloqueos/desbloqueo de cuenta - Bloquear (foreignUse= 1)
 Code Block
{
  "
transactionData
blockCode": 
{

"U",
  
 
"
transactionAmount
blockCodeIndicator": 
1
0,

 

  "
actionCode
foreignUse": 
"8012"
1,



  
 
"
authorizationCode
functionCode": "
311S3q
B",

 

  "
effectiveDate
accountNumber": "
2023-06-21",
9500501520328494829"
}
 Code Block
{
    "
description
functionCode": "
P2P
B",
    "
paidConcept
accountNumber": "
test
9500501520328494829",
    "
memoPostedIndicator
localOrganization": 
"qqq",
    "suppressMonetaryTransaction
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": "
qqq
",

 

  "
n1n2ByPass
blockCodeIndicator": 
"qqq"
2,



  
 
"
identifier
foreignUse": 
"S_IN",
 
0,
  "
box
functionCode": "
3
U",
  
  
"
crPlaza
accountNumber": "
10MON
9500501520328494829"
,


 
}
 Code Block
{
  
"crStore":
 
"50WHN",
 
    
"
keyTracking
functionCode": "
KEYTRACKING0123456789
U",
    "
senderAccount
accountNumber": "
senderAccount012345
9500501520328494829",
    "
beneficiaryAccount
blockCode1Local": "
beneficiaryAccount1
M",
    "
counterpartInstitution
localOrganization": 
"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": "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.
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
{
  "
from
accountNumber": "9500501403742215502"
}
 Code Block
{
    "
accountNumber
accountData":
 "9500508496924050930",
 {
        "
actionCode
accountNumber": "
8008
9500501403742215502",
        "
transactionDescription
customerNumber": "
P2P_TRANSFER_SOURCE
0995000000000080639",
        "
description
blockCode1": "
P2P_TRANSFER_SOURCE
U",
        "
authorizationCode
blockCode1Date": "
1234"
  }
2023-09-12",
  
"to":
 
{
     "
accountNumber
blockCode2": "
9500502030236002994
X",
        "
actionCode
blockCode2Date": "
8012
2023-09-13",
    
"transactionDescription":
 
"P2P_TRANSFER_TARGET",
   
  
"
description
accountMakerDateOfBirth": "
P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
    "effectiveDate": "2022-01-30",
1994-05-06"
    
"transactionAmount": 100,
    "device": "abcfghjfghjklghjkfghjk5678956789",
    "ip": "198.162.123.148",
    "latitude": 123.56565656,
}
}
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
{
    "
longitude
accountData":
 -23.565656,
 {
        "
xTransactionId
accountNumber": "
123"
} Code Block{
9500508152383529456",
        "
effectiveDate
customerNumber": "
2022-01-30
0995000000000040667",
  
"transactionAmount":
 
"100",
   
"actionOutputArea": {
  
  "
actionData": [
      {
        "authorizationCode
accountMakerDateOfBirth": "
1234
2000-01-01",
        "
accountNumber
availableCredit": 
"9500508496924050930"
10000.0,
        "
transactionDescription
userAmounts9": 
"P2P SENDER"
-170000.0,
        "
feeAmount
userAmounts10": 
"
-130000.0
"
,
        "
transactionCode
userAmounts7": 
8008,
        "currentBalance": -5988391,
-10000.0
    
    "creditLimit": 0,
        "openToBuy": 598649100,
}
}
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": {
        "
authorizationNumber
accountNumber": "
507925
9500508176491773011",
      
},
  "customerNumber": "0995000000000080637",
   
{
     
    "authorizationCode
"blockCode1": "
1234
Z",
        "
accountNumber
blockCode1Date": "
9500502030236002994
2023-09-12",
        "
transactionDescription
blockCode2Date": "
P2P RECIEVER
2023-09-18",
        "
feeAmount
accountMakerDateOfBirth": "
0
1994-05-06"
,

    
    "transactionCode": 8012,
        "currentBalance": -169434,
        "creditLimit": 0,
        "openToBuy": 17133400,
        "authorizationNumber": "332272"
      }
    ]
  }
}2 OK
}
}
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.
4 
3 Bad Request: Request con campos no válidos.
5 
13 Internal Server Error: Servicios no disponibles.
...
POST → /v1/balances
Descripción
Request
Response
HTTP Codes
Realiza una transferencia QR
GRPC Codes
Realiza la consulta de balance de cuenta.
 Code Block
{
  "
transactionData
accountNumber":
 {
  
 
 
"
transactionAmount
9500501520328494829"
: 20,
    "actionCode

}
 Code Block
{
	"accountOrCardNumber": "
8038
9500501520328494829",

    "authorizationCode
	"currentBalance": 
"Q1er44"
998176209259,

    "effectiveDate
	"availableCreditLimit": 
"2022-08-24"
1823760996,

    "description
	"frozenBalance": 
"QR code test - normal hours",
    "paidConcept": "Hello",
    "memoPostedIndicator": " ",
    "suppressMonetaryTransaction": "Y",
    "n1n2ByPass": "N",
    "identifier": 0,
    "box": "1",
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
{
    "
crPlaza
accountOrCardNumber": "
10MON
9500503048928881284",
    "
crStore
currentBalance": 
"50WHN"
-10000.0,
    "
keyTracking
availableCreditLimit": 
"Hello",
 
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
{
  "
beneficiaryAccount
accountNumber": "
Hello",
9500501403742215502"
}
 Code Block
{
    "
senderAccount
accountOrCardNumber": "
Hello
9500501403742215502"
,
    "counterpartInstitution": "Hello",
    "operatingInstitution": "Hello",
    "frcUprkBeneficiary": "Hello",
    "orderingFrcUprk": "Hello

}
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",
    "
device
currentBalance": 
"123456789-123456789-123456789-12"
-10000.0,
    "
ip
availableCreditLimit": 
"198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
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
{
    "
recipientName
accountOrCardNumber": "
Hello
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
{
  "
orderingName
transactionData": {
    "
Hello
transactionAmount": 1000,
    "
paymentSourceId
actionCode": "
bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
8000",
    "authorizationCode": "311S3q",
    "
xTransactionId
effectiveDate": "
123
2023-06-21",
    "
accountNumber
description": "
9500508020127353147
P2P",
 
} Code Block{
   "
historyDate
paidConcept": "
2023-09-12
test",
    "
historyTime
memoPostedIndicator": "
111311
qqq",
    "
transactionData
suppressMonetaryTransaction": 
{
"qqq",
    "
transactionCode
n1n2ByPass": "
8038
qqq",
    "
transactionDescription
identifier": "
CASHOUT WITH QR-CODE(FREE BAL)
S_IN",
    "box": "3",
    "
currentBalance
crPlaza": "
-1382946
10MON",
    "
openToBuy
crStore": "
1382326
50WHN",
  
}
}
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{
  "keyTracking": "KEYTRACKING0123456789",
    "
panToken
senderAccount": "
0004217470595215803
senderAccount012345",
    "
cardSequence
beneficiaryAccount": 
2147483647
"beneficiaryAccount1",
 
 "foreignUse":
 
0
 
} Code Block{
 
	
"
postToAccount
counterpartInstitution": "
9500508261544464147
aaaaa",

	"blockCode
    "operatingInstitution": "
Z
bbbbb",
  
	
  "
cardNumber
frcUprkBeneficiary": "
***************0252
frcUprkBenefi",
   
	
 "
currentCardActivation
orderingFrcUprk": "
N
orderingFrcUp",

	"dateBlock
    "device": "
2023
123456789-123456789-
09
123456789-
04
12"

}
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.
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 Codes
Realiza la consulta de bloqueos de cuenta.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block{
  "accountData": {
    "accountNumber": "9500501520328494829",
    "customerNumber": "0995000000000035249",
    "blockCode1": "M",
    "blockCode1Date": "2023-09-07",
    "blockCode2": "M",
    "blockCode2Date": "2023-08-11
,
    "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",
    "
accountMakerDateOfBirth
authorizationCode": "311S3q",
    "
availableCredit
effectiveDate": 
0
"2023-06-21",
    "
userAmounts9
description": 
0
"P2P",
    "
userAmounts10
paidConcept": 
0
"test",
    "
userAmounts7
memoPostedIndicator": 
0
"qqq",
  
}
 
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
SetAccountBlock
Descripción
Request
Response
HTTP Codes
Realiza bloqueos/desbloqueo de cuenta.
 Code Block{
 
  
"
blockCode
suppressMonetaryTransaction": "qqq",
    "
blockCodeIndicator
n1n2ByPass": 
1
"qqq",
    "
foreignUse
identifier": 
0,
"S_IN",
    "
functionCode
box": "
U
3",
    "
accountNumber
crPlaza": "
9500501520328494829
10MON",
 
} Code Block{
   "
functionCode
crStore": "
B
50WHN",
    "
accountNumber
keyTracking": "
9500501520328494829
KEYTRACKING0123456789",
    "
blockCode1Local
senderAccount": "
M
senderAccount012345",
    "
localOrganization
beneficiaryAccount": "beneficiaryAccount1",

950
 
}
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
TransferBalance
Descripción
Request
Response
HTTP Codes
Realiza una transferencia .
 Code Block{
   "
transactionData
counterpartInstitution": 
{
"aaaaa",
    "
transactionAmount
operatingInstitution": 
1
"bbbbb",
    "
actionCode
frcUprkBeneficiary": "
8012
frcUprkBenefi",
    "
authorizationCode
orderingFrcUprk": "
311S3q
orderingFrcUp",
    "
effectiveDate
device": "
2023
123456789-123456789-
06
123456789-
21
12",
    "
description
ip": "
P2P
198.162.200.200",
    "
paidConcept
latitude": 
"test"
-109.699,
    "
memoPostedIndicator
longitude": 
"qqq"
23.062,
    "
suppressMonetaryTransaction
recipientName": "
qqq
recipientName01234567890123456",
    "
n1n2ByPass
orderingName": "
qqq
orderingName012345678901234567",
    "
identifier
paymentSourceId": "
S_IN
paymentSourceId012345"
,

  },
  "
box
xTransactionId": "
3
123",



  
 
"
crPlaza
accountNumber": "
10MON
9500501403742215502",


 
  "
crStore
operationType": "
50WHN",
D"
 }
 Code Block
{
    "
keyTracking
historyDate": "
KEYTRACKING0123456789
2023-09-18",
    "
senderAccount
historyTime": "
senderAccount012345
164651",
    "
beneficiaryAccount
transactionData": 
"beneficiaryAccount1",
{
  
  "counterpartInstitution":
 
"aaaaa",
     "
operatingInstitution
transactionCode": "
bbbbb
8000",
  
  "frcUprkBeneficiary":
 
"frcUprkBenefi",
     "
orderingFrcUprk
openToBuy": "
orderingFrcUp
2000"
,

    
"device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
}
}
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": {
    "
longitude
transactionAmount": 
23.062
1000,
    "
recipientName
actionCode": "
recipientName01234567890123456
8000",
    "
orderingName
authorizationCode": "
orderingName012345678901234567
311S3q",
    "
paymentSourceId
effectiveDate": "
paymentSourceId012345
2023-06-21",
  
}
  "description": "P2P",
    "
xTransactionId
paidConcept": "
123
test",
    "
accountNumber
memoPostedIndicator": "
9500501545918394337
qqq",
 
} Code Block{
   "
historyDate
suppressMonetaryTransaction": "
2023-09-12
qqq",
    "
historyTime
n1n2ByPass": "
111208
qqq",
    "
transactionData
identifier": 
{
"S_IN",
    "
transactionCode
box": "
8012
3",
    "
transactionDescription
crPlaza": "
P2P RECIEVER
10MON",
    "crStore": "50WHN",
    "
currentBalance
keyTracking": "
-2122495
KEYTRACKING0123456789",
    "
openToBuy
senderAccount": "
2122548
senderAccount012345",
   
}
}
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{
 "beneficiaryAccount": "beneficiaryAccount1",
    "
from
counterpartInstitution": 
{
"aaaaa",
    "
accountNumber
operatingInstitution": "
9500508496924050930
bbbbb",
    "
actionCode
frcUprkBeneficiary": "
8008
frcUprkBenefi",
    "
transactionDescription
orderingFrcUprk": "
P2P_TRANSFER_SOURCE
orderingFrcUp",
    "
description
device": "
P2P_TRANSFER_SOURCE
123456789-123456789-123456789-12",
    "
authorizationCode
ip": "
1234"
198.162.200.200",
  
},
  
 
"
to
latitude": 
{
-109.699,
    "
accountNumber
longitude": 
"9500502030236002994"
23.062,
    "
actionCode
recipientName": "
8012
recipientName01234567890123456",
    "
transactionDescription
orderingName": "
P2P_TRANSFER_TARGET
orderingName012345678901234567",
    "
description
paymentSourceId": "
P2P_TRANSFER_SOURCE
paymentSourceId012345"
,

  },
  "
authorizationCode
xTransactionId": "
1234
123"

  }
,
  
  
"
effectiveDate
accountNumber": "
2022-01-30
9500508152383529456", 
  "operationType": "
transactionAmount
D"
: 100,

 }
 Code Block
{
    "
device
historyDate": "
abcfghjfghjklghjkfghjk5678956789
2023-09-18",
    "
ip
historyTime": "
198.162.123.148
164734",
    "
latitude
transactionData": 
123.56565656,

{
  
 "longitude":
 
-23.565656,
     "
xTransactionId
transactionCode": "
123
8000",

} Code Block{
    
"effectiveDate":
 
"2022-01-30",
   "
transactionAmount
currentBalance": "
100
-10000",
  
"actionOutputArea": {
      "
actionData
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": {
    "
authorizationCode
transactionAmount": 
"1234"
1000,



    
   
"
accountNumber
actionCode": "
9500508496924050930
8000",

   

    "
transactionDescription
authorizationCode": "
P2P SENDER
311S3q",
    "effectiveDate": "2023-06-21",
    "
feeAmount
description": "
0
P2P",



    
   
"
transactionCode
paidConcept": 
8008,
   
"test",
    "
currentBalance
memoPostedIndicator": 
-5988391,
 
"qqq",
    
  
"
creditLimit
suppressMonetaryTransaction": 
0,
   
"qqq",
    "
openToBuy
n1n2ByPass": 
598649100
"qqq",
    
    
"
authorizationNumber
identifier": "
507925
S_IN",
    
  }
"box": "3",
    "crPlaza": "10MON",

{
    
     
"
authorizationCode
crStore": "
1234
50WHN",



    
   
"
accountNumber
keyTracking": "
9500502030236002994
KEYTRACKING0123456789",

   

    "
transactionDescription
senderAccount": "
P2P RECIEVER
senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "
feeAmount
counterpartInstitution": "
0
aaaaa",
    "operatingInstitution": "bbbbb",
    "
transactionCode
frcUprkBeneficiary": 
8012
"frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "
currentBalance
device": 
-169434
"123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "
creditLimit
latitude": 
0
-109.699,
    "longitude": 23.062,
    "
openToBuy
recipientName": 
17133400
"recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "
authorizationNumber
paymentSourceId": "
332272
paymentSourceId012345"
  },
  
 }
"xTransactionId": "123",
  "accountNumber": "9500508176491773011", 

]
  
 }
}
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{
"operationType": "D"
 }
 Code Block
{
    "
transactionData
historyDate": 
{
"2023-09-18",
    "
transactionAmount
historyTime": 
20
"164818",
    "
actionCode
transactionData": 
"8038",
{
        "
authorizationCode
transactionCode": "
Q1er44
8000",
        "
effectiveDate
openToBuy": "
2022-08-24
2000"
,

    
"description": "QR code test - normal hours",
}
}
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": {
    "
paidConcept
accountNumber": "
Hello
9500508496924050930",
    "
memoPostedIndicator
actionCode": "
 
8008",
    "
suppressMonetaryTransaction
transactionDescription": "
Y
P2P_TRANSFER_SOURCE",
    "
n1n2ByPass
description": "
N
P2P_TRANSFER_SOURCE",
    "
identifier
authorizationCode":
 0,
   
 "
box
1234"
:


"1",
  },
  "
crPlaza
to": 
"10MON",
{
    "
crStore
accountNumber": "
50WHN
9500502030236002994",
    "
keyTracking
actionCode": "
Hello
8012",
    "
beneficiaryAccount
transactionDescription": "
Hello
P2P_TRANSFER_TARGET",
    "
senderAccount
description": "
Hello
P2P_TRANSFER_SOURCE",
    "
counterpartInstitution
authorizationCode": "
Hello
1234"
,

  
  "operatingInstitution": "Hello"
},
    "
frcUprkBeneficiary
effectiveDate": "
Hello
2022-01-30",
    "
orderingFrcUprk
transactionAmount": 
"Hello"
100,
    "device": "
123456789-123456789-123456789-12
abcfghjfghjklghjkfghjk5678956789",
    "ip": "198.162.
200
123.
200
148",
    "latitude": 
-109
123.
699
56565656,
    "longitude": -23.
062
565656,
    "
recipientName
xTransactionId": "
Hello
123"
,


    "orderingName
}
 Code Block
{
	"effectiveDate": "
Hello
2022-01-30",

    "paymentSourceId
	"transactionAmount": "
bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508020127353147"
}
 Code Block
{
  "historyDate": "2023-09-12",
  "historyTime": "111311",
  "transactionData": {
    "transactionCode": "8038",
    "transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
    "currentBalance": "-1382946",
    "openToBuy": "1382326"
  }
}
2 OK: Solicitud exitosa.
4 
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.
5 
13 Internal Server Error: Servicios no disponibles.
...
PUT → /v1/balances/transfers-qr
Descripción
Request
Response
HTTP Codes
Realiza la consulta de balance de cuenta
GRPC Codes
Realiza una transferencia QR.
 Code Block
{
  "
accountNumber
transactionData": {

"9500501520328494829"
 
} Code Block{
   "
accountOrCardNumber
transactionAmount": 
"9500501520328494829"
20,
    "
currentBalance
actionCode": 
998176210159
"8038",
    "
availableCreditLimit
authorizationCode": 
32237425576994724
"Q1er44",
    "
frozenBalance
effectiveDate":
 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
...
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 Internal Server Error: Servicios no disponibles.
UpdateCustomer
...
Descripción
...
Request
...
Response
...
HTTP Codes
...
Actualizar cliente
...
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
...
2 OK: Solicitud exitosa.
4 Bad Request: Request con campos no válidos.
5 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
POST → /v1/cards/embosser/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.
POST → /v1/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.
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
Realiza la consulta de bloqueos de cuenta.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
	"accountData": {
		"accountNumber": "9500501520328494829",
		"customerNumber": "0995000000000035249",
		"blockCode1": "M",
		"blockCode1Date": "2023-09-06",
		"blockCode2": "M",
		"blockCode2Date": "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/accounts/blocks
Descripción
Request
Response
HTTP Codes
Realiza bloqueos/desbloqueo de cuenta.
 Code Block
{
  "blockCode": "",
  "blockCodeIndicator": 1,
  "foreignUse": 0,
  "functionCode": "U",
  "accountNumber": "9500501520328494829"
}
 Code Block
{
	"functionCode": "U",
	"accountNumber": "9500501520328494829",
	"localOrganization": 950
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
POST → /v1/accounts/syncs
Descripción
Request
Response
HTTP Codes
Sincroniza el mirror de account con la información de Fiserv.
 Code Block
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
	"accountData": {
		"accountNumber": "9500501520328494829",
		"customerNumber": "0995000000000035249",
		"blockCode1": "M",
		"blockCode1Date": "2023-09-06",
		"blockCode2": "M",
		"blockCode2Date": "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
 "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.
13 Internal Server Error: Servicios no disponibles.
PUT → /customers
Descripción
Request
Response
HTTP Codes
GRPC Codes
Actualización de los datos del cliente en el proveedor de clientes.
 Code Block
{
    "email": "lmedina@palo-it.com",
    "numberType": 1,
    "customerNumber": "0995000000000077863",
    "address": "Ciruelas",
    "dateOfBirth": "1999-02-06",
    "city": "Villa de Alvarez",
    "countryCode": "MEX",
    "county": "CDMX",
    "colony": "ADOLFO LOPEZ MATEOS",
    "externalNumber": "1007",
    "firstName": "Sandra",
    "genderCode": 2,
    "houseNumber": "123",
    "ine": "1234117890099",
    "lastName": "Velasco",
    "maritalStatus": 0,
    "maternalLastName": "Medina",
    "middleName": "Rosa",
    "mobilePhoneIndicator": 1,
    "mobilePhoneNumber": "31211635899",
    "occupation": "NURSE",
    "ownOrRentResidenceFlag": 0,
    "postalCode": 54070,
    "stateOfBirth": "DF"
}
 Code Block
{
    "outputArea": {
        "customerNumber": "0995000000000077863",
        "accountNumber": "0995000000000077863",
        "responseCode": "",
        "level": "",
        "transactionAmount": 0,
        "countryLimit": {
            "dailyLimitLoad": 0,
            "monthlyLimitLoad": 0,
            "dailyLimitCash": 0,
            "monthlyLimitCash": 0,
            "limitForDepositTransactions": 0
        },
        "accountLimit": {
            "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
Descripción
Request
Response
HTTP Codes
GRPC Codes
Vinculación del cliente en la cuenta de Spin.
 Code Block
{
    "accountNumber": "0004217470138987703",
    "customerNumber": "0995000000000045698",
    "qualification": "1",
    "customerTypeIndicator": 0,
    "foreignUseIndicator": 0,
    "alternateCustomer": {
        "expirationDate": "2023/12/30"
    }
}
 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.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: 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
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 /cards/account
Descripción
Request
Response
HTTP Codes
Vinculación de tarjetas a cuenta
 Code Block
 {
  "customerOrAccountNumber": "1234567890123456800",
  "cardNumber": "000123456ID5IXX1234",
  "cardholderType": 1
}
 Code Block
{
  "customerOrAccountNumber": "1234567890123456800",
  "cardNumber": "000123456ID5IXX1234",
}
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
POST /cards/account
Descripción
Request
Response
HTTP Codes
Recuperación del numero de cuenta 
 Code Block
{
  "cardNumber": "000123456ID5IXX1234",
}

 Code Block
{
    "accountNumber": "0004217470041850252"
}
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",
    "customerNumber": "0995000000000035249",
    "blockCode1": "M",
    "blockCode1Date": "2023-09-07",
    "blockCode2": "M",
    "blockCode2Date": "2023-08-11",
    "accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 0
  }
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
SetAccountBlock
Descripción
Request
Response
GRPC Codes
Realiza bloqueos/desbloqueo de cuenta.
 Code Block
{
  "blockCode": "",
  "blockCodeIndicator": 1,
  "foreignUse": 0,
  "functionCode": "U",
  "accountNumber": "9500501520328494829"
}
 Code Block
{
  "functionCode": "B",
  "accountNumber": "9500501520328494829",
  "blockCode1Local": "M",
  "localOrganization": 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
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
  "accountData": {
    "accountNumber": "9500501520328494829",
    "customerNumber": "0995000000000035249",
    "blockCode1": "M",
    "blockCode1Date": "2023-09-07",
    "blockCode2": "M",
    "blockCode2Date": "2023-08-11",
    "accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 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
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
  "accountOrCardNumber": "9500501520328494829",
  "currentBalance": 998176210159,
  "availableCreditLimit": 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
{
  "accountNumber": "9500501520328494829"
}
 Code Block
{
  "accountOrCardNumber": "9500501520328494829",
  "currentBalance": 998176210159,
  "availableCreditLimit": 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
{
  "transactionData": {
    "transactionAmount": 1,
    "actionCode": "8012",
    "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",
  "operationType": "W"
  },
  "xTransactionId": "123",
  "accountNumber": "9500501545918394337"
}
 Code Block
{
  "historyDate": "2023-09-12",
  "historyTime": "111208",
  "transactionData": {
    "transactionCode": "8012",
    "transactionDescription": "P2P RECIEVER",
    "currentBalance": "-2122495",
    "openToBuy": "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
{
  "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"
      }
    ]
  }
}
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": "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-12",
  "historyTime": "111311",
  "transactionData": {
    "transactionCode": "8038",
    "transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
    "currentBalance": "-1382946",
    "openToBuy": "1382326"
  }
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 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
{
  "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.
...
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
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-07",
    "blockCode2": "M",
    "blockCode2Date": "2023-08-11",
    "accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 0
  }
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: Servicios no disponibles.
SetAccountBlock
Descripción
Request
Response
GRPC Codes
Realiza bloqueos/desbloqueo de cuenta.
 Code Block
{
  "blockCode": "",
  "blockCodeIndicator": 1,
  "foreignUse": 0,
  "functionCode": "U",
  "accountNumber": "9500501520328494829"
}
 Code Block
{
  "functionCode": "B",
  "accountNumber": "9500501520328494829",
  "blockCode1Local": "M",
  "localOrganization": 950
}
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
{
  "transactionData": {
    "transactionAmount": 1,
    "actionCode": "8012",
    "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": "9500501545918394337"
}
 Code Block
{
  "historyDate": "2023-09-12",
  "historyTime": "111208",
  "transactionData": {
    "transactionCode": "8012",
    "transactionDescription": "P2P RECIEVER",
    "currentBalance": "-2122495",
    "openToBuy": "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
{
  "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"
      }
    ]
  }
}
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": "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-12",
  "historyTime": "111311",
  "transactionData": {
    "transactionCode": "8038",
    "transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
    "currentBalance": "-1382946",
    "openToBuy": "1382326"
  }
}
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": "9500501520328494829"
}
 Code Block
{

	
  "accountOrCardNumber": "9500501520328494829",
 
	
 "currentBalance": 
998176209259
998176210159,

	
  "availableCreditLimit": 
1823760996
32237425576994724,
  
	
"frozenBalance": 26000
.0

}
200
0 OK: Solicitud exitosa.
400
3 Bad Request: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
...
13 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 
GRPC Codes
Realiza una transferencia .
Creación del cliente
 Code Block
{
    "
transactionData
logo": "60",
    "address": 
{
"Ciruelas",
    "
transactionAmount
houseNumber": 
1
"12345",
    "
actionCode
externalNumber": "
8012
8007",
    "
authorizationCode
colony": "
311S3q
Lomas",
    "
effectiveDate
city": "
2023-06-21
Lomas de Alvarez",
    "
description
state": "
P2P
COL",
    "
paidConcept
postalCode": "
test
99980",
    "
memoPostedIndicator
dateOfBirth": 
"qqq
"2000-08-06",
    "
suppressMonetaryTransaction
stateOfBirth": "
qqq
CDMX",
    "
n1n2ByPass
email": "
qqq
lmedina@palo-it.com",
    "
identifier
firstName": "
S_IN
Judith",
    "
box
lastName": "
3
Medina",
    "
crPlaza
maternalLastName": "
10MON
Ruiz",
    "
crStore
mobilePhoneNumber": "
50WHN
5521163588",
    "
keyTracking
identificationNumber": "
KEYTRACKING0123456789
4152554487415113698",
    "
senderAccount
ine": "
senderAccount012345
1234117890099",
    "
beneficiaryAccount
occupation": "
beneficiaryAccount1
Tester",
    "
counterpartInstitution
genderCode": "
aaaaa
1",
    "
operatingInstitution
user4":
 
"
bbbbb
1",
    "
frcUprkBeneficiary
identificationNumberFlag": "
frcUprkBenefi",
2"
}
 Code Block
{
    "
orderingFrcUprk
customerNumber": 
"orderingFrcUp",
"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
{
    "
device
email": "
123456789-123456789-123456789-12
lmedina@palo-it.com",
    "
ip
numberType": 
"198.162.200.200"
1,
    "
latitude
customerNumber": 
-109.699,
    "longitude": 23.062
"0995000000000077863",
    "
recipientName
address": "
recipientName01234567890123456
Ciruelas",
    "
orderingName
dateOfBirth": "
orderingName012345678901234567
1999-02-06",
    "
paymentSourceId
city": "
paymentSourceId012345
Villa de Alvarez",
  
},
  
 
"
xTransactionId
countryCode": "
123
MEX",
  
"accountNumber":
 
"9500501545918394337"
 
} Code Block{
	"historyDate
"county": "
2023-09-08
CDMX",

	"historyTime":
 
"122250",
 
	"transactionData":
 
{
 
		
"
transactionCode
colony": "
8012
ADOLFO LOPEZ MATEOS",
  
		
  "
transactionDescription
externalNumber": "
P2P RECIEVER
1007",
    
		
"
currentBalance
firstName": "
-2122495
Sandra",
    
		
"
openToBuy
genderCode": 
"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": {
2,
    "houseNumber": "123",
    "
accountNumber
ine": "
9500508496924050930
1234117890099",
    "
actionCode
lastName": "
8008
Velasco",
    "
transactionDescription
maritalStatus": 
"P2P_TRANSFER_SOURCE"
0,
    "
description
maternalLastName": "
P2P_TRANSFER_SOURCE
Medina",
    "
authorizationCode
middleName": "
1234
Rosa",
  
},
  
 
"
to
mobilePhoneIndicator": 
{
1,
    "
accountNumber
mobilePhoneNumber": "
9500502030236002994
31211635899",
    "
actionCode
occupation": "
8012
NURSE",
    "
transactionDescription
ownOrRentResidenceFlag": 
"P2P_TRANSFER_TARGET"
0,
    "postalCode": 54070,
    "
description
stateOfBirth": "
P2P_TRANSFER_SOURCE",
DF"
}
 Code Block
{
    "
authorizationCode
outputArea": 
"1234"
{
   
},
     "
effectiveDate
customerNumber": "
2022-01-30
0995000000000077863",
        "accountNumber": "
transactionAmount": 100,
0995000000000077863",
        "
device
responseCode": "
abcfghjfghjklghjkfghjk5678956789
",
        "
ip
level": "
198.162.123.148
",
        "
latitude
transactionAmount": 
123.56565656,
0,
        "
longitude
countryLimit": 
-23.565656,
{
         
"xTransactionId":
 
"123"
 
} Code Block{
 
	
"
effectiveDate
dailyLimitLoad": 
"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.
400500
0,
            "monthlyLimitLoad": 0,
            "dailyLimitCash": 0,
            "monthlyLimitCash": 0,
            "limitForDepositTransactions": 0
        },
        "accountLimit": {
            "accountDailyAmountLoad": 0,
            "accountMonthlyAmountLoad": 0,
            "accountDailyAmountCash": 0,
            "accountMonthlyAmountCash": 0
        }
    }
}
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
401: Apy Key no válida.
13 Internal Server Error: Servicios no disponibles.
...
LinkAccountToCustomer
Descripción
Request
Response
HTTP 
GRPC Codes
Realiza una transferencia QR.
Vincular cuenta al cliente
 Code Block
{
  "
transactionData
accountNumber":
 {
 
 
  
"
transactionAmount
9500505675946730065"
: 20
,
  
  
"
actionCode
alternateCustomer": 
"8038",

  {
 
"authorizationCode":
 
"Q1er44",

  
  
"
effectiveDate
expirationDate": "
2022
2023-08-
24
22"
,

  },
  "
description
customerNumber":
 "QR code test - normal hours
 "0995000000000075954",

 

  "
paidConcept
qualification": "
Hello
2",
  "customerTypeIndicator": 0,
  "
memoPostedIndicator
foreignUseIndicator": 
" ",
0
}
 Code Block
{
    "
suppressMonetaryTransaction
customerNumber": "
Y
0995000000000045697",
    "
n1n2ByPass
accountNumber": "
N",
 
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
{
  "
identifier
cardNumber": 
0,
    "box": "1",
"0004217470072001676"
}
 Code Block
{
    "
crPlaza
accountNumber": "
10MON
0004217470072001676"
,
    "crStore": "50WHN",
    "keyTracking": "Hello",
    "beneficiaryAccount": "Hello",
    "senderAccount": "Hello",
    "counterpartInstitution": "Hello",

}
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
{
    "
operatingInstitution
cardNumber": "
Hello
***************4568",
    "
frcUprkBeneficiary
customerOrAccountNumber": "
Hello
9500507060523627372"
,
    "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.
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
Registro del cliente en la el proveedor de clientes.

}
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
...
Actualización de los datos del cliente en el proveedor de clientes.
...
200: Solicitud exitosa.
400: Request con campos no válidos.
401: Apy Key no válida.
500: Servicios no disponibles.
POST → /customers/account
Descripción
Request
Response
HTTP Codes
Vinculación del cliente en la cuenta de Spin.
Descripción
Request
Response
HTTP Codes
Obtener cuenta mediante Pantoken Activo
 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.
Obtener cuenta mediante Pantoken Inactivo
 Code Block
{
  "panToken": "0004217470595215803",
  "cardSequence": 1,
  "foreignUse": 1
}
 Code Block
{
    "postToAccount": "9500507060523627372",
    "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 → /customers
...
Descripción
...
Request
...
Response
...
HTTP Codes
Obtener cuenta mediante Pantoken Expirado
 Code Block
{
  "panToken": "0004217470200073271",
  "cardSequence": 1,
  "foreignUse": 1
}
 Code Block
{
    "postToAccount": "9500507060523627372",
    "cardNumber": "***************8578",
    "currentCardActivation": "N"
}
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​
...
401: Apy Key no válida.
500: Servicios no disponibles.
POST → /v1/cards/embosser/
...
block
Descripción
Request
Response
HTTP Codes
Obtener cuenta mediante Pantoken
Bloqueo de tarjetas - Bloqueo
 Code Block
{
  "
panToken
blockCode": "
0004217470595215803
Z",
  "
cardSequence": 2147483647,
  "foreignUse": 0
}
 Code Block
{
	"postToAccount": "9500508261544464147",
	"blockCode": "Z",
	"cardNumber": "***************0252",
	"currentCardActivation": "N",
	"dateBlock": "2023-09-04"
}
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
PUT /cards/activation​
...
Descripción
...
Request
...
Response
...
HTTP Codes
PUT /cards/embosser/block
Descripción
Request
Response
HTTP Codes
Request
Response
HTTP Codes
GET /cards/account
...
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.
...