...

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

POST → /v1/accounts/details

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

Realiza la consulta de bloqueos de cuenta.

...

Code Block
{ "accountNumber": "9500501520328494829" }

...

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

Code Block
{ "accountData": { "accountNumber": "9500501403742215502", "customerNumber": "0995000000000080639", "blockCode1": "U", "blockCode1Date": "2023-09-

06

12",


        "blockCode2": "

M

X",


        "blockCode2Date": "2023-

08

09-

11

13"

Descripción

Request

Response

HTTP Codes

Realiza bloqueos/desbloqueo de cuenta.

}
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/accounts/blocks

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 Expirada

Code Block
{ "

blockCode

accountNumber": "

",

9500501566817108768"
}

Code Block
{ "

blockCodeIndicator

accountData":

1,

"foreignUse":

0,

functionCode

accountNumber": "

U

9500501566817108768",

"accountNumber":

"9500501520328494829" } Code Block{ "functionCode

     "customerNumber": "

U

0995000000000040921"

,

"accountNumber":

"9500501520328494829",

"localOrganization":

950

Descripción

Request

Response

HTTP Codes

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

}
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/accounts/syncs

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza la consulta de bloqueos de cuenta Bloqueada

Code Block
{ "accountNumber": "

9500501520328494829

9500509377699205330"
}

Code Block
{

    "accountData": {


        "accountNumber": "

9500501520328494829

9500509377699205330",


        "customerNumber": "

0995000000000035249

0995000000000080636",


        "blockCode1": "

M

Z",


        "blockCode1Date": "2023-09-

06

12"

,

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

Balance

...

Consulta de balance

Repositorio sincronizado con Fiserv

...

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

POST → /v1/accounts/

...

blocks

Descripción	Request	Response	HTTP Codes

Realiza la consulta de balance de cuenta.

GRPC Codes

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

Code Block
{ "blockCode": "M", "blockCodeIndicator": 0, "foreignUse": 0, "functionCode": "B", "accountNumber": "9500501520328494829" }

Code Block
{

"accountOrCardNumber

    "functionCode": "

9500501520328494829

B",

currentBalance

accountNumber":

998176209259

"9500501520328494829",

"availableCreditLimit

    "blockCode1Local":

1823760996

"M",

"frozenBalance

    "localOrganization":

26000.0

Descripción

Request

Response

HTTP Codes

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

950
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/balances/syncs

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

accountNumber

blockCode": "

9500501520328494829

U",

} Code Block{

accountOrCardNumber

blockCodeIndicator":

"9500501520328494829"

0,

currentBalance

foreignUse":

998176209259

1,

availableCreditLimit

functionCode":

1823760996

"B",

frozenBalance

accountNumber":

26000.0

"9500501520328494829"
}

200: Solicitud exitosa.

400:

Descripción

Request

Response

HTTP Codes

Realiza una transferencia .

Code Block
{ "functionCode": "B", "accountNumber": "9500501520328494829", "localOrganization": 950 }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

PUT → /v1/balances/transfers

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

transactionData

blockCode":

{

"",

transactionAmount

blockCodeIndicator":

1

2,

"foreignUse"

actionCode"

"8012"

0,

authorizationCode

functionCode": "

311S3q

U",

effectiveDate

accountNumber": "

2023-06-21

9500501520328494829"

,

Code Block
{

"description":

P2P", "paidConcept"

functionCode": "

test

U",
    "

memoPostedIndicator

accountNumber": "

qqq

9500501520328494829",
    "

suppressMonetaryTransaction

blockCode1Local": "

qqq

M",
    "

n1n2ByPass

localOrganization":

"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

950
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Para éste endpoint se requieren los siguientes valores:

blockCode: Código de bloqueo proporcionado por Spin.
blockCodeIndicator: Indica el código de bloqueo a usar: 0-1 primer código de bloqueo, 2 segundo código de bloqueo.
foreignUse: 0
functionCode: indica si se va bloquear (“B“) o desbloquear (“U“)
accountNumber: código de cuenta.

...

POST → /v1/accounts/syncs

Descripción

Request

Response

HTTP Codes

GRPC Codes

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

Code Block
{ "accountNumber": "9500503048928881284" }

Code Block
{ "accountData": { "accountNumber": "9500503048928881284", "

orderingName

customerNumber": "

orderingName012345678901234567

0995000000000076294",
        "

paymentSourceId

accountMakerDateOfBirth": "

paymentSourceId012345

1994-05-06",

},

xTransactionId

availableCredit":

"123",

10000.0,

"accountNumber":

"9500501545918394337"

} Code Block{

historyDate

userAmounts9":

"2023-09-08", "historyTime": "122250", "transactionData": { "transactionCode": "8012", "transactionDescription": "P2P RECIEVER", "currentBalance": "-2122495", "openToBuy": "2122546"

-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

...

Descripción

Request

Response

HTTP Codes

Realiza una transferencia P2P.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{ "

from

accountNumber": "9500501403742215502"
}

Code Block
{ "

accountNumber

accountData":

"9500508496924050930",

{
        "

actionCode

accountNumber": "

8008

9500501403742215502",
        "

transactionDescription

customerNumber": "

P2P_TRANSFER_SOURCE

0995000000000080639",

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

latitude

accountData":

123.56565656,

{
        "

longitude

accountNumber":

-23.565656

"9500508152383529456",
        "

xTransactionId

customerNumber": "

123" } Code Block{ "effectiveDate

0995000000000040667",
        "accountMakerDateOfBirth": "

2022

2000-01-

30

01",

"transactionAmount

        "availableCredit":

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

10000.0,
        "userAmounts9": -170000.0,
        "userAmounts10": -130000.0,
        "userAmounts7": -10000.0
    }
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

...

POST → /v1/balances

...

Descripción

Request

Response

HTTP Codes

Realiza una transferencia QR.

Code Block

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

transactionData

accountNumber": "9500508176491773011"
}

Code Block
{ "

transactionAmount

accountData":

20,

 {
        "

actionCode

accountNumber": "

8038

9500508176491773011",
        "

authorizationCode

customerNumber": "

Q1er44

0995000000000080637",
        "

effectiveDate

blockCode1": "

2022-08-24

Z",
        "

description

blockCode1Date": "

QR code test - normal hours",

2023-09-12",
        "

paidConcept

blockCode2Date": "

Hello

2023-09-18",

"memoPostedIndicator":

"

",

suppressMonetaryTransaction

accountMakerDateOfBirth": "

Y

1994-05-06"

,

"n1n2ByPass

}
}

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

N

9500501520328494829"

,

"identifier

Code Block
{ "accountOrCardNumber":

0, "box": "1", "crPlaza": "10MON", "crStore": "50WHN", "keyTracking": "Hello", "beneficiaryAccount": "Hello", "senderAccount": "Hello", "counterpartInstitution": "Hello",

"9500501520328494829",
	"currentBalance": 998176209259,
	"availableCreditLimit": 1823760996,
	"frozenBalance": 26000.0
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

POST → /v1/balances/syncs

Descripción

Request

Response

HTTP Codes

GRPC Codes

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

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block
{ "

operatingInstitution

accountOrCardNumber": "

Hello

9500503048928881284",
    "

frcUprkBeneficiary

currentBalance":

"Hello"

-10000.0,
    "

orderingFrcUprk

availableCreditLimit":

"Hello", "device": "123456789-123456789-123456789-12",

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

ip

accountOrCardNumber":

"198.162.200.200", "latitude": -109.699,

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

longitude

accountOrCardNumber":

23.062

"9500508152383529456",
    "

recipientName

currentBalance":

"Hello"

-10000.0,
    "

orderingName

availableCreditLimit":

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

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

...

HTTP Codes

SetAccountBlock

...

Descripción

...

Request

...

Response

...

HTTP Codes

TransferBalance

...

Descripción

...

Request

...

Response

...

HTTP Codes

TransferPeerToPeer

...

Descripción

...

Request

...

Response

...

HTTP Codes

FrozenBalanceTransfer

...

Descripción

...

Request

...

Response

...

HTTP Codes

GetAccountBalance

...

Descripción

...

Request

...

Response

...

HTTP Codes

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.

POST → /customer

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

Creación del cliente

PUT → /customer

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

Actualizar cliente

PUT → /account/customer

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

Vincular cuenta al cliente

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

POST → /v1/cards/embosser/block

...

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

Realiza la consulta de bloqueos de cuenta.

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block

{
	"accountData": {
		"accountNumber": "9500501520328494829",
		"customerNumber": "0995000000000035249",
		"blockCode1": "M",
		"blockCode1Date": "2023-09-06",
		"blockCode2": "M",
		"blockCode2Date": "2023-08-11"
	}
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/accounts/blocks

Descripción

Request

Response

HTTP Codes

Realiza bloqueos/desbloqueo de cuenta.

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

Code Block
{ "functionCode": "U", "accountNumber": "9500501520328494829", "localOrganization": 950 }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/accounts/syncs

Descripción

Request

Response

HTTP Codes

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

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block

{
	"accountData": {
		"accountNumber": "9500501520328494829",
		"customerNumber": "0995000000000035249",
		"blockCode1": "M",
		"blockCode1Date": "2023-09-06",
		"blockCode2": "M",
		"blockCode2Date": "2023-08-11"
	}
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.POST → /v1/balances

POST → /v1/balances

Descripción

Request

Response

HTTP Codes

Realiza la consulta de balance de cuenta.

Code Block
{ "accountNumber": "9500501520328494829" }

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/balances/syncs

Descripción

Request

Response

HTTP Codes

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

10000.0
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{ "accountNumber": "9500508176491773011" }

Code Block
{ "accountOrCardNumber": "9500508176491773011" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

PUT → /v1/balances/transfers

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza una transferencia - Número de cuenta Activa

Code Block

{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500503048928881284", 
  "operationType": "D"
 }

Code Block
{ "historyDate": "2023-09-18", "historyTime": "164440", "transactionData": { "transactionCode": "8000", "currentBalance": "-10000", "openToBuy": "13000" } }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza una transferencia - Número de cuenta Inactiva

Code Block

{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500501403742215502", 
  "operationType": "D"
 }

Code Block
{ "historyDate": "2023-09-18", "historyTime": "164651", "transactionData": { "transactionCode": "8000", "openToBuy": "2000" } }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza una transferencia - Número de cuenta Expirada

Code Block

{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508152383529456", 
  "operationType": "D"
 }

Code Block
{ "historyDate": "2023-09-18", "historyTime": "164734", "transactionData": { "transactionCode": "8000", "currentBalance": "-10000", "openToBuy": "12000" } }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza una transferencia - Número de cuenta Bloqueada

Code Block

{
  "transactionData": {
    "transactionAmount": 1000,
    "actionCode": "8000",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508176491773011", 
  "operationType": "D"
 }

Code Block
{ "historyDate": "2023-09-18", "historyTime": "164818", "transactionData": { "transactionCode": "8000", "openToBuy": "2000" } }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

PUT → /v1/balances/transfers-p2p

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza una transferencia P2P.

Code Block

{
  "from": {
    "accountNumber": "9500508496924050930",
    "actionCode": "8008",
    "transactionDescription": "P2P_TRANSFER_SOURCE",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
  "to": {
    "accountNumber": "9500502030236002994",
    "actionCode": "8012",
    "transactionDescription": "P2P_TRANSFER_TARGET",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
    "effectiveDate": "2022-01-30",
    "transactionAmount": 100,
    "device": "abcfghjfghjklghjkfghjk5678956789",
    "ip": "198.162.123.148",
    "latitude": 123.56565656,
    "longitude": -23.565656,
    "xTransactionId": "123"
}

Code Block

{
	"effectiveDate": "2022-01-30",
	"transactionAmount": "100",
	"actionOutputArea": {
		"actionData": [
			{
				"authorizationCode": "1234",
				"accountNumber": "9500508496924050930",
				"transactionDescription": "P2P SENDER",
				"transactionCode": 8008,
				"currentBalance": -5988391.0,
				"openToBuy": 5.987391E8,
				"authorizationNumber": "205229"
			},
			{
				"authorizationCode": "1234",
				"accountNumber": "9500502030236002994",
				"transactionDescription": "P2P RECIEVER",
				"transactionCode": 8012,
				"currentBalance": -169434.0,
				"openToBuy": 1.70434E7,
				"authorizationNumber": "923589"
			}
		]
	}
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

PUT → /v1/balances/transfers-qr

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza una transferencia QR.

Code Block

{
  "transactionData": {
    "transactionAmount": 20,
    "actionCode": "8038",
    "authorizationCode": "Q1er44",
    "effectiveDate": "2022-08-24",
    "description": "QR code test - normal hours",
    "paidConcept": "Hello",
    "memoPostedIndicator": " ",
    "suppressMonetaryTransaction": "Y",
    "n1n2ByPass": "N",
    "identifier": 0,
    "box": "1",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "Hello",
    "beneficiaryAccount": "Hello",
    "senderAccount": "Hello",
    "counterpartInstitution": "Hello",
    "operatingInstitution": "Hello",
    "frcUprkBeneficiary": "Hello",
    "orderingFrcUprk": "Hello",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "Hello",
    "orderingName": "Hello",
    "paymentSourceId": "bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508020127353147"
}

Code Block

{
	"historyDate": "2023-09-08",
	"historyTime": "122732",
	"transactionData": {
		"transactionCode": "8038",
		"transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
		"currentBalance": "-1382946",
		"openToBuy": "1382486"
	}
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

...

Customer Aggregation service

Info

Incorpora los endpoints de Customer

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

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

POST → /customers

Descripción

Request

Response

HTTP Codes

GRPC Codes

Registro del cliente en la el proveedor de clientes.

Code Block

{
    "logo": "60",
    "address": "Ciruelas",
    "houseNumber": "12345",
    "externalNumber": "8007",
    "colony": "Lomas",
    "city": "Lomas de Alvarez",
    "state": "COL",
    "postalCode": "99980",
    "dateOfBirth": "2000-08-06",
    "stateOfBirth": "CDMX",
    "email": "lmedina@palo-it.com",
    "firstName": "Judith",
    "lastName": "Medina",
    "maternalLastName": "Ruiz",
    "mobilePhoneNumber": "5521163588",
    "identificationNumber": "4152554487415113698",
    "ine": "1234117890099",
    "occupation": "Tester",
    "genderCode": "1",
    "user4":"1",
    "identificationNumberFlag": "2"
}

Code Block
{ "customerNumber": "0995000000000080589" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

PUT → /customers

Descripción

Request

Response

HTTP Codes

GRPC Codes

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

Code Block

{
    "email": "lmedina@palo-it.com",
    "numberType": 1,
    "customerNumber": "0995000000000077863",
    "address": "Ciruelas",
    "dateOfBirth": "1999-02-06",
    "city": "Villa de Alvarez",
    "countryCode": "MEX",
    "county": "CDMX",
    "colony": "ADOLFO LOPEZ MATEOS",
    "externalNumber": "1007",
    "firstName": "Sandra",
    "genderCode": 2,
    "houseNumber": "123",
    "ine": "1234117890099",
    "lastName": "Velasco",
    "maritalStatus": 0,
    "maternalLastName": "Medina",
    "middleName": "Rosa",
    "mobilePhoneIndicator": 1,
    "mobilePhoneNumber": "31211635899",
    "occupation": "NURSE",
    "ownOrRentResidenceFlag": 0,
    "postalCode": 54070,
    "stateOfBirth": "DF"
}

Code Block

{
    "outputArea": {
        "customerNumber": "0995000000000077863",
        "accountNumber": "0995000000000077863",
        "responseCode": "",
        "level": "",
        "transactionAmount": 0,
        "countryLimit": {
            "dailyLimitLoad": 0,
            "monthlyLimitLoad": 0,
            "dailyLimitCash": 0,
            "monthlyLimitCash": 0,
            "limitForDepositTransactions": 0
        },
        "accountLimit": {
            "accountDailyAmountLoad": 0,
            "accountMonthlyAmountLoad": 0,
            "accountDailyAmountCash": 0,
            "accountMonthlyAmountCash": 0
        }
    }
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

POST → /customers/account

Descripción

Request

Response

HTTP Codes

GRPC Codes

Vinculación del cliente en la cuenta de Spin.

Code Block

{
    "accountNumber": "0004217470138987703",
    "customerNumber": "0995000000000045698",
    "qualification": "1",
    "customerTypeIndicator": 0,
    "foreignUseIndicator": 0,
    "alternateCustomer": {
        "expirationDate": "2023/12/30"
    }
}

Code Block
{ "customerNumber": "0995000000000045697", "accountNumber": "1650" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

...

Card Aggregation service

Info

Incorpora los endpoints de Card

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

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

POST /cards/embosser/details

Descripción

Request

Response

HTTP Codes

Obtener cuenta mediante Pantoken

Code Block
{ "panToken": "0004217470595215803", "cardSequence": 2147483647, "foreignUse": 0 }

Code Block
{ "postToAccount": "9500508261544464147", "blockCode": "Z", "cardNumber": "***************0252", "currentCardActivation": "N", "dateBlock": "2023-09-04" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

PUT /cards/account

Descripción

Request

Response

HTTP Codes

Vinculación de tarjetas a cuenta

Code Block
{ "customerOrAccountNumber": "1234567890123456800", "cardNumber": "000123456ID5IXX1234", "cardholderType": 1 }

Code Block
{ "customerOrAccountNumber": "1234567890123456800", "cardNumber": "000123456ID5IXX1234", }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST /cards/account

Descripción

Request

Response

HTTP Codes

Recuperación del numero de cuenta

Code Block
{ "cardNumber": "000123456ID5IXX1234", }

Code Block
{ "accountNumber": "0004217470041850252" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

Info
El cardNumber debe tener tres ceros a la izquierda para completar el tamaño de 19 dígitos solicitado por el operador bancario.

Image Added

PUT /cards/activation [Equipo de Spin]

Descripción

Request

Response

HTTP Codes

Activación de tarjetas

Code Block
{ "organizationNumber": 999, "cardNumber": "000123456ID5IXX1234", "serviceType": "A", "userData": "string" }

Code Block
{ "organizationNumber": 999, "logo": 1, "cardNumber": "000123456ID5IXX1234", "serviceType": "A", "numberCardsActivated": 1, "foreignOrg": 1, "numberForeignCardsActivated": 0 }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

PUT /cards/embosser/block

Descripción

Request

Response

HTTP Codes

Bloqueo de tarjetas

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

Code Block
{}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

...

Mirror

Account

Info

Consulta de bloqueos

Repositorio sincronizado con Fiserv

Disminuye peticiones al Proveedor

GetAccountDetails

Descripción

Request

Response

GRPC Codes

Realiza la consulta de bloqueos de cuenta.

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block

{
  "accountData": {
    "accountNumber": "9500501520328494829",
    "customerNumber": "0995000000000035249",
    "blockCode1": "M",
    "blockCode1Date": "2023-09-07",
    "blockCode2": "M",
    "blockCode2Date": "2023-08-11",
    "accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 0
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

SetAccountBlock

Descripción

Request

Response

GRPC Codes

Realiza bloqueos/desbloqueo de cuenta.

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

Code Block
{ "functionCode": "B", "accountNumber": "9500501520328494829", "blockCode1Local": "M", "localOrganization": 950 }

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

SynchronizeMirrorAccount

Descripción

Request

Response

GRPC Codes

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

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block

{
  "accountData": {
    "accountNumber": "9500501520328494829",
    "customerNumber": "0995000000000035249",
    "blockCode1": "M",
    "blockCode1Date": "2023-09-07",
    "blockCode2": "M",
    "blockCode2Date": "2023-08-11",
    "accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 0
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

...

Balance

Info

Consulta de balance

Repositorio sincronizado con Fiserv

Disminuye peticiones al Proveedor

GetAccountBalance

Descripción

Request

Response

GRPC Codes

Realiza la consulta de balance de cuenta.

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block
{ "accountOrCardNumber": "9500501520328494829", "currentBalance": 998176210159, "availableCreditLimit": 32237425576994724, "frozenBalance": 26000 }

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

SynchronizeMirrorBalance

Descripción

Request

Response

GRPC Codes

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

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block
{ "accountOrCardNumber": "9500501520328494829", "currentBalance": 998176210159, "availableCreditLimit": 32237425576994724, "frozenBalance": 26000 }

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

TransferBalance

Descripción

Request

Response

GRPC Codes

Realiza una transferencia .

Code Block

{
  "transactionData": {
    "transactionAmount": 1,
    "actionCode": "8012",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345",
  "operationType": "W"
  },
  "xTransactionId": "123",
  "accountNumber": "9500501545918394337"
}

Code Block

{
  "historyDate": "2023-09-12",
  "historyTime": "111208",
  "transactionData": {
    "transactionCode": "8012",
    "transactionDescription": "P2P RECIEVER",
    "currentBalance": "-2122495",
    "openToBuy": "2122548"
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

TransferPeerToPeer

Descripción

Request

Response

GRPC Codes

Realiza una transferencia P2P.

Code Block

{
  "from": {
    "accountNumber": "9500508496924050930",
    "actionCode": "8008",
    "transactionDescription": "P2P_TRANSFER_SOURCE",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
  "to": {
    "accountNumber": "9500502030236002994",
    "actionCode": "8012",
    "transactionDescription": "P2P_TRANSFER_TARGET",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
    "effectiveDate": "2022-01-30",
    "transactionAmount": 100,
    "device": "abcfghjfghjklghjkfghjk5678956789",
    "ip": "198.162.123.148",
    "latitude": 123.56565656,
    "longitude": -23.565656,
    "xTransactionId": "123"
}

Code Block

{
  "effectiveDate": "2022-01-30",
  "transactionAmount": "100",
  "actionOutputArea": {
    "actionData": [
      {
        "authorizationCode": "1234",
        "accountNumber": "9500508496924050930",
        "transactionDescription": "P2P SENDER",
        "feeAmount": "0",
        "transactionCode": 8008,
        "currentBalance": -5988391,
        "creditLimit": 0,
        "openToBuy": 598649100,
        "authorizationNumber": "507925"
      },
      {
        "authorizationCode": "1234",
        "accountNumber": "9500502030236002994",
        "transactionDescription": "P2P RECIEVER",
        "feeAmount": "0",
        "transactionCode": 8012,
        "currentBalance": -169434,
        "creditLimit": 0,
        "openToBuy": 17133400,
        "authorizationNumber": "332272"
      }
    ]
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

FrozenBalanceTransfer

Descripción

Request

Response

GRPC Codes

Realiza una transferencia QR.

Code Block

{
  "transactionData": {
    "transactionAmount": 20,
    "actionCode": "8038",
    "authorizationCode": "Q1er44",
    "effectiveDate": "2022-08-24",
    "description": "QR code test - normal hours",
    "paidConcept": "Hello",
    "memoPostedIndicator": " ",
    "suppressMonetaryTransaction": "Y",
    "n1n2ByPass": "N",
    "identifier": 0,
    "box": "1",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "Hello",
    "beneficiaryAccount": "Hello",
    "senderAccount": "Hello",
    "counterpartInstitution": "Hello",
    "operatingInstitution": "Hello",
    "frcUprkBeneficiary": "Hello",
    "orderingFrcUprk": "Hello",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "Hello",
    "orderingName": "Hello",
    "paymentSourceId": "bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508020127353147"
}

Code Block

{
  "historyDate": "2023-09-12",
  "historyTime": "111311",
  "transactionData": {
    "transactionCode": "8038",
    "transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
    "currentBalance": "-1382946",
    "openToBuy": "1382326"
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

...

Card

Info

Incorpora los endpoints de Card Mirror

Sincronización de datos con el Mirror

Expone endpoints a través de un API REST

POST → /v1/cards/embossers/details

Descripción

Request

Response

HTTP Codes

Obtener cuenta mediante Pantoken

Code Block
{ "panToken": "0004217470595215803", "cardSequence": 2147483647, "foreignUse": 0 }

Code Block
{ "postToAccount": "9500508261544464147", "blockCode": "Z", "cardNumber": "***************0252", "currentCardActivation": "N", "dateBlock": "2023-09-04" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

PUT → /v1/cards/embossers/block

Descripción

Request

Response

HTTP Codes

Bloqueo de tarjetas

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

Code Block
{}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

...

Gateway

Account Adapter

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

GetAccountDetails

Descripción

Request

Response

GRPC Codes

Realiza la consulta de bloqueos de cuenta.

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block

{
  "accountData": {
    "accountNumber": "9500501520328494829",
    "customerNumber": "0995000000000035249",
    "blockCode1": "M",
    "blockCode1Date": "2023-09-07",
    "blockCode2": "M",
    "blockCode2Date": "2023-08-11",
    "accountMakerDateOfBirth": "",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 0
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

SetAccountBlock

Descripción

Request

Response

GRPC Codes

Realiza bloqueos/desbloqueo de cuenta.

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

Code Block
{ "functionCode": "B", "accountNumber": "9500501520328494829", "blockCode1Local": "M", "localOrganization": 950 }

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

TransferBalance

Descripción

Request

Response

GRPC Codes

Realiza una transferencia .

Code Block

{
  "transactionData": {
    "transactionAmount": 1,
    "actionCode": "8012",
    "authorizationCode": "311S3q",
    "effectiveDate": "2023-06-21",
    "description": "P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "identifier": "S_IN",
    "box": "3",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "KEYTRACKING0123456789",
    "senderAccount": "senderAccount012345",
    "beneficiaryAccount": "beneficiaryAccount1",
    "counterpartInstitution": "aaaaa",
    "operatingInstitution": "bbbbb",
    "frcUprkBeneficiary": "frcUprkBenefi",
    "orderingFrcUprk": "orderingFrcUp",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "recipientName01234567890123456",
    "orderingName": "orderingName012345678901234567",
    "paymentSourceId": "paymentSourceId012345"
  },
  "xTransactionId": "123",
  "accountNumber": "9500501545918394337"
}

Code Block

{
  "historyDate": "2023-09-12",
  "historyTime": "111208",
  "transactionData": {
    "transactionCode": "8012",
    "transactionDescription": "P2P RECIEVER",
    "currentBalance": "-2122495",
    "openToBuy": "2122548"
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

TransferPeerToPeer

Descripción

Request

Response

GRPC Codes

Realiza una transferencia P2P.

Code Block

{
  "from": {
    "accountNumber": "9500508496924050930",
    "actionCode": "8008",
    "transactionDescription": "P2P_TRANSFER_SOURCE",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
  "to": {
    "accountNumber": "9500502030236002994",
    "actionCode": "8012",
    "transactionDescription": "P2P_TRANSFER_TARGET",
    "description": "P2P_TRANSFER_SOURCE",
    "authorizationCode": "1234"
  },
    "effectiveDate": "2022-01-30",
    "transactionAmount": 100,
    "device": "abcfghjfghjklghjkfghjk5678956789",
    "ip": "198.162.123.148",
    "latitude": 123.56565656,
    "longitude": -23.565656,
    "xTransactionId": "123"
}

Code Block

{
  "effectiveDate": "2022-01-30",
  "transactionAmount": "100",
  "actionOutputArea": {
    "actionData": [
      {
        "authorizationCode": "1234",
        "accountNumber": "9500508496924050930",
        "transactionDescription": "P2P SENDER",
        "feeAmount": "0",
        "transactionCode": 8008,
        "currentBalance": -5988391,
        "creditLimit": 0,
        "openToBuy": 598649100,
        "authorizationNumber": "507925"
      },
      {
        "authorizationCode": "1234",
        "accountNumber": "9500502030236002994",
        "transactionDescription": "P2P RECIEVER",
        "feeAmount": "0",
        "transactionCode": 8012,
        "currentBalance": -169434,
        "creditLimit": 0,
        "openToBuy": 17133400,
        "authorizationNumber": "332272"
      }
    ]
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

FrozenBalanceTransfer

Descripción

Request

Response

GRPC Codes

Realiza una transferencia QR.

Code Block

{
  "transactionData": {
    "transactionAmount": 20,
    "actionCode": "8038",
    "authorizationCode": "Q1er44",
    "effectiveDate": "2022-08-24",
    "description": "QR code test - normal hours",
    "paidConcept": "Hello",
    "memoPostedIndicator": " ",
    "suppressMonetaryTransaction": "Y",
    "n1n2ByPass": "N",
    "identifier": 0,
    "box": "1",
    "crPlaza": "10MON",
    "crStore": "50WHN",
    "keyTracking": "Hello",
    "beneficiaryAccount": "Hello",
    "senderAccount": "Hello",
    "counterpartInstitution": "Hello",
    "operatingInstitution": "Hello",
    "frcUprkBeneficiary": "Hello",
    "orderingFrcUprk": "Hello",
    "device": "123456789-123456789-123456789-12",
    "ip": "198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "Hello",
    "orderingName": "Hello",
    "paymentSourceId": "bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508020127353147"
}

Code Block

{
  "historyDate": "2023-09-12",
  "historyTime": "111311",
  "transactionData": {
    "transactionCode": "8038",
    "transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
    "currentBalance": "-1382946",
    "openToBuy": "1382326"
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

GetAccountBalance

Descripción

Request

Response

GRPC Codes

Realiza la consulta de balance de cuenta.

Code Block
{ "accountNumber": "9500501520328494829" }

Code Block
{

 "accountOrCardNumber": "9500501520328494829",

  "currentBalance":

998176209259

998176210159,

"availableCreditLimit":

1823760996

32237425576994724,

  "frozenBalance": 26000

.0

200

0 OK: Solicitud exitosa.

400

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

401: Apy Key no válida.

500: Servicios no disponibles.

...

13 Internal Server Error: Servicios no disponibles.

...

Customer Adapter

Info

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

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

CreateCustomer

Descripción	Request	Response

HTTP

GRPC Codes

Realiza una transferencia .

Creación del cliente

Code Block
{ "

transactionData

logo":

{

"60",
    "

transactionAmount

address":

1

"Ciruelas",
    "

actionCode

houseNumber": "

8012

12345",
    "

authorizationCode

externalNumber": "

311S3q

8007",
    "

effectiveDate

colony": "

2023-06-21

Lomas",
    "

description

city": "

P2P

Lomas de Alvarez",
    "

paidConcept

state": "

test

COL",
    "

memoPostedIndicator

postalCode": "

qqq

99980",
    "

suppressMonetaryTransaction

dateOfBirth": "

qqq

2000-08-06",
    "

n1n2ByPass

stateOfBirth": "

qqq

CDMX",
    "

identifier

email": "

S_IN

lmedina@palo-it.com",
    "

box

firstName": "

3

Judith",
    "

crPlaza

lastName": "

10MON

Medina",
    "

crStore

maternalLastName": "

50WHN

Ruiz",
    "

keyTracking

mobilePhoneNumber": "

KEYTRACKING0123456789

5521163588",
    "

senderAccount

identificationNumber": "

senderAccount012345

4152554487415113698",
    "

beneficiaryAccount

ine": "

beneficiaryAccount1

1234117890099",
    "

counterpartInstitution

occupation": "

aaaaa

Tester",
    "

operatingInstitution

genderCode": "

bbbbb

1",
    "

frcUprkBeneficiary

user4":

frcUprkBenefi

1",
    "

orderingFrcUprk

identificationNumberFlag": "

orderingFrcUp",

2"
}

Code Block
{ "

device

customerNumber": "

123456789-123456789-123456789-12",

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

ip

email": "

198.162.200.200

lmedina@palo-it.com",
    "

latitude

numberType":

-109.699

1,
    "

longitude

customerNumber":

23.062,

recipientName

0995000000000077863"

: "recipientName01234567890123456"

,
    "

orderingName

address": "

orderingName012345678901234567

Ciruelas",
    "

paymentSourceId

dateOfBirth": "

paymentSourceId012345" }

1999-02-06",

"xTransactionId":

"123",

accountNumber

city": "

9500501545918394337" } Code Block{ "historyDate": "2023-09-08", "historyTime": "122250", "transactionData": { "transactionCode

Villa de Alvarez",
    "countryCode": "

8012

MEX",

transactionDescription

county": "

P2P RECIEVER

CDMX",

"currentBalance

    "colony": "

-2122495

ADOLFO LOPEZ MATEOS",

openToBuy

externalNumber": "

2122546

1007",

} }

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{

    "firstName": "Sandra",
    "

from

genderCode":

{

2,
    "

accountNumber

houseNumber": "

9500508496924050930

123",
    "

actionCode

ine": "

8008

1234117890099",
    "

transactionDescription

lastName": "Velasco",
    "

P2P_TRANSFER_SOURCE"

maritalStatus": 0,
    "

description

maternalLastName": "

P2P_TRANSFER_SOURCE

Medina",
    "

authorizationCode

middleName": "

1234

Rosa",

},

to

mobilePhoneIndicator":

{

1,
    "

accountNumber

mobilePhoneNumber": "

9500502030236002994

31211635899",
    "

actionCode

occupation": "

8012

NURSE",
    "

transactionDescription

ownOrRentResidenceFlag": 0,

"P2P_TRANSFER_TARGET"

    "postalCode": 54070,
    "

description

stateOfBirth": "

P2P_TRANSFER_SOURCE",

DF"
}

Code Block
{ "

authorizationCode

outputArea":

"1234"

},

effectiveDate

customerNumber": "

2022-01-30

0995000000000077863",
        "

transactionAmount

accountNumber":

100

"0995000000000077863",
        "

device

responseCode": "

abcfghjfghjklghjkfghjk5678956789

",
        "

ip

level": "

198.162.123.148

",
        "

latitude

transactionAmount":

123.56565656

0,

"longitude":

-23.565656,

xTransactionId

countryLimit":

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

400500:

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

401: Apy Key no válida.

13 Internal Server Error: Servicios no disponibles.

...

LinkAccountToCustomer

Descripción	Request	Response

HTTP

GRPC Codes

Realiza una transferencia QR.

Vincular cuenta al cliente

Code Block
{ "

transactionData

accountNumber":

{

transactionAmount

9500505675946730065"

: 20

actionCode

alternateCustomer":

"8038",

"authorizationCode": "Q1er44",

effectiveDate

expirationDate": "

2022

2023-08-

24

22"

,

"description": "QR code test - normal hours"

},

paidConcept

customerNumber": "

Hello

0995000000000075954",

memoPostedIndicator

qualification": "

2",

suppressMonetaryTransaction

customerTypeIndicator":

"Y"

0,

n1n2ByPass

foreignUseIndicator":

"N", "identifier": 0,

0
}

Code Block
{

box

customerNumber": "

1

0995000000000045697",
    "

crPlaza

accountNumber": "

10MON

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

crStore

cardNumber": "

50WHN",

0004217470072001676"
}

Code Block
{ "

keyTracking

accountNumber": "

Hello

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

beneficiaryAccount

customerOrAccountNumber": "

Hello

9500507060523627372",

senderAccount

cardNumber": "

Hello

0004217470969640887",

counterpartInstitution

cardholderType":

"Hello",

1
}

Code Block
{ "

operatingInstitution

cardNumber": "

Hello

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

frcUprkBeneficiary

customerOrAccountNumber": "

Hello

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
{

orderingFrcUprk

panToken": "

Hello

0004217470595215803",

device

cardSequence":

"123456789-123456789-123456789-12"

2147483647,

ip

foreignUse": 0
}

Code Block
{

"198.162.200.200

	"postToAccount": "9500508261544464147",

"latitude

	"blockCode":

-109.699

"Z",

"longitude": 23.062, "recipientName

	"cardNumber": "***************0252",
	"currentCardActivation": "

Hello

N",

	"dateBlock": "

orderingName": "Hello", "paymentSourceId": "bf0469d7-b507-44d6-af7d-d4edea6340f1" }

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

xTransactionId

cardSequence":

"123"

1,
  "

accountNumber

foreignUse":

"9500508020127353147"

1
}

Code Block
{

"historyDate

    "postToAccount": "

2023-09-08

9500507060523627372",

"historyTime

    "blockCode": "

122732

Z",

"transactionData":

{

"transactionCode":

"8038",

transactionDescription

cardNumber": "

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

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

-1382946

N",

"openToBuy

    "dateBlock": "

1382486" }

2023-09-04"
}

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.

PUT → /customers

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

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

POST → /customers/account

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

Vinculación del cliente en la cuenta de Spin.

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

PUT /account/prepaid

...

Descripción

...

Request

...

Response

...

HTTP Codes

...

Obtener cuenta mediante Pantoken Expirado

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

Code Block
{ "postToAccount": "9500507060523627372", "cardNumber": "***************8578", "currentCardActivation": "N" }

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

POST → /v1/cards/embosser/block

Descripción	Request	Response	HTTP Codes

PUT /cards/activation

...

Descripción

...

Request

...

Response

...

HTTP Codes

PUT /cards/embosser/block

Descripción

Request

Response

HTTP Codes

Bloqueo de tarjetas - 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.

Bloqueo de tarjetas - Desbloqueo

Code Block
{ "blockCode": "", "panToken": "0004217470752022413", "cardSequence": 1, "functionCode": "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 10

New Version Current

Key

Ejemplo body:

Mirror

Account

POST → /v1/accounts/details

Aggregation

Account Aggregation Service

POST → /v1/accounts/details

POST → /v1/accounts/blocks

POST → /v1/accounts/syncs

Balance

POST → /v1/accounts/

blocks

POST → /v1/balances/syncs

PUT → /v1/balances/transfers

POST → /v1/accounts/syncs

POST → /v1/balances

POST → /v1/balances/syncs

Card

POST → /v1/cards/embossers/details

PUT → /v1/cards/embossers/block

Gateway

Account Adapter

GetAccountDetails

SetAccountBlock

TransferBalance

TransferPeerToPeer

FrozenBalanceTransfer

GetAccountBalance

Customer Adapter

POST → /customer

PUT → /customer

PUT → /account/customer

Card Gateway

POST → /v1/cards/embosser

POST → /v1/cards/embosser/details

POST → /v1/cards/embosser/block

Aggregation

Account Aggregation Service

POST → /v1/accounts/details

POST → /v1/accounts/blocks

POST → /v1/accounts/syncs

POST → /v1/balances

POST → /v1/balances/syncs

PUT → /v1/balances/transfers

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

SynchronizeMirrorAccount

Balance

GetAccountBalance

SynchronizeMirrorBalance

TransferBalance

TransferPeerToPeer

FrozenBalanceTransfer

Card

POST → /v1/cards/embossers/details

PUT → /v1/cards/embossers/block

Gateway

Account Adapter

GetAccountDetails

SetAccountBlock

TransferBalance

POST /cards/embosser/details

PUT /cards/activation [Equipo de Spin]

POST /cards/embosser/details

PUT /cards/activation