...

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

minLevel	1
maxLevel	6
outline	false
type	list
printable	false

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

panelIconId	atlassian-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

U",
        "blockCode1Date": "2023-09-

07

12",
        "blockCode2": "

M

X",
        "blockCode2Date": "2023-

08

09-

11

13"

,

"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.

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

0995000000000040921"

,

"blockCode1Local":

"M",

"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": 0,

"2023-09-12"

"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	GRPC Codes
Realiza

la consulta de balance de cuenta.

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.

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 Block{

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

Descripción

Request

Response

HTTP Codes

Realiza una transferencia .

13 Internal Server Error: Servicios no disponibles.

TransferBalance

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":

test", "memoPostedIndicator"

functionCode": "

qqq

B",
    "

suppressMonetaryTransaction

accountNumber": "

qqq

9500501520328494829",
    "

n1n2ByPass

localOrganization":

"qqq", "identifier": "S_IN", "box": "3", "crPlaza": "10MON", "crStore": "50WHN", "keyTracking": "KEYTRACKING0123456789", "senderAccount": "senderAccount012345",

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
{ "

beneficiaryAccount

functionCode": "

beneficiaryAccount1

U",
    "

counterpartInstitution

accountNumber": "

aaaaa

9500501520328494829",
    "

operatingInstitution

blockCode1Local": "

bbbbb

M",
    "

frcUprkBeneficiary

localOrganization":

"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" }

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
{ "

historyDate

accountNumber": "

2023-09-12",

9500503048928881284"
}

Code Block
{ "

historyTime

accountData":

"111208",

"transactionData":

{

transactionCode

accountNumber": "

8012

9500503048928881284",
        "

transactionDescription

customerNumber": "

P2P RECIEVER

0995000000000076294",
        "

currentBalance

accountMakerDateOfBirth": "1994-05-

2122495

06",
        "

openToBuy

availableCredit": 10000.0,

"2122548" } }2

"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.

4

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

5

Descripción

Request

Response

HTTP Codes

Realiza una transferencia P2P.

13 Internal Server Error: Servicios no disponibles.

TransferPeerToPeer

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":

"P2P_TRANSFER_SOURCE",

authorizationCode

blockCode1": "

1234

U"

}

"to":

{

accountNumber

blockCode1Date": "

9500502030236002994

2023-09-12",

"actionCode":

"8012",

transactionDescription

blockCode2": "

P2P_TRANSFER_TARGET

X",

"description":

"P2P_TRANSFER_SOURCE",

authorizationCode

blockCode2Date": "

1234"

2023-09-13",

},

effectiveDate

accountMakerDateOfBirth": "

2022

1994-

01

05-

30

06"

,

