...

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

...

Aggregation

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

Account Aggregation Service

Info

Incorpora los servicios de Account Mirror y Balance Mirror

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

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

POST → /v1/accounts/details

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza la consulta de bloqueos de cuenta Activa

Code Block
{ "accountNumber": "9500507060523627372" }

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza la consulta de bloqueos de cuenta

.

Inactiva

Code Block
{ "accountNumber": "

9500501520328494829

9500501403742215502"
}

Code Block
{ "accountData": { "accountNumber": "

9500501520328494829

9500501403742215502",
        "customerNumber": "

0995000000000035249

0995000000000080639",
        "blockCode1": "

M

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

07

12",

"blockCode2": "M",

blockCode2Date

blockCode2": "

2023-08-11

X",

"accountMakerDateOfBirth":

"",

availableCredit

blockCode2Date":

0, "userAmounts9": 0,

"2023-09-13"

"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

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"

,

Code Block
{

"blockCodeIndicator":

1,

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.

5 Internal Server Error

Descripción

Request

Response

HTTP Codes

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

401: Apy Key no válida.

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

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

GetAccountBalance

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" } Code Block{

M",
  "

accountOrCardNumber

blockCodeIndicator":

"9500501520328494829"

0,
  "

currentBalance

foreignUse":

998176210159

0,
  "

availableCreditLimit

functionCode":

32237425576994724

"B",
  "

frozenBalance

accountNumber":

26000

"9500501520328494829"
}

2 OK: Solicitud exitosa.

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

5 Internal Server Error: Servicios no disponibles.

SynchronizeMirrorBalance

Descripción

Request

Response

HTTP Codes

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

Code Block
{ "

accountNumber

functionCode": "

9500501520328494829

B",

} Code Block{

accountOrCardNumber

accountNumber": "9500501520328494829",
    "

currentBalance

blockCode1Local":

998176210159

"M",

"availableCreditLimit":

32237425576994724,

frozenBalance

localOrganization":

26000

950
}

2 OK

200: Solicitud exitosa.

4 Bad Request

400: Request con campos no válidos.

5 Internal Server Error: Servicios no

Descripción

Request

Response

HTTP Codes

Realiza una transferencia .

401: Apy Key no válida.

500: Servicios no disponibles.

TransferBalance

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza bloqueos/desbloqueo de cuenta - Bloquear (foreignUse= 1)

Code Block
{ "

transactionData

blockCode":

{ "transactionAmount": 1

"U",

actionCode

blockCodeIndicator":

"8012"

0,

authorizationCode

foreignUse":

"311S3q"

1,

effectiveDate

functionCode": "

2023-06-21

B",

description

accountNumber": "

P2P",

9500501520328494829"
}

Code Block
{ "

paidConcept

functionCode": "

test

B",
    "

memoPostedIndicator

accountNumber": "

qqq

9500501520328494829",
    "

suppressMonetaryTransaction

localOrganization":

"qqq",

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

n1n2ByPass

blockCode": "

qqq

",

identifier

blockCodeIndicator":

"S_IN",

2,
  "

box

foreignUse":

"3"

0,

crPlaza

functionCode": "

10MON

U",

crStore

accountNumber": "

50WHN",

9500501520328494829"
}

Code Block
{ "

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

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

9500501545918394337

9500503048928881284"

} Code Block{

,
        "

historyDate

customerNumber": "

2023-09-12

0995000000000076294",

"historyTime

      "accountMakerDateOfBirth": "

111208

1994-05-06",

"transactionData":

{

transactionCode

availableCredit":

"8012"

10000.0,

"transactionDescription": "P2P RECIEVER",

currentBalance

userAmounts9":

"

2122495"

50000.0,
        "

openToBuy

userAmounts10":

"2122548"

-40000.0
    }
}

2

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

blockCode1": "

P2P_TRANSFER_SOURCE

U",
        "

authorizationCode

blockCode1Date": "

1234" }

2023-09-12",

"to":

{

accountNumber

blockCode2": "

9500502030236002994

X",
        "

actionCode

blockCode2Date": "

8012

2023-09-13",
        "

transactionDescription

accountMakerDateOfBirth": "

P2P_TRANSFER_TARGET",

1994-05-06"
    }

"description

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

P2P_TRANSFER_SOURCE",

9500508152383529456"
}

Code Block
{ "

authorizationCode

accountData":

"1234"

},

effectiveDate

accountNumber": "

2022-01-30

9500508152383529456",

"transactionAmount":

100,

device

customerNumber": "

abcfghjfghjklghjkfghjk5678956789

0995000000000040667",
        "

ip

accountMakerDateOfBirth": "

198.162.123.148

2000-01-01",

"latitude":

123.56565656,

longitude

availableCredit":

-23

10000.

565656

0,

"xTransactionId":

"123"

} Code Block{

effectiveDate

userAmounts9":

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

-170000.0,

"actionOutputArea":

{

actionData

userAmounts10":

[

-130000.0,

{

  "userAmounts7": -10000.0

"authorizationCode

}
}

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

1234

9500508176491773011"

,

Code Block
{

accountNumber

accountData":

"9500508496924050930",

{
        "

transactionDescription

accountNumber": "

P2P SENDER

9500508176491773011",
        "

feeAmount

customerNumber": "

0

0995000000000080637",
        "

transactionCode

blockCode1":

8008,

"currentBalance": -5988391

"Z",
        "

creditLimit

blockCode1Date":

0, "openToBuy": 598649100

"2023-09-12",
        "

authorizationNumber

blockCode2Date": "

507925" }

2023-09-18",

{

"authorizationCode

"accountMakerDateOfBirth": "

1234

1994-05-06"

,

"accountNumber": "9500502030236002994", "transactionDescription": "P2P RECIEVER", "feeAmount": "0", "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.

13 Internal Server Error: Servicios no disponibles.

POST → /v1/balances

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza la consulta de balance de cuenta.

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block
{ "accountOrCardNumber": "9500501520328494829", "currentBalance": 998176209259, "availableCreditLimit": 1823760996, "frozenBalance": 26000.0 }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

5

13 Internal Server Error: Servicios no disponibles.

FrozenBalanceTransfer

POST → /v1/balances/syncs

Descripción	Request	Response	HTTP Codes

Realiza una transferencia QR.

GRPC Codes

Sincroniza el mirror de balance con la información de Fiserv - Número de cuenta Activa

Code Block
{ "

transactionData

accountNumber":

{

transactionAmount

9500501520328494829"

: 20,

Code Block
{ "

actionCode

accountOrCardNumber": "

8038

9500503048928881284",
    "

authorizationCode

currentBalance":

"Q1er44"

-10000.0,
    "

effectiveDate

availableCreditLimit":

"2022-08-24", "description": "QR code test - normal hours", "paidConcept": "Hello", "memoPostedIndicator": " ", "suppressMonetaryTransaction": "Y", "n1n2ByPass": "N", "identifier": 0, "box": "1",

10000.0
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Sincroniza el mirror de balance con la información de Fiserv - Número de cuenta Inactiva

Code Block
{ "accountNumber": "9500501403742215502" }

Code Block
{ "accountOrCardNumber": "9500501403742215502" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Sincroniza el mirror de balance con la información de Fiserv - Número de cuenta Expirada

Code Block
{ "accountNumber": "9500508152383529456" }

Code Block
{ "

crPlaza

accountOrCardNumber": "

10MON

9500508152383529456",
    "

crStore

currentBalance":

"50WHN"

-10000.0,
    "

keyTracking

availableCreditLimit":

"Hello", "beneficiaryAccount": "Hello", "senderAccount": "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 Bloqueada

Code Block
{ "accountNumber": "9500508176491773011" }

Code Block
{ "

counterpartInstitution

accountOrCardNumber": "

Hello

9500508176491773011"

, "operatingInstitution": "Hello", "frcUprkBeneficiary": "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": { "transactionAmount": 1000, "

orderingFrcUprk

actionCode": "

Hello

8000",
    "

device

authorizationCode": "

123456789-123456789-123456789-12

311S3q",
    "

ip

effectiveDate": "

198.162.200.200

2023-06-21",
    "

latitude

description":

-109.699

"P2P",
    "

longitude

paidConcept":

23.062

"test",
    "

recipientName

memoPostedIndicator": "

Hello

qqq",
    "

orderingName

suppressMonetaryTransaction": "

Hello

qqq",
    "

paymentSourceId

n1n2ByPass": "

bf0469d7-b507-44d6-af7d-d4edea6340f1"

qqq",

},

xTransactionId

identifier": "

123

S_IN",
    "

accountNumber

box": "

9500508020127353147

3",

} Code Block{

historyDate

crPlaza": "

2023-09-12

10MON",
    "

historyTime

crStore": "

111311

50WHN",
    "

transactionData

keyTracking":

{

"KEYTRACKING0123456789",
    "

transactionCode

senderAccount": "

8038

senderAccount012345",
    "

transactionDescription

beneficiaryAccount": "

CASHOUT WITH QR-CODE(FREE BAL)

beneficiaryAccount1",
    "

currentBalance

counterpartInstitution": "

-1382946

aaaaa",
    "

openToBuy

operatingInstitution": "

1382326

bbbbb",

}

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

 "frcUprkBeneficiary": "

0004217470595215803

frcUprkBenefi",
    "

cardSequence

orderingFrcUprk":

2147483647

"orderingFrcUp",
    "

foreignUse

device":

0

} Code Block{ "postToAccount

"123456789-123456789-123456789-12",
    "ip": "

9500508261544464147

198.162.200.200",

blockCode

latitude": -109.699,
    "

Z

longitude": 23.062,

cardNumber

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

Code Block{ "blockCode": "Z

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

Code Block
{ "historyDate": "2023-09-18", "

panToken

historyTime": "

0004217470885923553

164440",
    "

cardSequence

transactionData":

1,

 {
        "

functionCode

transactionCode": "

B

8000",

//B

para

bloquear

-

u

Desbloquear } Code Block{

Descripción

Request

Response

HTTP Codes

Realiza la consulta de bloqueos de cuenta.

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

"10MON",

} }

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": "", "blockCodeIndicator": 1, "foreignUse": 0, "functionCode": "U", "accountNumber": "9500501520328494829" }

Code Block
{ "functionCode": "B", "accountNumber": "9500501520328494829", "blockCode1Local": "M", "localOrganization": 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": { "transactionAmount": 1

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

actionCode

orderingName": "

8012

orderingName012345678901234567",
    "

authorizationCode

paymentSourceId": "

311S3q

paymentSourceId012345"

,


  },
  "

effectiveDate

xTransactionId": "

2023-06-21

123",

description

accountNumber": "

P2P

9500501403742215502",

paidConcept

operationType": "

test",

D"
 }

Code Block
{ "

memoPostedIndicator

historyDate": "

qqq

2023-09-18",
    "

suppressMonetaryTransaction

historyTime": "

qqq

164651",
    "

n1n2ByPass

transactionData":

"qqq",

{
        "

identifier

transactionCode": "

S_IN

8000",
        "

box

openToBuy": "

3

2000"

,

"crPlaza": "10MON",

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

crStore

transactionAmount":

"50WHN"

1000,
    "

keyTracking

actionCode": "

KEYTRACKING0123456789

8000",
    "

senderAccount

authorizationCode": "

senderAccount012345

311S3q",
    "

beneficiaryAccount

effectiveDate": "

beneficiaryAccount1

2023-06-21",
    "

counterpartInstitution

description": "

aaaaa

P2P",
    "

operatingInstitution

paidConcept": "

bbbbb

test",
    "

frcUprkBeneficiary

memoPostedIndicator": "

frcUprkBenefi

qqq",
    "

orderingFrcUprk

suppressMonetaryTransaction": "

orderingFrcUp

qqq",
    "

device

n1n2ByPass": "

123456789-123456789-123456789-12

qqq",
    "

ip

identifier": "

198.162.200.200

S_IN",
    "

latitude

box":

-109.699

"3",
    "

longitude

crPlaza":

23.062

"10MON",
    "

recipientName

crStore": "

recipientName01234567890123456

50WHN",
    "

orderingName

keyTracking": "

orderingName012345678901234567

KEYTRACKING0123456789",
    "

paymentSourceId

senderAccount": "

paymentSourceId012345

senderAccount012345",

},

xTransactionId

beneficiaryAccount": "

123

beneficiaryAccount1",
    "

accountNumber

counterpartInstitution": "

9500501545918394337

aaaaa",

} Code Block{

historyDate

operatingInstitution": "

2023-09-12

bbbbb",
    "

historyTime

frcUprkBeneficiary": "

111208

frcUprkBenefi",
    "

transactionData

orderingFrcUprk":

{

"orderingFrcUp",
    "

transactionCode

device": "

8012

123456789-123456789-123456789-12",
    "

transactionDescription

ip": "

P2P RECIEVER

198.162.200.200",
    "

currentBalance

latitude":

"

2122495"

109.699,
    "

openToBuy

longitude":

"2122548"

23.062,

}

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

recipientName":

{

"recipientName01234567890123456",
    "

accountNumber

orderingName": "

9500508496924050930

orderingName012345678901234567",
    "

actionCode

paymentSourceId": "

8008

paymentSourceId012345"

,


  },
  "

transactionDescription

xTransactionId": "

P2P_TRANSFER_SOURCE

123",

description

accountNumber": "

P2P_TRANSFER_SOURCE

9500508152383529456",

authorizationCode

operationType": "

1234

D"

, "to":

Code Block
{ "

accountNumber

historyDate": "

9500502030236002994

2023-09-18",
    "

actionCode

historyTime": "

8012

164734",
    "

transactionDescription

transactionData":

"P2P_TRANSFER_TARGET",

"description":

"P2P_TRANSFER_SOURCE",

authorizationCode

transactionCode": "

1234

8000",

},

effectiveDate

currentBalance": "

2022

01-30

10000",

"transactionAmount":

100,

device

openToBuy": "

abcfghjfghjklghjkfghjk5678956789

12000"

,

"ip": "198.162.123.148",

}
}

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

latitude

transactionAmount":

123.56565656

1000,
    "

longitude

actionCode":

-23.565656

"8000",
    "

xTransactionId

authorizationCode": "

123

311S3q",

} Code Block{

   "effectiveDate": "

2022

2023-

01

06-

30

21",
    "

transactionAmount

description": "

100

P2P",
    "

actionOutputArea

paidConcept":

{

"test",
    "

actionData

memoPostedIndicator":

[

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

{

   "n1n2ByPass": "qqq",
    "

authorizationCode

identifier": "

1234

S_IN",
    "box": "3",
    "

accountNumber

crPlaza": "

9500508496924050930

10MON",

transactionDescription

crStore": "

P2P SENDER

50WHN",

feeAmount

keyTracking": "

0

KEYTRACKING0123456789",

transactionCode

senderAccount":

8008

"senderAccount012345",

currentBalance

beneficiaryAccount":

-5988391,

"beneficiaryAccount1",
    "

creditLimit

counterpartInstitution":

0

"aaaaa",

openToBuy

operatingInstitution":

598649100,

"bbbbb",
    "

authorizationNumber

frcUprkBeneficiary": "

507925

frcUprkBenefi",

}

"orderingFrcUprk": "orderingFrcUp",
    "device":

{

"123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "

authorizationCode

latitude":

"1234",

-109.699,
    "longitude": 23.062,
    "

accountNumber

recipientName": "

9500502030236002994

recipientName01234567890123456",

transactionDescription

orderingName": "

P2P RECIEVER

orderingName012345678901234567",

feeAmount

paymentSourceId": "

0

paymentSourceId012345"

,

},
  "

transactionCode

xTransactionId":

8012

"123",

"accountNumber": "9500508176491773011", 
  "

currentBalance

operationType":

-169434,

"D"

Code Block
{

creditLimit

historyDate":

0

"2023-09-18",
    "historyTime": "164818",
    "

openToBuy

transactionData":

17133400,

{
        "

authorizationNumber

transactionCode": "

332272

8000",

}

  "openToBuy": "2000"

]

}
}

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.

...

PUT → /v1/balances/transfers-p2p

Descripción	Request	Response	HTTP Codes	GRPC Codes
Realiza una transferencia

QR

P2P.

Code Block
{ "

transactionData

from": {
    "

transactionAmount

accountNumber":

20

"9500508496924050930",
    "actionCode": "

8038

8008",
    "

authorizationCode

transactionDescription": "

Q1er44

P2P_TRANSFER_SOURCE",
    "

effectiveDate

description": "

2022-08-24

P2P_TRANSFER_SOURCE",
    "

description

authorizationCode": "1234"

QR

code

test - normal hours",

 },
  "

paidConcept

to":

"Hello",

{
    "

memoPostedIndicator

accountNumber": "

9500502030236002994",
    "

suppressMonetaryTransaction

actionCode": "

Y

8012",
    "

n1n2ByPass

transactionDescription": "

N

P2P_TRANSFER_TARGET",
    "

identifier

description":

0

"P2P_TRANSFER_SOURCE",
    "

box

authorizationCode": "

1

1234"

,

"crPlaza": "10MON"

},
    "

crStore

effectiveDate": "

50WHN

2022-01-30",
    "

keyTracking

transactionAmount":

"Hello"

100,
    "

beneficiaryAccount

device": "

Hello

abcfghjfghjklghjkfghjk5678956789",
    "

senderAccount

ip": "

Hello

198.162.123.148",
    "

counterpartInstitution

latitude":

"Hello"

123.56565656,
    "

operatingInstitution

longitude":

"Hello"

-23.565656,
    "

frcUprkBeneficiary

xTransactionId": "

Hello

123"

,

"orderingFrcUprk

Code Block
{ "effectiveDate": "

Hello

2022-01-30",

"device

	"transactionAmount": "

123456789-123456789-123456789-12

100",

"ip

	"actionOutputArea":

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

2 OK: Solicitud exitosa.

4

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

la consulta de balance de cuenta

una transferencia QR.

Code Block
{ "

accountNumber

transactionData": {
    "

9500501520328494829

transactionAmount"

} Code Block{

: 20,
    "

accountOrCardNumber

actionCode": "

9500501520328494829

8038",
    "

currentBalance

authorizationCode":

998176210159

"Q1er44",
    "

availableCreditLimit

effectiveDate":

32237425576994724

"2022-08-24",
    "

frozenBalance

description":

26000 }

2 OK: Solicitud exitosa.

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

5 Internal Server Error: Servicios no disponibles.

Customer Adapter

Info

Permite tener la comunicación entre Spin y Fiserv para los módulos de customer.

Este componente se desarrolló para desacoplar los procesos core de Spin y el proveedor financiero para lograr una mayor escalabilidad.

CreateCustomer

Descripción

Request

Response

HTTP Codes

Creación del cliente

Code Block{

 "QR code test - normal hours",
    "paidConcept": "Hello",
    "memoPostedIndicator": " ",
    "suppressMonetaryTransaction": "Y",
    "

logo

n1n2ByPass": "

50

N",
    "

address

identifier":

"Ciruelo"

0,
    "

houseNumber

box": "

123

1",
    "

externalNumber

crPlaza": "

1007

10MON",
    "

colony

crStore": "

Residencial

50WHN",
    "

city

keyTracking": "

Villa de Alvarez

Hello",
    "

state

beneficiaryAccount": "

COL

Hello",
    "

postalCode

senderAccount": "

28980

Hello",
    "

dateOfBirth

counterpartInstitution": "

1994-05-06

Hello",
    "

stateOfBirth

operatingInstitution": "

Colima

Hello",
    "

email

frcUprkBeneficiary": "

lmedina@palo-it.com

Hello",
    "

firstName

orderingFrcUprk": "

Judith

Hello",
    "

lastName

device": "

Medina

123456789-123456789-123456789-12",
    "

maternalLastName

ip": "

Ruiz

198.162.200.200",
    "

mobilePhoneNumber

latitude":

"3121163582"

-109.699,
    "

identificationNumber

longitude":

"4152556987415113698"

23.062,
    "

ine

recipientName": "

1234117890099

Hello",
    "

occupation

orderingName": "

Tester

Hello",
    "

genderCode

paymentSourceId": "

1",

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

user4

xTransactionId": "

1

123",

identificationNumberFlag

accountNumber": "

2

Descripción

Request

Response

HTTP Codes

Actualizar cliente

Code Block{ "email": "lmedina@palo-it.com", "numberType": 1, "customerNumber": "0995000000000077863", "address": "Ciruelo", "dateOfBirth": "1994-05-06", "city": "Villa de Alvarez", "countryCode": "MEX", "county": "Colima", "colony": "ADOLFO LOPEZ MATEOS", "externalNumber": "1007", "firstName": "Victoria", "genderCode": 2, "houseNumber": "123

9500508020127353147"
}

2 OK: Solicitud exitosa.

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

5 Internal Server Error: Servicios no disponibles.

UpdateCustomer

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

ine

address": "

1234117890099

Ciruelas",
    "

lastName

houseNumber": "

Velasco

12345",
    "

maritalStatus

externalNumber":

0

"8007",
    "

maternalLastName

colony": "

Medina

Lomas",
    "

middleName

city": "

Valeria

Lomas de Alvarez",
    "

mobilePhoneIndicator

state":

1

"COL",
    "

mobilePhoneNumber

postalCode": "

31211635821

99980",
    "

occupation

dateOfBirth": "

NURSE

2000-08-06",
    "

ownOrRentResidenceFlag

stateOfBirth":

0

"CDMX",
    "

postalCode

email":

54070

"lmedina@palo-it.com",
    "

stateOfBirth

firstName": "

DF

Judith"

}

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

lastName": "

9500505675946730065

Medina",
    "

alternateCustomer

maternalLastName": "Ruiz",

{

expirationDate

mobilePhoneNumber": "

2023-08-22"

5521163588",

},

customerNumber

identificationNumber": "

0995000000000075954

4152554487415113698",

"qualification

  "ine": "1234117890099",
    "occupation": "

2

Tester",
    "

customerTypeIndicator

genderCode":

0,

"1",
    "user4":"1",

"foreignUseIndicator

 "identificationNumberFlag": "2"
}

Code Block
{ "customerNumber":

0 }2

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

4

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

5

13 Internal Server Error: Servicios no disponibles.

Card Gateway

Info
Permite tener la comunicación entre Spin y Fiserv para los módulos de card.

POST → /v1/cards/embosser

...

Descripción

...

Request

...

Response

...

HTTP Codes

POST → /v1/cards/embosser/details

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

Obtener cuenta mediante Pantoken

...

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

cardSequence

numberType":

2147483647

1,

"foreignUse":

0

} Code Block{

postToAccount

customerNumber": "

9500508261544464147

0995000000000077863",

blockCode

address": "

Z

Ciruelas",

"cardNumber

    "dateOfBirth": "

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

1999-02-06",
    "city": "

N

Villa de Alvarez",

"dateBlock

    "countryCode": "

2023-09-04

MEX"

}

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

county": "

Z

CDMX",
    "

panToken

colony": "

0004217470885923553

ADOLFO LOPEZ MATEOS",
    "

cardSequence

externalNumber":

1

"1007",
    "

functionCode

firstName": "

B

Sandra"

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

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

POST → /v1/balances

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

Realiza la consulta de balance de cuenta

Vinculación del cliente en la cuenta de Spin.

Code Block
{ "accountNumber": "

9500501520328494829

0004217470138987703",

} Code Block{ "accountOrCardNumber

   "customerNumber": "

9500501520328494829

0995000000000045698",

currentBalance

qualification":

998176209259, "availableCreditLimit

"1",
    "customerTypeIndicator":

1823760996

0,

"frozenBalance

    "foreignUseIndicator":

26000.

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

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

Obtener cuenta mediante Pantoken

Code Block
{ "panToken": "0004217470595215803", "

accountNumber

cardSequence": 2147483647,
  "

9500501520328494829

foreignUse": 0
}

Code Block
{ "

accountOrCardNumber

postToAccount": "

9500501520328494829

9500508261544464147",
	"

currentBalance

blockCode":

998176209259

"Z",
	"

availableCreditLimit

cardNumber":

1823760996

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

"frozenBalance

"currentCardActivation": "N",
	"dateBlock":

26000.0

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

Vinculación de tarjetas a cuenta

Code Block
{ "

transactionData

customerOrAccountNumber":

{ "transactionAmount": 1

"1234567890123456800",

actionCode

cardNumber": "

8012

000123456ID5IXX1234",

authorizationCode

cardholderType":

"311S3q",

1
}

Code Block
{ "

effectiveDate

customerOrAccountNumber": "

2023-06-21

1234567890123456800",

description

cardNumber": "

P2P

000123456ID5IXX1234",

"paidConcept": "test", "memoPostedIndicator": "qqq", "suppressMonetaryTransaction": "qqq", "n1n2ByPass": "qqq",

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

identifier

accountNumber": "

S_IN

0004217470041850252"

, "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-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": { "accountNumber": "9500508496924050930

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

actionCode

accountMakerDateOfBirth": "

8008

",
    "

transactionDescription

availableCredit":

"P2P_TRANSFER_SOURCE"

0,
    "

description

userAmounts9":

"P2P_TRANSFER_SOURCE"

0,
    "

authorizationCode

userAmounts10":

"1234"

0,

},

to

userAmounts7":

{

0
  }

"accountNumber

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

9500502030236002994

",

actionCode

blockCodeIndicator":

"8012"

1,

transactionDescription

foreignUse":

"P2P_TRANSFER_TARGET"

0,

description

functionCode": "

P2P_TRANSFER_SOURCE

U",

authorizationCode

accountNumber": "

1234

9500501520328494829"

},

Code Block
{

effectiveDate

functionCode": "

2022-01-30

B",

transactionAmount

accountNumber":

100

"9500501520328494829",

device

blockCode1Local": "

abcfghjfghjklghjkfghjk5678956789

M",

ip

localOrganization":

"198.162.123.148", "latitude": 123.56565656, "longitude": -23.565656,

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

xTransactionId

accountNumber": "

123

9500501520328494829"

} Code Block{ "effectiveDate

,
    "customerNumber": "

2022-01-30

0995000000000035249",

"transactionAmount

    "blockCode1": "

100

M",

"actionOutputArea

    "blockCode1Date":

{ "actionData": [ { "authorizationCode

"2023-09-07",
    "blockCode2": "

1234

M",

"accountNumber

    "blockCode2Date": "

9500508496924050930

2023-08-11",

"transactionDescription


    "accountMakerDateOfBirth": "

P2P SENDER

",

"transactionCode

    "availableCredit":

8008

0,

"currentBalance


    "userAmounts9":

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

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

...

Balance

Info

Consulta de balance

Repositorio sincronizado con Fiserv

Disminuye peticiones al Proveedor

GetAccountBalance

Descripción	Request	Response

HTTP

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"

998176210159,

authorizationCode

availableCreditLimit":

"Q1er44"

32237425576994724,

effectiveDate

frozenBalance":

"2022-08-24", "description": "QR code test - normal hours", "paidConcept": "Hello", "memoPostedIndicator": " ", "suppressMonetaryTransaction": "Y", "n1n2ByPass": "N",

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

identifier

transactionAmount":

0

1,
    "

box

actionCode": "

1

8012",
    "

crPlaza

authorizationCode": "

10MON

311S3q",
    "

crStore

effectiveDate": "

50WHN

2023-06-21",
    "

keyTracking

description": "

Hello

P2P",
    "

beneficiaryAccount

paidConcept": "

Hello

test",
    "

senderAccount

memoPostedIndicator": "

Hello

qqq",
    "

counterpartInstitution

suppressMonetaryTransaction": "

Hello

qqq",
    "

operatingInstitution

n1n2ByPass": "

Hello

qqq",
    "

frcUprkBeneficiary

identifier": "

Hello

S_IN",
    "

orderingFrcUprk

box": "

Hello

3",
    "

device

crPlaza": "

123456789-123456789-123456789-12

10MON",
    "

ip

crStore": "

198.162.200.200

50WHN",
    "

latitude

keyTracking":

-109.699

"KEYTRACKING0123456789",
    "

longitude

senderAccount":

23.062

"senderAccount012345",
    "

recipientName

beneficiaryAccount": "

Hello

beneficiaryAccount1",
    "

orderingName

counterpartInstitution": "

Hello

aaaaa",
    "

paymentSourceId

operatingInstitution": "

bf0469d7-b507-44d6-af7d-d4edea6340f1"

bbbbb",

},

xTransactionId

frcUprkBeneficiary": "

123

frcUprkBenefi",
    "

accountNumber

orderingFrcUprk": "

9500508020127353147

orderingFrcUp"

} Code Block{ "historyDate

,
    "device": "

2023

123456789-123456789-

09

123456789-

08

12",

historyTime

ip": "

122732

198.162.200.200",

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

PUT → /customers

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

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.

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

...

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

GRPC Codes

Creación del cliente

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

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

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

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": "2023-08-22"
  },
  "customerNumber": "0995000000000075954",
  "qualification": "2",
  "customerTypeIndicator": 0,
  "foreignUseIndicator": 0
}

Code Block
{ "customerNumber": "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
{ "cardNumber": "0004217470072001676" }

Code Block
{ "accountNumber": "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

Desvincular una tarjeta de un número de cuenta

Code Block
{ "customerOrAccountNumber": "9500507060523627372", "cardNumber": "0004217470969640887", "cardholderType": 1 }

Code Block
{ "cardNumber": "***************4568", "customerOrAccountNumber": "9500507060523627372" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/cards/embosser/details

Descripción

Request

Response

HTTP Codes

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

.

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 Expirado

Code Block
{ "panToken": "

0004217470595215803

0004217470200073271",
  "cardSequence":

2147483647

1,
  "foreignUse":

0

1
}

Code Block
{

   "postToAccount": "

9500508261544464147

9500507060523627372",

"blockCode":

"Z",

"cardNumber": "***************

0252", "currentCardActivation": "N", "dateBlock": "2023-09-04" }

8578",
    "currentCardActivation": "N"
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/cards/embosser/block

Descripción

Request

Response

HTTP Codes

Bloqueo de tarjetas - Bloqueo

Code Block
{ "blockCode": "Z", "panToken": "0004217470885923553", "cardSequence": 1, "functionCode": "B" //B para bloquear - u Desbloquear }

Code Block
{}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

PUT /account/prepaid

Descripción

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.

...

Page Comparison

Versions Compared

Old Version 21

New Version Current

Key

Ejemplo body:

Mirror

Account

GetAccountDetails

Aggregation

Account Aggregation Service

POST → /v1/accounts/details

SetAccountBlock

SynchronizeMirrorAccount

Balance

GetAccountBalance

POST → /v1/accounts/blocks

SynchronizeMirrorBalance

TransferBalance

POST → /v1/accounts/syncs

TransferPeerToPeer

POST → /v1/balances

FrozenBalanceTransfer

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 Adapter

CreateCustomer

UpdateCustomer

Customer Aggregation service

POST → /customers

LinkAccountToCustomer

Card Gateway

POST → /v1/cards/embosser

POST → /v1/cards/embosser/details

PUT → /customers

POST → /v1/cards/embosser/block

Aggregation

Account Aggregation Service

POST → /v1/accounts/details

POST → /v1/accounts/blocks

POST → /v1/accounts/syncs

POST → /

customers/

account

Card Aggregation service

​POST /cards/embosser/details

PUT

/

cards/

account

POST /cards/account

PUT → /v1/balances/transfers-p2p

PUT /cards/activation​ [Equipo de Spin]

PUT /cards/embosser/block

Mirror

Account

GetAccountDetails

SetAccountBlock

SynchronizeMirrorAccount

Balance

GetAccountBalance

SynchronizeMirrorBalance

TransferBalance

Customer Aggregation service

POST → /customers

PUT → /customers

POST → /customers/account

TransferPeerToPeer

FrozenBalanceTransfer

POST /cards/embosser/details

PUT /cards/activation [Equipo de Spin]

POST /cards/embosser/details

PUT /cards/activation