"transactionAmount": 100, "device": "abcfghjfghjklghjkfghjk5678956789",

}
}

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
{ "

ip

accountData":

"198.162.123.148",

 {
        "

latitude

accountNumber":

123.56565656,

longitude": -23.565656

9500508152383529456",

"xTransactionId":

"123"

} Code Block{

effectiveDate

customerNumber": "

2022-01-30", "transactionAmount": "100

0995000000000040667",

"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,

-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
{ "

currentBalance

accountNumber":

-5988391,

"9500508176491773011"
}

Code Block
{

creditLimit

accountData":

0,

{
        "

openToBuy

accountNumber":

598649100

"9500508176491773011",
        "

authorizationNumber

customerNumber": "

507925

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: Solicitud exitosa.

4

}
}

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.

5

13 Internal Server Error: Servicios no disponibles.

...

POST → /v1/balances

Descripción	Request	Response	HTTP Codes	GRPC Codes
Realiza

una transferencia QR

la consulta de balance de cuenta.

Code Block
{ "

transactionData

accountNumber": "9500501520328494829"
}

Code Block
{

"transactionAmount

	"accountOrCardNumber":

20

"9500501520328494829",

"actionCode

	"currentBalance":

"8038"

998176209259,

"authorizationCode

	"availableCreditLimit":

"Q1er44"

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
{ "

effectiveDate

accountNumber": "

2022-08-24

9500501520328494829"

,

Code Block
{ "

description

accountOrCardNumber": "9500503048928881284"

QR

code

test

-

normal

hours"

"currentBalance": -10000.0,
    "

paidConcept

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
{ "

memoPostedIndicator

accountNumber": "9500501403742215502"

",

Code Block
{ "

suppressMonetaryTransaction

accountOrCardNumber": "

Y

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
{ "

n1n2ByPass

accountNumber": "

N

9500508152383529456"

,

Code Block
{

"identifier":

0,

box

accountOrCardNumber": "

1

9500508152383529456",
    "

crPlaza

currentBalance":

"10MON"

-10000.0,
    "

crStore

availableCreditLimit":

"50WHN",

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
{ "

keyTracking

accountNumber": "

Hello

9500508176491773011"

,

Code Block
{

"beneficiaryAccount":

Hello", "senderAccount

accountOrCardNumber": "

Hello

9500508176491773011"

, "counterpartInstitution": "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.

PUT → /v1/balances/transfers

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza una transferencia - Número de cuenta Activa

Code Block
{ "transactionData": { "

operatingInstitution

transactionAmount":

"Hello"

1000,
    "

frcUprkBeneficiary

actionCode": "

Hello

8000",
    "

orderingFrcUprk

authorizationCode": "

Hello

311S3q",
    "

device

effectiveDate": "

123456789

2023-

123456789

06-

123456789-12

21",
    "

ip

description": "

198.162.200.200

P2P",
    "

latitude

paidConcept":

-109.699

"test",
    "

longitude

memoPostedIndicator":

23.062

"qqq",
    "

recipientName

suppressMonetaryTransaction": "

Hello

qqq",
    "

orderingName

n1n2ByPass": "

Hello

qqq",
    "

paymentSourceId

identifier": "

bf0469d7-b507-44d6-af7d-d4edea6340f1" },

S_IN",
    "

xTransactionId

box": "

123

3",
    "

accountNumber

crPlaza": "

9500508020127353147

10MON",

} Code Block{

historyDate

crStore": "

2023-09-12

50WHN",
    "

historyTime

keyTracking": "

111311

KEYTRACKING0123456789",
    "

transactionData

senderAccount":

{

"senderAccount012345",
    "

transactionCode

beneficiaryAccount": "

8038

beneficiaryAccount1",
    "

transactionDescription

counterpartInstitution": "

CASHOUT WITH QR-CODE(FREE BAL)

aaaaa",
    "

currentBalance

operatingInstitution": "

-1382946

bbbbb",
    "

openToBuy

frcUprkBeneficiary": "

1382326

frcUprkBenefi",

}

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{

panToken

orderingFrcUprk": "

0004217470595215803

orderingFrcUp",
    "

cardSequence

device":

2147483647

"123456789-123456789-123456789-12",

"foreignUse":

0

} Code Block{

postToAccount

ip": "

9500508261544464147

198.162.200.200",

blockCode

latitude":

"Z", "cardNumber

-109.699,
    "longitude": 23.062,
    "recipientName": "

***************0252

recipientName01234567890123456",

"currentCardActivation

    "orderingName": "

N

orderingName012345678901234567",

dateBlock

paymentSourceId": "

2023-09-04

paymentSourceId012345"

}

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

 },
  "xTransactionId": "123",
  "accountNumber": "9500503048928881284", 
  "operationType": "D"
 }

Code Block
{ "

blockCode

historyDate": "

Z

2023-09-18",
    "

panToken

historyTime": "

0004217470885923553

164440",
    "transactionData": {
        "

cardSequence

transactionCode":

1

"8000",
        "

functionCode

currentBalance": "

B" //B para bloquear - u Desbloquear } Code Block{

Descripción

Request

Response

HTTP Codes

Realiza la consulta de bloqueos de cuenta.

-10000",
        "openToBuy": "13000"
    }
}

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

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
{ "

accountNumber

transactionData": {

"9500501520328494829"

} Code Block{

accountData

transactionAmount":

{

1000,
    "

accountNumber

actionCode": "

9500501520328494829

8000",
    "

customerNumber

authorizationCode": "

0995000000000035249

311S3q",
    "

blockCode1

effectiveDate": "

M

2023-06-21",
    "

blockCode1Date

description": "

2023-09-07

P2P",
    "

blockCode2

paidConcept": "

M

test",
    "

blockCode2Date

memoPostedIndicator": "

2023-08-11

qqq",
    "

accountMakerDateOfBirth

suppressMonetaryTransaction": "qqq",
    "

availableCredit

n1n2ByPass":

0

"qqq",
    "

userAmounts9

identifier":

0

"S_IN",
    "

userAmounts10

box":

0

"3",
    "

userAmounts7

crPlaza":

0 } }

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{

"10MON",
    "

blockCode

crStore": "50WHN",
    "

blockCodeIndicator

keyTracking":

1

"KEYTRACKING0123456789",
    "

foreignUse

senderAccount":

0

"senderAccount012345",
    "

functionCode

beneficiaryAccount": "

U

beneficiaryAccount1",
    "

accountNumber

counterpartInstitution": "

9500501520328494829

aaaaa",

} Code Block{

functionCode

operatingInstitution": "

B

bbbbb",
    "

accountNumber

frcUprkBeneficiary": "

9500501520328494829

frcUprkBenefi",
    "

blockCode1Local

orderingFrcUprk": "

M

orderingFrcUp",
    "

localOrganization

device":

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{

"123456789-123456789-123456789-12",
    "

transactionData

ip":

{

"198.162.200.200",
    "

transactionAmount

latitude":

1

-109.699,
    "

actionCode

longitude":

"8012"

23.062,
    "

authorizationCode

recipientName": "

311S3q

recipientName01234567890123456",
    "

effectiveDate

orderingName": "

2023-06-21

orderingName012345678901234567",
    "

description

paymentSourceId": "

P2P

paymentSourceId012345"

,

"paidConcept": "test",

},
  "

memoPostedIndicator

xTransactionId": "

qqq

123",

suppressMonetaryTransaction

accountNumber": "

qqq

9500501403742215502",

n1n2ByPass

operationType": "

qqq

D"

, "identifier": "S_IN",

Code Block
{ "

box

historyDate": "

3

2023-09-18",
    "

crPlaza

historyTime": "

10MON

164651",
    "

crStore

transactionData":

"50WHN",

"keyTracking":

"KEYTRACKING0123456789",

senderAccount

transactionCode": "

senderAccount012345

8000",

"beneficiaryAccount":

"beneficiaryAccount1",

counterpartInstitution

openToBuy": "

aaaaa

2000"

,

"operatingInstitution": "bbbbb", "frcUprkBeneficiary": "frcUprkBenefi",

}
}

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": { "

orderingFrcUprk

transactionAmount":

"orderingFrcUp"

1000,
    "

device

actionCode": "

123456789-123456789-123456789-12

8000",
    "

ip

authorizationCode": "

198.162.200.200

311S3q",
    "

latitude

effectiveDate":

-109.699

"2023-06-21",
    "

longitude

description":

23.062

"P2P",
    "

recipientName

paidConcept": "

recipientName01234567890123456

test",
    "

orderingName

memoPostedIndicator": "

orderingName012345678901234567

qqq",
    "

paymentSourceId

suppressMonetaryTransaction": "

paymentSourceId012345

qqq",

},

"n1n2ByPass": "qqq",
    "

xTransactionId

identifier": "

123

S_IN",
    "

accountNumber

box": "

9500501545918394337

3",

} Code Block{

historyDate

crPlaza": "

2023-09-12

10MON",
    "

historyTime

crStore": "

111208

50WHN",
    "

transactionData

keyTracking":

{

"KEYTRACKING0123456789",
    "

transactionCode

senderAccount": "

8012

senderAccount012345",
    "

transactionDescription

beneficiaryAccount":

"P2P RECIEVER

"beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "

currentBalance

operatingInstitution": "

-2122495

bbbbb",
    "

openToBuy

frcUprkBeneficiary": "

2122548

frcUprkBenefi",

} }

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": {

 "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "

accountNumber

ip": "

9500508496924050930

198.162.200.200",
    "

actionCode

latitude":

"8008"

-109.699,
    "

transactionDescription

longitude":

"P2P_TRANSFER_SOURCE"

23.062,
    "

description

recipientName": "

P2P_TRANSFER_SOURCE

recipientName01234567890123456",
    "

authorizationCode

orderingName": "

1234

orderingName012345678901234567",

},

  "paymentSourceId": "

to

paymentSourceId012345"

:

{

  },
  "

accountNumber

xTransactionId": "

9500502030236002994

123",

actionCode

accountNumber": "

8012

9500508152383529456",

transactionDescription

operationType": "

P2P_TRANSFER_TARGET

D"

,

Code Block
{

"description":

"P2P_TRANSFER_SOURCE",

authorizationCode

historyDate": "

1234" }

2023-09-18",
    "

effectiveDate

historyTime": "

2022-01-30

164734",
    "

transactionAmount

transactionData":

100,

"device": "abcfghjfghjklghjkfghjk5678956789",

ip

transactionCode": "

198.162.123.148

8000",

"latitude":

123.56565656,

longitude

currentBalance": "-

23.565656

10000",

"xTransactionId":

"123"

} Code Block{

effectiveDate

openToBuy": "

2022-01-30

12000"

,

"transactionAmount":

"100",

"actionOutputArea

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": { "

actionData

transactionAmount":

[

1000,
    "actionCode": "8000",

{

"authorizationCode": "

1234

311S3q",

accountNumber

effectiveDate": "

9500508496924050930

2023-06-21",

transactionDescription

description": "P2P

SENDER

",

feeAmount

paidConcept": "

0

test",

transactionCode

memoPostedIndicator":

8008,

"qqq",

currentBalance

suppressMonetaryTransaction":

-5988391

"qqq",

creditLimit

n1n2ByPass":

0,

"qqq",
    "

openToBuy

identifier":

598649100,

"S_IN",
    "

authorizationNumber

box": "

507925

3",

}

"crPlaza": "10MON",
    "crStore": "50WHN",

{

    "keyTracking": "KEYTRACKING0123456789",
    "

authorizationCode

senderAccount": "

1234

senderAccount012345",

accountNumber

beneficiaryAccount": "

9500502030236002994

beneficiaryAccount1",

transactionDescription

counterpartInstitution": "

P2P RECIEVER

aaaaa",

feeAmount

operatingInstitution": "

0

bbbbb",

transactionCode

frcUprkBeneficiary":

8012

"frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",

"currentBalance": -169434, "creditLimit": 0, "openToBuy": 17133400, "authorizationNumber": "332272" } ] } }

2 OK: Solicitud exitosa.

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

5 Internal Server Error: Servicios no disponibles.

...

"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.

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

Realiza una transferencia QR.

Vinculación de tarjetas a cuenta

Code Block
{ "

transactionData

customerOrAccountNumber":

{

"1234567890123456800",

transactionAmount

cardNumber":

20

"000123456ID5IXX1234",

actionCode

cardholderType":

"8038",

1
}

Code Block
{ "

authorizationCode

customerOrAccountNumber": "

Q1er44

1234567890123456800",

effectiveDate

cardNumber": "

2022-08-24",

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
{ "

description

cardNumber": "000123456ID5IXX1234"

QR

,
}

Code Block
{

test

-

normal

hours

"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
{ "

paidConcept

organizationNumber":

"Hello"

999,

memoPostedIndicator

cardNumber": "

000123456ID5IXX1234",

suppressMonetaryTransaction

serviceType": "

Y

A",

n1n2ByPass

userData": "

N

string"

,

Code Block
{ "

identifier

organizationNumber":

0

999,

box

logo":

"

crPlaza

cardNumber": "

10MON

000123456ID5IXX1234",

crStore

serviceType": "

50WHN

A",
  "numberCardsActivated": 1,
  "

keyTracking

foreignOrg":

"Hello"

1,

beneficiaryAccount

numberForeignCardsActivated":

"Hello",

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
{ "

senderAccount

blockCode": "

Hello

Z",

counterpartInstitution

panToken": "

Hello

0004217470885923553",

operatingInstitution

cardSequence":

"Hello"

1,

frcUprkBeneficiary

functionCode": "

Hello", "orderingFrcUprk": "Hello", "device": "123456789-123456789-123456789-12", "ip": "198.162.200.200",

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": { "

latitude

accountNumber":

-109.699,

longitude

9500501520328494829"

: 23.062

,
    "

recipientName

customerNumber": "

Hello

0995000000000035249",
    "

orderingName

blockCode1": "

Hello

M",
    "

paymentSourceId

blockCode1Date": "

bf0469d7

2023-

b507-44d6-af7d-d4edea6340f1" }

09-07",

"xTransactionId":

"123",

accountNumber

blockCode2": "

9500508020127353147" } Code Block{ "historyDate": "2023-09-12", "historyTime": "111311",

M",
    "

transactionData

blockCode2Date":

{

"2023-08-11",
    "

transactionCode

accountMakerDateOfBirth": "

8038

",
    "

transactionDescription

availableCredit":

"CASHOUT WITH QR-CODE(FREE BAL)"

0,
    "userAmounts9": 0,
    "

currentBalance

userAmounts10":

"-1382946"

0,
    "

openToBuy

userAmounts7":

"1382326"

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

la consulta de balance

bloqueos/desbloqueo de cuenta.

Code Block
{ "blockCode": "", "blockCodeIndicator": 1, "foreignUse": 0, "functionCode": "U", "accountNumber": "9500501520328494829" }

Code Block
{ "

accountOrCardNumber

functionCode": "

9500501520328494829

B",
  "

currentBalance

accountNumber":

998176210159

"9500501520328494829",
  "

availableCreditLimit

blockCode1Local":

32237425576994724

"M",
  "

frozenBalance

localOrganization":

26000

950
}

2

0 OK: Solicitud exitosa.

4

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

5

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

SynchronizeMirrorAccount

Descripción	Request	Response

HTTP

GRPC Codes

Creación del cliente

Sincroniza el mirror de account con la información de Fiserv.

Code Block
{ "accountNumber": "9500501520328494829"

"logo

Code Block
{ "accountData":

"60",

{
    "

address

accountNumber": "

Ciruelas

9500501520328494829",
    "

houseNumber

customerNumber": "

12345

0995000000000035249",
    "

externalNumber

blockCode1": "

8007

M",
    "

colony

blockCode1Date": "

Lomas

2023-09-07",
    "

city

blockCode2":

"Lomas de Alvarez

 "M",
    "

state

blockCode2Date": "

COL

2023-08-11",
    "

postalCode

accountMakerDateOfBirth": "

99980

",
    "

dateOfBirth

availableCredit":

"2000-08-06"

0,
    "

stateOfBirth

userAmounts9":

"CDMX"

0,
    "

email

userAmounts10":

"lmedina@palo-it.com"

0,
    "

firstName

userAmounts7":

"Judith",

 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
{ "

lastName

accountNumber": "

Medina

9500501520328494829"

,

Code Block
{ "

maternalLastName

accountOrCardNumber": "

Ruiz

9500501520328494829",

mobilePhoneNumber

currentBalance":

"5521163588"

998176210159,

identificationNumber

availableCreditLimit":

"4152554487415113698"

32237425576994724,

ine

frozenBalance":

"1234117890099",

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
{ "

occupation

accountNumber": "

Tester

9500501520328494829"

,

Code Block
{ "

genderCode

accountOrCardNumber": "

1

9500501520328494829",

user4

currentBalance":

"1",

 998176210159,
  "

identificationNumberFlag

availableCreditLimit":

"2" } Code Block{

32237425576994724,

customerNumber

frozenBalance":

"0995000000000080589"

26000
}

2

0 OK: Solicitud exitosa.

4

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

5

13 Internal Server Error: Servicios no disponibles.

...

TransferBalance

Descripción	Request	Response

HTTP

GRPC Codes

Actualizar cliente

Realiza una transferencia .

Code Block
{ "transactionData": { "transactionAmount": 1, "

email

actionCode": "

lmedina@palo-it.com

8012",
    "

numberType

authorizationCode":

1

"311S3q",
    "

customerNumber

effectiveDate": "

0995000000000077863

2023-06-21",
    "

address

description": "

Ciruelas

P2P",
    "

dateOfBirth

paidConcept": "

1999-02-06

test",
    "

city

memoPostedIndicator":

"Villa de Alvarez

"qqq",
    "suppressMonetaryTransaction": "qqq",
    "

countryCode

n1n2ByPass": "

MEX

qqq",
    "

county

identifier": "

CDMX

S_IN",
    "

colony

box": "

ADOLFO LOPEZ MATEOS

3",
    "

externalNumber

crPlaza": "

1007

10MON",
    "

firstName

crStore": "

Sandra

50WHN",
    "

genderCode

keyTracking":

2

"KEYTRACKING0123456789",
    "

houseNumber

senderAccount": "

123

senderAccount012345",
    "

ine

beneficiaryAccount": "

1234117890099

beneficiaryAccount1",
    "

lastName

counterpartInstitution": "

Velasco

aaaaa",
    "

maritalStatus

operatingInstitution":

0

"bbbbb",
    "

maternalLastName

frcUprkBeneficiary": "

Medina

frcUprkBenefi",
    "

middleName

orderingFrcUprk": "

Rosa

orderingFrcUp",
    "

mobilePhoneIndicator

device":

1

"123456789-123456789-123456789-12",
    "

mobilePhoneNumber

ip": "

31211635899

198.162.200.200",
    "

occupation

latitude":

"NURSE"

-109.699,
    "

ownOrRentResidenceFlag

longitude":

0

23.062,
    "

postalCode

recipientName":

54070

"recipientName01234567890123456",
    "

stateOfBirth

orderingName": "

DF

orderingName012345678901234567",

} Code Block{

    "paymentSourceId": "

outputArea

paymentSourceId012345"

:

{

  "operationType": "W"
  },
  "

customerNumber

xTransactionId": "

0995000000000077863

123",
  "accountNumber":

"9500501545918394337"
}

Code Block
{ "

accountNumber

historyDate": "

0995000000000077863

2023-09-12",

"responseCode

"historyTime": "111208",
  "transactionData": {
    "

level

transactionCode": "8012",

transactionAmount

transactionDescription": "P2P

0

RECIEVER",

countryLimit

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
{ "

dailyLimitLoad

from":

0,

"accountNumber": "9500508496924050930",
    "

monthlyLimitLoad

actionCode":

0

"8008",

"dailyLimitCash

"transactionDescription":

0,

"P2P_TRANSFER_SOURCE",
    "

monthlyLimitCash

description":

0,

"P2P_TRANSFER_SOURCE",
    "

limitForDepositTransactions

authorizationCode":

0

"1234"

},

"accountLimit

"to": {

"accountDailyAmountLoad": 0, "accountMonthlyAmountLoad": 0,

"accountNumber": "9500502030236002994",
    "

accountDailyAmountCash

actionCode":

0

"8012",

"transactionDescription": "P2P_TRANSFER_TARGET",
    "

accountMonthlyAmountCash

description":

0

"P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  }

} }

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

Code Block{

,
    "

accountNumber

effectiveDate": "

9500505675946730065

2022-01-30",
    "

alternateCustomer

transactionAmount":

{

100,
    "

expirationDate": "2023-08-22" },

device": "abcfghjfghjklghjkfghjk5678956789",
    "

customerNumber

ip": "

0995000000000075954

198.162.123.148",
    "

qualification

latitude":

"2"

123.56565656,
    "

customerTypeIndicator

longitude":

0

-23.565656,
    "

foreignUseIndicator

xTransactionId":

0

"123"
}

Code Block
{

customerNumber

effectiveDate": "

0995000000000045697

2022-01-30",

accountNumber

transactionAmount": "

1650

100"

}

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

Add a new card to account

Code Block{ "addressLine1": "1", "addressLine2": "2", "assignedSpendingLimits": {

,
  "actionOutputArea": {
    "actionData": [
      {
        "authorizationCode": "1234",
        "accountNumber": "9500508496924050930",
        "transactionDescription": "P2P SENDER",
        "

maximumSpendingLimit

feeAmount":

3

"0",
        "

spendingFrequency

transactionCode":

4

8008,
        "

spendingTransaction

currentBalance":

5 },

 -5988391,
        "creditLimit": 0,

"atmCashAmount":

6,

atmCashNumber

openToBuy":

7

598649100,

"atmCashSingleTransactionLimit":

8,

authorizationCriteriaTableNumber

authorizationNumber": "

9

507925"

,

"authorizationSpendingLimitTable": "10",

},

"blockCode":

"11",

"branchNumber":

12,

"cardAction":

13,

cardActionReasonCode

authorizationCode": "

14

1234",

"cardDelayDays":

15,

panToken

accountNumber": "

16

9500502030236002994",

"cardSequence":

17,

cardholderAffiliationGroupId

transactionDescription": "

18

P2P RECIEVER",

"cardholderFlag

      "feeAmount": "

19

0",

"city": "20",

currentCardActivation

transactionCode":

"21"

8012,

"customerNumber": "22",

deliveryOption

currentBalance":

23,

-169434,
        "

deviceIndicator

creditLimit":

"24"

0,

"embossedName1":

"25",

embossedName2

openToBuy":

"26"

17133400,

"enrollmentStatusVBV":

"27",

expirationDate

authorizationNumber": "

28

332272"

,

"firstIssueBranch":

29,

"internetPurchaseAmount":

30,

"internetPurchaseNumber": 31,

"internetPurchaseSingleTransactionLimit": 32,

}
}

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
{ "

languageCode

transactionData":

"33",

 {
    "

maximumAuthorizationFrequency

transactionAmount":

34

20,
    "

name1

actionCode": "

35

8038",

"name1TypeIndicator":

36,

name2

authorizationCode": "

37

Q1er44",

"name2TypeIndicator": 38,

nextCardExpirationDate

effectiveDate": "

39

2022-08-24",
    "

numberOfCardsRequested

description":

40, "overTheCounterCashAmount": 42,

 "QR code test - normal hours",
    "

overTheCounterCashNumber

paidConcept":

43

"Hello",
    "

overTheCounterCashSingleTransactionLimit

memoPostedIndicator":

44

" ",
    "

pinMailerDelayDays

suppressMonetaryTransaction":

45,

pinOffset

Y"

: 46

"pinSuppression":

47,

plasticId

n1n2ByPass": "

48

N",
    "

posServiceCode

identifier": 0,

49,

accountNumber

box": "

50

1",
    "

postalCode

crPlaza":

51

"10MON",
    "

processType

crStore":

52

"50WHN",
    "

programId

keyTracking":

53

"Hello",
    "

reissueDeliveryOption

beneficiaryAccount":

54

"Hello",
    "

requestedCardType

senderAccount": "

55

Hello",
    "

retailPurchaseAmt

counterpartInstitution":

56

"Hello",
    "

retailPurchaseNumber

operatingInstitution":

57

"Hello",
    "

retailPurchaseSingleTransactionLimit

frcUprkBeneficiary":

58

"Hello",

"securedCodeActivate":

59,

stateOrProvince

orderingFrcUprk": "

60

Hello",
    "

typeCardMailer

device": "

61

123456789-123456789-123456789-12",
    "

typeOfCard

ip": "

62

198.162.200.200",
    "

user1

latitude":

63

-109.699,
    "

user2

longitude":

64,

 23.062,
    "

user3

recipientName":

65

"Hello",
    "

user4

orderingName":

66

"Hello",
    "

user5

paymentSourceId":

67

"bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "

user6

xTransactionId":

68

"123",
  "

user7

accountNumber":

69,

 "9500508020127353147"
}

Code Block
{ "

user8

historyDate":

70

"2023-09-12",
  "

userDate1

historyTime": "

71

111311",
  "

userDate2

transactionData":

"72",

 {
    "

vbvPassword

transactionCode": "

73

8038",
    "

visaMiniIndicator

transactionDescription": "

74

CASHOUT WITH QR-CODE(FREE BAL)",
    "

visaPlusIndicator

currentBalance": "

75

-1382946",

} Code Block{

panToken

openToBuy":

"0004217470595215803",

 "1382326"
  }
}

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.

...

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

...

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

test",

}

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

memoPostedIndicator": "

9500501520328494829

qqq"

} Code Block{ "accountOrCardNumber

,
    "suppressMonetaryTransaction": "

9500501520328494829

qqq",

currentBalance

n1n2ByPass":

998176209259

"qqq",

"availableCreditLimit

    "identifier":

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": {

"S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "

transactionAmount

frcUprkBeneficiary":

1

"frcUprkBenefi",
    "

actionCode

orderingFrcUprk": "

8012

orderingFrcUp",
    "

authorizationCode

device": "

311S3q

123456789-123456789-123456789-12",
    "

effectiveDate

ip": "198.162.200.200",
    "latitude"

2023-06-21"

: -109.699,
    "longitude": 23.062,
    "

description

recipientName": "

P2P

recipientName01234567890123456",
    "

paidConcept

orderingName": "

test

orderingName012345678901234567",
    "paymentSourceId": "

memoPostedIndicator

paymentSourceId012345"
  },
  "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",
    "

operationType

ip": "

W" }

Code Block

{
	"historyDate": "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":

"1234" },

8008,
        "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", "actionOutputArea": { "actionData": [ { "authorizationCode

0,
        "openToBuy": 17133400,
        "authorizationNumber": "

1234", "accountNumber": "9500508496924050930", "transactionDescription": "P2P SENDER", "transactionCode": 8008, "currentBalance": -5988391.0, "openToBuy": 5.987391E8, "authorizationNumber": "205229" }, {

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

    "description": "

P2P RECIEVER

QR code test - normal hours",

"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.

PUT → /v1/balances/transfers-qr

Descripción

Request

Response

HTTP Codes

Realiza una transferencia QR.

Code Block{ "transactionData": {


    "paidConcept": "Hello",
    "memoPostedIndicator": " ",
    "suppressMonetaryTransaction": "Y",
    "n1n2ByPass": "N",
    "

transactionAmount

identifier":

20

0,
    "

actionCode

box": "

8038

1",
    "

authorizationCode

crPlaza": "

Q1er44

10MON",
    "

effectiveDate

crStore": "

2022-08-24

50WHN",
    "

description

keyTracking": "

QR code test - normal hours

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-123456789

09-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" }, "xTransactionId": "123", "

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": "

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" } }200500

32237425576994724,
  "frozenBalance": 26000
}

0 OK: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

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

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": "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

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.

...

UpdateCustomer

Descripción	Request	Response

HTTP

GRPC Codes

Actualización de los datos del cliente en el proveedor de clientes.

Actualizar cliente

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":

"Sandra

 0,
    "maternalLastName": "Medina",
    "middleName": "Rosa",
    "mobilePhoneIndicator": 1,
    "mobilePhoneNumber": "31211635899",
    "

genderCode

occupation":

2

"NURSE",
    "

houseNumber

ownOrRentResidenceFlag":

"123"

0,
    "

ine

postalCode":

"1234117890099"

54070,
    "

lastName

stateOfBirth": "

Velasco",

DF"
}

Code Block
{ "

maritalStatus

outputArea": {

0,

maternalLastName

customerNumber": "

Medina

0995000000000077863",
        "

middleName

accountNumber": "

Rosa

0995000000000077863",

"mobilePhoneIndicator": 1,

mobilePhoneNumber

responseCode": "

31211635899

",
        "

occupation

level": "

NURSE

",
        "

ownOrRentResidenceFlag

transactionAmount": 0,
        "

postalCode

countryLimit": {

54070,

"stateOfBirth":

"DF"

} Code Block{

outputArea

dailyLimitLoad":

{

0,
            "

customerNumber

monthlyLimitLoad":

"0995000000000077863"

0,
            "

accountNumber

dailyLimitCash":

"0995000000000077863",

 0,
            "

responseCode

monthlyLimitCash":

"",

0,
            "

level

limitForDepositTransactions":

"",

"transactionAmount": 0

},
        "

countryLimit

accountLimit": {
            "

dailyLimitLoad

accountDailyAmountLoad": 0,
            "

monthlyLimitLoad

accountMonthlyAmountLoad": 0,
            "

dailyLimitCash

accountDailyAmountCash": 0,
            "

monthlyLimitCash

accountMonthlyAmountCash": 0

,

"limitForDepositTransactions": 0 },

}
}

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
{ "accountNumber": "9500505675946730065", "alternateCustomer": { "expirationDate": "

accountLimit

2023-08-22"

:

{

  },
  "customerNumber": "0995000000000075954",
  "qualification": "2",
  "

accountDailyAmountLoad

customerTypeIndicator": 0,
  "foreignUseIndicator": 0
}

Code Block
{

accountMonthlyAmountLoad

customerNumber":

0

"0995000000000045697",
    "accountNumber":

"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
{ "

accountDailyAmountCash

cardNumber":

0,

"0004217470072001676"
}

Code Block
{

accountMonthlyAmountCash

accountNumber":

0 } }

"0004217470072001676"
}

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 del cliente en la cuenta de Spin.

Code Block{ "accountNumber": "0004217470138987703", "customerNumber": "0995000000000045698", "qualification": "1", "customerTypeIndicator": 0,

Desvincular una tarjeta de un número de cuenta

Code Block
{ "

foreignUseIndicator

customerOrAccountNumber":

0

"9500507060523627372",

alternateCustomer

cardNumber":

{

"0004217470969640887",

"expirationDate

"cardholderType":

"2023/12/30" }

1
}

Code Block
{ "

customerNumber

cardNumber": "

0995000000000045697

***************4568",
    "

accountNumber

customerOrAccountNumber": "

1650

9500507060523627372"
}

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 → /v1/cards/embosser/details

Descripción

Request

Response

HTTP Codes

Vinculación de tarjetas a cuenta

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.

PUT /account/prepaid

Obtener cuenta mediante Pantoken Inactivo

Code Block

{
  "

customerOrAccountNumber

panToken": "

1234567890123456800

0004217470595215803",
  "

cardNumber

cardSequence":

"000123456ID5IXX1234"

1,
  "

cardholderType

foreignUse": 1
}

Code Block
{ "

customerOrAccountNumber

postToAccount": "

1234567890123456800

9500507060523627372",
    "

cardNumber

blockCode": "

000123456ID5IXX1234

Z",

}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

GET /cards/account

Descripción

Request

Response

HTTP Codes

Vinculación de tarjetas a cuenta

Code Block{

accountNumber

cardNumber": "

4444888833330009999

***************0252",
    "

cardNumber

currentCardActivation": "

000123456ID5IXX1234

N",

"isPrimaryCard": false } Code Block{

Descripción

Request

Response

HTTP Codes

Activación de tarjetas

"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/activation

Obtener cuenta mediante Pantoken Expirado

Code Block
{ "panToken": "0004217470200073271", "cardSequence": 1, "foreignUse": 1 }

Code Block
{ "

organizationNumber

postToAccount":

999

"9500507060523627372",
    "cardNumber": "

000123456ID5IXX1234

***************8578",
    "

serviceType

currentCardActivation": "

A

N"

, "userData": "string" }

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
{ "

organizationNumber

blockCode":

999,

logo

Z"

: 1

,
  "

cardNumber

panToken": "

000123456ID5IXX1234

0004217470885923553",
  "

serviceType

cardSequence":

"A"

1,
  "

numberCardsActivated

functionCode":

1,

foreignOrg": 1, "numberForeignCardsActivated": 0 }

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 /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.

...

Page Comparison

Versions Compared

Old Version 32

New Version Current

Key

Ejemplo body:

Mirror

Account

GetAccountDetails

Aggregation

Account Aggregation Service

POST → /v1/accounts/details

SetAccountBlock

SynchronizeMirrorAccount

Balance

POST → /v1/accounts/blocks

SynchronizeMirrorBalance

TransferBalance

POST → /v1/accounts/syncs

TransferPeerToPeer

POST → /v1/balances

POST → /v1/balances/syncs

PUT → /v1/balances/transfers

Card

POST → /v1/cards/embossers/details

PUT → /v1/cards/embossers/block

Gateway

Account Adapter

GetAccountDetails

SetAccountBlock

TransferBalance

TransferPeerToPeer

PUT → /v1/balances/transfers-p2p

PUT → /v1/balances/transfers-qr

Customer Aggregation service

POST → /customers

PUT → /customers

POST → /customers/account

Card Aggregation service

​POST /cards/embosser/details

PUT /cards/account

POST /cards/account

PUT /cards/activation​ [Equipo de Spin]

PUT /cards/embosser/block

Mirror

Account

GetAccountDetails

SetAccountBlock

Customer Adapter

CreateCustomer

SynchronizeMirrorAccount

Balance

GetAccountBalance

SynchronizeMirrorBalance

TransferBalance

TransferPeerToPeer

LinkAccountToCustomer

Card Gateway

POST → /v1/cards/embosser

FrozenBalanceTransfer

Card

POST → /v1/cards/

embossers/details

PUT → /v1/cards/

embossers/block

Aggregation

Account Aggregation Service

Gateway

Account Adapter

GetAccountDetails

SetAccountBlock

TransferBalance

POST → /v1/balances

POST → /v1/balances/syncs

PUT → /v1/balances/transfers

TransferPeerToPeer

PUT → /v1/balances/transfers-p2p

FrozenBalanceTransfer

PUT → /v1/balances/transfers-qr

GetAccountBalance

POST /cards/embosser/details

PUT /cards/activation [Equipo de Spin]

PUT /cards/activation