Versions Compared

Old Version 39

changes.mady.by.user Héctor Villa

Saved on

compared with

New Version Current

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

Saved on

Key

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

...

Note

IMPORTANTE:

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

Account + Customer en Genesys

Card en Spin

Detalle de endpoints

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

Ejemplo body:

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

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

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

Body - Request

{

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

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

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

    "publicKeyAlgorithm": "RSA"

}

 

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#FFBDAD

Body - Response

{

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

}

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.

...

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", 
        "blockCode2": "X",
        "blockCode2Date": "2023-
08
09-
11
13"
    
}
}

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/accounts/blocks

Descripción

Request

ResponseRealiza bloqueos/desbloqueo de cuenta.

HTTP Codes

GRPC Codes

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": "U", "accountNumber
      "customerNumber": "
9500501520328494829
0995000000000040921"
,
"localOrganization":
950

Descripción

Request

Response

HTTP Codes

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

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

POST → /v1/accounts/syncs

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.

POST → /v1/balances0

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

GRPC Codes

Realiza

la consulta de balance de cuenta.

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

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

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

POST → /v1/balances/syncs

Descripción

Request

Response

HTTP Codes

GRPC Codes

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

Code Block
{
  "accountNumber": "9500501520328494829"
}
Code Block{ "accountOrCardNumber": "9500501520328494829", "currentBalance": 998176209259, "availableCreditLimit": 1823760996, "frozenBalance": 26000.0
{
    "functionCode": "B",
    "accountNumber": "9500501520328494829",
    "blockCode1Local": "M",
    "localOrganization": 950
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{
  "blockCode": "U",
  "blockCodeIndicator": 0,
  "foreignUse": 1,
  "functionCode": "B",
  "accountNumber": "9500501520328494829"
}
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.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza bloqueos/desbloqueo de cuenta - Desbloquear

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

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Para éste endpoint se requieren los siguientes valores:

  • blockCode: Código de bloqueo proporcionado por Spin.

  • blockCodeIndicator: Indica el código de bloqueo a usar: 0-1 primer código de bloqueo, 2 segundo código de bloqueo.

  • foreignUse: 0

  • functionCode: indica si se va bloquear (“B“) o desbloquear (“U“)

  • accountNumber: código de cuenta.

...

POST → /v1/accounts/syncs

Descripción

Request

Response

HTTP Codes

GRPC Codes

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

Code Block
{
  "accountNumber": "9500503048928881284"
}
Code Block
{
    "accountData": {
        "accountNumber": "9500503048928881284",
        "customerNumber": "0995000000000076294",
        "accountMakerDateOfBirth": "1994-05-06",
        "availableCredit": 10000.0,
        "userAmounts9": -50000.0,
        "userAmounts10": -40000.0
    }
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

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

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{
  "accountNumber": "9500501403742215502"
}
Code Block
{
    "accountData": {
        "accountNumber": "9500501403742215502",
        "customerNumber": "0995000000000080639",
        "blockCode1": "U",
        "blockCode1Date": "2023-09-12",
        "blockCode2": "X",
        "blockCode2Date": "2023-09-13",
        "accountMakerDateOfBirth": "1994-05-06"
    }
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

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

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{
  "accountNumber": "9500508152383529456"
}
Code Block
{
    "accountData": {
        "accountNumber": "9500508152383529456",
        "customerNumber": "0995000000000040667",
        "accountMakerDateOfBirth": "2000-01-01",
        "availableCredit": 10000.0,
        "userAmounts9": -170000.0,
        "userAmounts10": -130000.0,
        "userAmounts7": -10000.0
    }
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

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

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{
  "accountNumber": "9500508176491773011"
}
Code Block
{
    "accountData": {
        "accountNumber": "9500508176491773011",
        "customerNumber": "0995000000000080637",
        "blockCode1": "Z",
        "blockCode1Date": "2023-09-12",
        "blockCode2Date": "2023-09-18",
        "accountMakerDateOfBirth": "1994-05-06"
    }
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

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

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

POST → /v1/balances

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza la consulta de balance de cuenta.

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

POST → /v1/balances/syncs

Descripción

Request

Response

HTTP Codes

GRPC Codes

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

Code Block
{
  "accountNumber": "9500501520328494829"
}
Code Block
{
    "accountOrCardNumber": "9500503048928881284",
    "currentBalance": -10000.0,
    "availableCreditLimit": 10000.0
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{
  "accountNumber": "9500501403742215502"
}
Code Block
{
    "accountOrCardNumber": "9500501403742215502"
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{
  "accountNumber": "9500508152383529456"
}
Code Block
{
    "accountOrCardNumber": "9500508152383529456",
    "currentBalance": -10000.0,
    "availableCreditLimit": 10000.0
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

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

Code Block
{
  "accountNumber": "9500508176491773011"
}
Code Block
{
    "accountOrCardNumber": "9500508176491773011"
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

PUT → /v1/balances/transfers

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza una transferencia - Número de cuenta Activa

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza una transferencia - Número de cuenta Inactiva

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Realiza una transferencia - Número de cuenta Expirada

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

PUT → /v1/balances/transfers

Descripción

Request

Response

HTTP Codes

GRPC Codes

Realiza una transferencia

.

- Número de cuenta Bloqueada

Code Block
{
  "transactionData": {
    "transactionAmount":
1
1000,
    "actionCode": "
8012
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": "
9500501545918394337
9500508176491773011", 
  "operationType": "
W
D"
 }
Code Block
{
    
"historyDate": "2023-09-
08
18",
    
"historyTime": "
122250
164818",
    
"transactionData": {

        "transactionCode": "
8012
8000",
"transactionDescription": "P2P RECIEVER", "currentBalance": "-2122495", 

        "openToBuy": "
2122546
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
"9500501520328494829",
    "
accountMakerDateOfBirth
customerNumber": "0995000000000035249",
    "
availableCredit
blockCode1":
0
"M",
    "
userAmounts9
blockCode1Date":
0
"2023-09-07",
    "
userAmounts10
blockCode2":
0
"M",
    "
userAmounts7
blockCode2Date":
0
"2023-08-11",
}
}

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
 "accountMakerDateOfBirth": "
9500501520328494829
",
} Code Block{
    "
accountOrCardNumber
availableCredit":
"9500501520328494829"
0,
    "
currentBalance
userAmounts9":
998176210159
0,
    "
availableCreditLimit
userAmounts10":
32237425576994724
0,
    "
frozenBalance
userAmounts7": 0
26000
  }
}

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

Sincroniza el mirror

Realiza la consulta de balance

con la información

de

Fiserv

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

Realiza una transferencia .

Code Block{ "transactionData": { "transactionAmount": 1, "actionCode": "8012", "authorizationCode": "311S3q",

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

Code Block
{
  "
effectiveDate
accountNumber": "
2023-06-21
9500501520328494829"
,


}
Code Block
{
  "
description
accountOrCardNumber": "
P2P
9500501520328494829",

  
"
paidConcept
currentBalance":
"test"
998176210159,

  "
memoPostedIndicator
availableCreditLimit":
"qqq"
32237425576994724,

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

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", 
"operationType": "W"
  },
  "
actionCode
xTransactionId": "
8008
123",

  "
transactionDescription
accountNumber": "
P2P_TRANSFER_SOURCE
9500501545918394337"
,

}
Code Block
{
  
"
description
historyDate": "
P2P_TRANSFER_SOURCE
2023-09-12",

  "
authorizationCode
historyTime": "
1234
111208"
}
,
  "
to
transactionData": {
    "
accountNumber
transactionCode": "
9500502030236002994
8012",
    "
actionCode
transactionDescription": "
8012
P2P RECIEVER",
    "
transactionDescription
currentBalance": "
P2P_TRANSFER_TARGET
-2122495",
    "
description
openToBuy": "2122548"
P2P_TRANSFER_SOURCE", 

  }
}

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
{
  "
authorizationCode
from":
"1234"
{
}, 
  "
effectiveDate
accountNumber": "
2022-01-30
9500508496924050930",
    "
transactionAmount
actionCode":
100
"8008",
    "
device
transactionDescription": "
abcfghjfghjklghjkfghjk5678956789
P2P_TRANSFER_SOURCE",
    "
ip
description": "
198.162.123.148
P2P_TRANSFER_SOURCE",
    "
latitude
authorizationCode":
123.56565656, "longitude": -23.565656, 
"1234"
  },
  "
xTransactionId
to": {
"123"
} Code Block{
   "
effectiveDate
accountNumber": "
2022-01-30
9500502030236002994",
    "
transactionAmount
actionCode": "
100
8012",
"actionOutputArea": {

    "
actionData
transactionDescription":
[ 
"P2P_TRANSFER_TARGET",
{ 
"description": "P2P_TRANSFER_SOURCE",
    
"authorizationCode": "1234"
,

  
},
    "
accountNumber
effectiveDate": "
9500508496924050930
2022-01-30",
    "transactionAmount": 100,
    "
transactionDescription
device": "
P2P SENDER
abcfghjfghjklghjkfghjk5678956789",

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

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{
 "authorizationCode": "1234",
        "
transactionData
accountNumber":
{
 "9500502030236002994",
        "
transactionAmount
transactionDescription":
20,
 "P2P RECIEVER",
        "
actionCode
feeAmount": "
8038
0",
        "
authorizationCode
transactionCode":
"Q1er44"
8012,
        "
effectiveDate
currentBalance":
"2022-08-24",
-169434,
        "
description
creditLimit":
"QR code test - normal hours",
0,
        "
paidConcept
openToBuy":
"Hello"
17133400,
        "
memoPostedIndicator
authorizationNumber": "
332272"
,
"suppressMonetaryTransaction":
"Y",
 }
"n1n2ByPass": "N",
 ]
"identifier": 0, "box": "1",
}
}

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": {
    "
crPlaza
transactionAmount":
"10MON"
20,
    "
crStore
actionCode": "
50WHN
8038",
    "
keyTracking
authorizationCode": "
Hello
Q1er44",
    "
beneficiaryAccount
effectiveDate": "
Hello
2022-08-24",
    "
senderAccount
description": "
Hello",
QR code test - normal
"counterpartInstitution": "Hello"
hours",
    "
operatingInstitution
paidConcept": "Hello",
    "
frcUprkBeneficiary
memoPostedIndicator":
"Hello
"
,
"orderingFrcUprk
"
: "Hello"
,
    "
device
suppressMonetaryTransaction": "
123456789-123456789-123456789-12
Y",
    "
ip
n1n2ByPass": "
198.162.200.200
N",
    "
latitude
identifier":
-109.699, "longitude": 23.062
0,
    "
recipientName
box": "
Hello
1",
    "
orderingName
crPlaza": "
Hello
10MON",
    "
paymentSourceId
crStore": "
bf0469d7-b507-44d6-af7d-d4edea6340f1" 
50WHN",
},
   "
xTransactionId
keyTracking": "
123
Hello",
    "
accountNumber
beneficiaryAccount": "
9500508020127353147
Hello",
} Code Block{
   "
historyDate
senderAccount": "
2023-09-12
Hello",
    "
historyTime
counterpartInstitution": "
111311
Hello",
    "
transactionData
operatingInstitution":
{
"Hello",
    "
transactionCode
frcUprkBeneficiary": "
8038
Hello",
    "
transactionDescription
orderingFrcUprk": "
CASHOUT WITH QR-CODE(FREE BAL)
Hello",
    "
currentBalance
device": "123456789-
1382946
123456789-123456789-12",
    "
openToBuy
ip": "
1382326"
198.162.200.200",
} }

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
 "latitude": -109.699,
    "longitude": 23.062,
    "recipientName": "Hello",
    "
cardSequence
orderingName":
2147483647
"Hello",
    "
foreignUse
paymentSourceId":
0 } Code Block{ "postToAccount
 "bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "
9500508261544464147
123",
  
"
blockCode
accountNumber": "
Z", "cardNumber
9500508020127353147"
}
Code Block
{
  "historyDate": "
***************0252", "currentCardActivation
2023-09-12",
  "historyTime": "
N
111311",
  
"
dateBlock
transactionData":
"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
transactionCode": "
Z
8038",
    "
panToken
transactionDescription": "
0004217470885923553
CASHOUT WITH QR-CODE(FREE BAL)",
    "
cardSequence
currentBalance":
1,
"-1382946",
    "
functionCode
openToBuy": "
B" //B para bloquear - u Desbloquear }
Code Block
{}
200
1382326"
  }
}

0 OK: Solicitud exitosa.

400500

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

401: Apy Key no válida.

13 Internal Server Error: Servicios no disponibles.

...

Card

Account Adapter

Info

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

...

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

GRPC

HTTP Codes

Realiza la consulta de bloqueos de cuenta.

Obtener cuenta mediante Pantoken

Code Block
{
  "
accountNumber
panToken": "
9500501520328494829" } Code Block{ "accountData": { "accountNumber": "9500501520328494829", 
0004217470595215803",
  "
customerNumber
cardSequence":
"0995000000000035249"
2147483647,

  "
blockCode1
foreignUse":
"M", "blockCode1Date": "2023-09-07", "blockCode2": "M", "blockCode2Date": "2023-08-11", "accountMakerDateOfBirth
0
}
Code Block
{
	"postToAccount": "9500508261544464147",
"availableCredit
	"blockCode":
0
"Z",
"userAmounts9
	"cardNumber":
0, "userAmounts10": 0, "userAmounts7": 0 } }0 OK
"***************0252",
	"currentCardActivation": "N",
	"dateBlock": "2023-09-04"
}

200: Solicitud exitosa.

3 Bad Request

400: Request con campos no válidos.

13 Internal Server Error

401: Apy Key no válida.

500: Servicios no disponibles.

...

PUT → /v1/cards/embossers/block

Descripción

Request

Response

GRPC

HTTP Codes

Realiza bloqueos/desbloqueo de cuenta.

Bloqueo de tarjetas

Code Block
{ "blockCode": "",
{
  "
blockCodeIndicator
blockCode":
1, 
 "
foreignUse
Z"
: 0
,
  "
functionCode
panToken": "
U
0004217470885923553",
  "
accountNumber
cardSequence":
"9500501520328494829" } Code Block{
1,
  "functionCode": "B"
,
 //B para
"accountNumber": "9500501520328494829", "blockCode1Local": "M", "localOrganization": 950 }0 OK
bloquear - u Desbloquear
}
Code Block
{}

200: Solicitud exitosa.

3 Bad Request

400: Request con campos no válidos.

13 Internal Server Error

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

una transferencia

la consulta de bloqueos de cuenta.

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

}
Code Block
{
  
"
actionCode
accountData":
"8012",
{
    "
authorizationCode
accountNumber": "
311S3q
9500501520328494829",
    "
effectiveDate
customerNumber": "
2023-06-21
0995000000000035249",
    "
description
blockCode1": "
P2P
M",
    "
paidConcept
blockCode1Date": "
test", "memoPostedIndicator": "qqq", "suppressMonetaryTransaction": "qqq", "n1n2ByPass": "qqq", "identifier": "S_IN", "box": "3
2023-09-07",
    "
crPlaza
blockCode2": "
10MON
M",
    "
crStore
blockCode2Date": "
50WHN
2023-08-11",
    "
keyTracking
accountMakerDateOfBirth": "
KEYTRACKING0123456789
",
    "
senderAccount
availableCredit":
"senderAccount012345"
0,
    "
beneficiaryAccount
userAmounts9":
"beneficiaryAccount1"
0,
    "
counterpartInstitution
userAmounts10":
"aaaaa"
0,
    "
operatingInstitution
userAmounts7":
"bbbbb",
0
  }
"frcUprkBeneficiary
}

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

  "
orderingFrcUprk
blockCodeIndicator":
"orderingFrcUp"
1,

  "
device
foreignUse":
"123456789-123456789-123456789-12", 
0,
  "
ip
functionCode": "
198.162.200.200
U",

  "
latitude
accountNumber":
-109.699, 
"9500501520328494829"
}
Code Block
{
  "
longitude
functionCode":
23.062, 
"B",
  "
recipientName
accountNumber": "
recipientName01234567890123456
9500501520328494829",

  
"
orderingName
blockCode1Local": "
orderingName012345678901234567
M",
  "localOrganization": 950
"paymentSourceId": "paymentSourceId012345" },
}

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,
    "
xTransactionId
actionCode": "
123
8012",
    "
accountNumber
authorizationCode": "
9500501545918394337
311S3q",
} Code Block{
   "
historyDate
effectiveDate": "2023-
09
06-
12
21",
    "
historyTime
description": "
111208
P2P",
    "
transactionData
paidConcept":
{
"test",
    "
transactionCode
memoPostedIndicator": "
8012
qqq",
    "
transactionDescription
suppressMonetaryTransaction": "
P2P RECIEVER
qqq",
    "
currentBalance
n1n2ByPass": "
-2122495
qqq",
    "
openToBuy
identifier": "
2122548
S_IN",
}
}

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": {
 "box": "3",
    "
accountNumber
crPlaza": "
9500508496924050930
10MON",
    "
actionCode
crStore": "
8008
50WHN",
    "
transactionDescription
keyTracking": "
P2P_TRANSFER_SOURCE
KEYTRACKING0123456789",
    "
description
senderAccount": "
P2P_TRANSFER_SOURCE
senderAccount012345",
    "
authorizationCode
beneficiaryAccount": "
1234
beneficiaryAccount1",
},
  
"
to
counterpartInstitution":
{
"aaaaa",
    "
accountNumber
operatingInstitution": "
9500502030236002994
bbbbb",
    "
actionCode
frcUprkBeneficiary": "
8012
frcUprkBenefi",
    "
transactionDescription
orderingFrcUprk": "
P2P_TRANSFER_TARGET
orderingFrcUp",
    "
description
device": "
P2P_TRANSFER_SOURCE
123456789-123456789-123456789-12",
    "
authorizationCode
ip": "
1234" }
198.162.200.200",
    "
effectiveDate
latitude":
"2022-01-30"
-109.699,
    "
transactionAmount
longitude":
100
23.062,
    "
device
recipientName": "
abcfghjfghjklghjkfghjk5678956789
recipientName01234567890123456",
    "
ip
orderingName": "
198.162.123.148
orderingName012345678901234567",
    "
latitude
paymentSourceId":
123.56565656,
"paymentSourceId012345"
  },
  "
longitude
xTransactionId":
-23.565656, 
"123",
  "
xTransactionId
accountNumber": "
123
9500501545918394337"
}
Code Block
{
  "
effectiveDate
historyDate": "
2022
2023-
01
09-
30
12",
  "
transactionAmount
historyTime": "
100
111208",
  "
actionOutputArea
transactionData": {
    "
actionData
transactionCode":
[
"8012",
    "transactionDescription": "P2P
{
RECIEVER",
    
"
authorizationCode
currentBalance": "
1234
-2122495",
    
"
accountNumber
openToBuy": "
9500508496924050930
2122548"
,
"transactionDescription": "P2P SENDER", 
}
}

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

    
"
transactionCode
actionCode": "8008",

    
"
currentBalance
transactionDescription":
-5988391, 
"P2P_TRANSFER_SOURCE",
    "
creditLimit
description":
0,
"openToBuy": 598649100
"P2P_TRANSFER_SOURCE",
    
"
authorizationNumber
authorizationCode": "
507925
1234"

  },
{ 
"to": {
    "
authorizationCode
accountNumber": "
1234
9500502030236002994",
    
"
accountNumber
actionCode": "
9500502030236002994
8012",

    
"transactionDescription": "P2P
RECIEVER
_TRANSFER_TARGET",

    "
feeAmount
description": "
0", 
P2P_TRANSFER_SOURCE",
    "
transactionCode
authorizationCode":
8012,
"1234"
  
},
    "
currentBalance
effectiveDate":
-169434, 
"2022-01-30",
    
"
creditLimit
transactionAmount":
0
100,

    "
openToBuy
device":
17133400, 
"abcfghjfghjklghjkfghjk5678956789",
    "
authorizationNumber
ip": "
332272"
198.162.123.148",
    "latitude": 123.56565656,
}
    "longitude": -23.565656,
]
} }

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.
 "xTransactionId": "123"
}
Code Block
{
  "
transactionData
effectiveDate":
{
"2022-01-30",
  "transactionAmount": "100",
  "
transactionAmount
actionOutputArea":
20,
{
    "
actionCode
actionData":
"8038",
 [
      {
        "authorizationCode": "
Q1er44
1234",
        "
effectiveDate
accountNumber": "
2022-08-24
9500508496924050930",
        "
description
transactionDescription": "
QR
P2P
code
SENDER",
test
-
normal
hours",
     "
paidConcept
feeAmount": "
Hello
0",
        "
memoPostedIndicator
transactionCode":
" ",
8008,
        "
suppressMonetaryTransaction
currentBalance":
"Y",
-5988391,
        "
n1n2ByPass
creditLimit":
"N",
0,
        "
identifier
openToBuy":
0
598649100,
        "
box
authorizationNumber": "
1
507925"
,
"crPlaza": "10MON"
 },
"crStore": "50WHN",
  {
"keyTracking":
"Hello",
     "
beneficiaryAccount
authorizationCode": "
Hello
1234",
        "
senderAccount
accountNumber": "
Hello
9500502030236002994",
        "
counterpartInstitution
transactionDescription": "
Hello
P2P RECIEVER",
        "
operatingInstitution
feeAmount": "
Hello
0",
        "
frcUprkBeneficiary
transactionCode":
"Hello",
8012,
        "
orderingFrcUprk
currentBalance":
"Hello"
-169434,
        "
device
creditLimit":
"123456789-123456789-123456789-12",
0,
"ip":
 "
198.162.200.200",
openToBuy": 17133400,
        "
latitude
authorizationNumber":
-109.699,
"332272"
"longitude":
23.062,
 }
"recipientName": "Hello",
 ]
  }
}

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
{
  "
orderingName
transactionData":
"Hello",
{
    "
paymentSourceId
transactionAmount":
"bf0469d7-b507-44d6-af7d-d4edea6340f1" 
20,
},
   "
xTransactionId
actionCode": "
123
8038",
    "
accountNumber
authorizationCode": "
9500508020127353147
Q1er44",
} Code Block{
   "
historyDate
effectiveDate": "
2023
2022-
09
08-
12
24",
    "
historyTime
description": "
111311", "transactionData": {
QR code test - normal hours",
    "
transactionCode
paidConcept": "
8038
Hello",
    "
transactionDescription
memoPostedIndicator": "
CASHOUT WITH
QR-CODE(FREE BAL)
",
    "
currentBalance
suppressMonetaryTransaction": "
-1382946
Y",
    "
openToBuy
n1n2ByPass": "
1382326
N",
} }

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{
"identifier": 0,
    "
accountNumber
box": "
9500501520328494829
1",
} Code Block{
   "
accountOrCardNumber
crPlaza": "
9500501520328494829
10MON",
    "
currentBalance
crStore":
998176210159
"50WHN",
    "
availableCreditLimit
keyTracking":
32237425576994724
"Hello",
    "
frozenBalance
beneficiaryAccount": "Hello",
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{
    "senderAccount": "Hello",
    "
logo
counterpartInstitution": "
60
Hello",
    "
address
operatingInstitution": "
Ciruelas
Hello",
    "
houseNumber
frcUprkBeneficiary": "
12345
Hello",
    "
externalNumber
orderingFrcUprk": "
8007
Hello",
    "
colony
device": "
Lomas
123456789-123456789-123456789-12",
    "
city
ip": "
Lomas de Alvarez"
198.162.200.200",
    "latitude": -109.699,
    "longitude": 23.062,
    "
state
recipientName": "
COL
Hello",
    "
postalCode
orderingName": "
99980
Hello",
    "
dateOfBirth
paymentSourceId": "
2000-08-06", 
bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "123",
  "
stateOfBirth
accountNumber": "
CDMX
9500508020127353147"
,


}
Code Block
{
  "
email
historyDate": "
lmedina@palo-it.com
2023-09-12",

  "
firstName
historyTime": "
Judith
111311",
  
"
lastName
transactionData":
"Medina",
{
    "
maternalLastName
transactionCode": "
Ruiz
8038",
    "
mobilePhoneNumber
transactionDescription": "
5521163588
CASHOUT WITH QR-CODE(FREE BAL)",
    "
identificationNumber
currentBalance": "
4152554487415113698
-1382946",
    "
ine
openToBuy": "
1234117890099
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
{
  "
occupation
accountNumber": "
Tester
9500501520328494829"
,


}
Code Block
{
  "
genderCode
accountOrCardNumber": "
1
9500501520328494829",

  "
user4
currentBalance":
"1"
 998176210159,

  
"
identificationNumberFlag
availableCreditLimit":
"2" } Code Block{ 
32237425576994724,
  "
customerNumber
frozenBalance":
"0995000000000080589"
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

Actualizar

Creación del cliente

Code Block{ "email": "lmedina@palo-it.com", "numberType": 1,

Code Block
{
    "
customerNumber
logo": "
0995000000000077863
60",
    "address": "Ciruelas",
    "
dateOfBirth
houseNumber": "
1999-02-06
12345",
    "
city
externalNumber": "
Villa de Alvarez
8007",
    "
countryCode
colony": "
MEX
Lomas",
    "
county
city": "
CDMX
Lomas de Alvarez",
    "
colony
state": "
ADOLFO LOPEZ MATEOS
COL",
    "
externalNumber
postalCode": "
1007
99980",
    "
firstName
dateOfBirth": "
Sandra
2000-08-06",
    "
genderCode
stateOfBirth":
2
"CDMX",
    "
houseNumber
email": "
123
lmedina@palo-it.com",
    "
ine
firstName": "
1234117890099
Judith",
    "lastName": "
Velasco
Medina",
    "
maritalStatus
maternalLastName":
0
"Ruiz",
    "
maternalLastName
mobilePhoneNumber": "
Medina
5521163588",
    "
middleName
identificationNumber": "
Rosa
4152554487415113698",
    "
mobilePhoneIndicator
ine":
1
"1234117890099",
    "
mobilePhoneNumber
occupation": "
31211635899
Tester",
    "
occupation
genderCode": "
NURSE
1",
    "
ownOrRentResidenceFlag
user4":
0, "postalCode": 54070
"1",
    "
stateOfBirth
identificationNumberFlag": "
DF
2"
}
Code Block
{
    "
outputArea
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
{
    
"
customerNumber
email": "
0995000000000077863
lmedina@palo-it.com",

    "
accountNumber
numberType":
"0995000000000077863"
1,
    
"
responseCode
customerNumber": "0995000000000077863",

    
"
level
address": "Ciruelas",
    
"
transactionAmount
dateOfBirth":
0, 
"1999-02-06",
    "
countryLimit
city":
{
"Villa 
de Alvarez",
    "
dailyLimitLoad
countryCode":
0
"MEX",
    "county": "CDMX",
    
"
monthlyLimitLoad
colony":
0,
"ADOLFO LOPEZ MATEOS",
    "externalNumber": "1007",
    "
dailyLimitCash
firstName":
0
"Sandra",
    "genderCode": 2,
    
"
monthlyLimitCash
houseNumber":
0
"123",
    
"ine": "1234117890099",
    "
limitForDepositTransactions
lastName":
0
"Velasco",
}, 
"maritalStatus": 0,
    "
accountLimit
maternalLastName":
{
"Medina",
    "middleName": "Rosa",
    
"
accountDailyAmountLoad
mobilePhoneIndicator":
0
1,
    
"mobilePhoneNumber": "31211635899",
    
"
accountMonthlyAmountLoad
occupation":
0
"NURSE",

    
"ownOrRentResidenceFlag": 0,
    "
accountDailyAmountCash
postalCode":
0
54070,
    "stateOfBirth": "DF"
}
Code Block
{
    
"
accountMonthlyAmountCash
outputArea": {
0
}
"customerNumber": "0995000000000077863",
}
}

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
0995000000000077863",
"alternateCustomer":
{
     "
expirationDate
responseCode": "
2023-08-22"
",
},
   "
customerNumber
level": "
0995000000000075954
",
"qualification": "2",
     "
customerTypeIndicator
transactionAmount": 0,
        "
foreignUseIndicator
countryLimit":
0 } Code Block{
 {
            "
customerNumber
dailyLimitLoad":
"0995000000000045697",
0,
            "
accountNumber
monthlyLimitLoad":
"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 → /v1/cards/embosser

Descripción

Request

Response

HTTP Codes

Add a new card to account

Code Block{
0,
            "
addressLine1
dailyLimitCash":
"1"
0,
"addressLine2":
"2",
"assignedSpendingLimits":
{
     "
maximumSpendingLimit
monthlyLimitCash":
3,
0,
            "
spendingFrequency
limitForDepositTransactions":
4,
0
"spendingTransaction":
5
   },
        "
atmCashAmount
accountLimit":
6,
{
            "
atmCashNumber
accountDailyAmountLoad":
7
0,
"atmCashSingleTransactionLimit
          "accountMonthlyAmountLoad":
8
0,
"authorizationCriteriaTableNumber": "9",
"authorizationSpendingLimitTable":
"10",
   "
blockCode
accountDailyAmountCash":
"11"
0,
"branchNumber": 12,
"cardAction":
13,
   "
cardActionReasonCode
accountMonthlyAmountCash":
"14",
0
"cardDelayDays":
15,
"panToken":
"16",
 }
"cardSequence":
17,
"cardholderAffiliationGroupId": "18", "cardholderFlag
}
}

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": "
19
9500505675946730065",
  "
city
alternateCustomer":
"20",
  {
"currentCardActivation":
"21",
   "
customerNumber
expirationDate": "2023-08-22"
, "deliveryOption": 23

  },
  "
deviceIndicator
customerNumber": "
24
0995000000000075954",
  "
embossedName1
qualification": "
25
2",
  "
embossedName2
customerTypeIndicator":
"26"
0,
  "
enrollmentStatusVBV
foreignUseIndicator":
"27",
 0
}
Code Block
{
    "
expirationDate
customerNumber": "
28
0995000000000045697",
    "
firstIssueBranch
accountNumber":
29,
 "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
{
  "
internetPurchaseAmount
cardNumber":
30, 
 "
internetPurchaseNumber
0004217470072001676"
: 31,

}
Code Block
{
"internetPurchaseSingleTransactionLimit":
32, 
 
"
languageCode
accountNumber": "
33
0004217470072001676"
, "maximumAuthorizationFrequency": 34, "name1": "35", "name1TypeIndicator": 36, "name2": "37", "name2TypeIndicator": 38

}

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",
  "
nextCardExpirationDate
cardNumber": "
39
0004217470969640887",
  "
numberOfCardsRequested
cardholderType":
40,
 1
}
Code Block
{
    "
overTheCounterCashAmount
cardNumber":
42,
"***************4568",
    "
overTheCounterCashNumber
customerOrAccountNumber":
43, 
"
overTheCounterCashSingleTransactionLimit": 44,
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
{
  "
pinMailerDelayDays
panToken":
45
"0004217470595215803",
  "
pinOffset
cardSequence":
46
2147483647,
  "
pinSuppression
foreignUse":
47, "plasticId
0
}
Code Block
{
	"postToAccount": "
48
9500508261544464147",

	"
posServiceCode
blockCode":
49
"Z",

	"
accountNumber
cardNumber": "
50
***************0252",

	"
postalCode
currentCardActivation":
51
"N",

	"
processType
dateBlock":
52, 
 "
programId": 53, "reissueDeliveryOption": 54,
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
{
  "
requestedCardType
panToken": "
55
0004217470595215803",
  "
retailPurchaseAmt
cardSequence":
56
1,
  "
retailPurchaseNumber
foreignUse":
57, "retailPurchaseSingleTransactionLimit": 58,
1
}
Code Block
{
    "
securedCodeActivate
postToAccount":
59
"9500507060523627372",
    "
stateOrProvince
blockCode": "
60
Z",
    "
typeCardMailer
cardNumber": "
61
***************0252",
    "
typeOfCard
currentCardActivation": "
62
N",
"user1": 63,
  
"
user2
dateBlock":
64, "user3": 65, "user4": 66,
"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 Expirado

Code Block
{
  "
user5
panToken":
67, 
 "
user6
0004217470200073271"
: 68
,
  "
user7
cardSequence":
69
1,
  "
user8
foreignUse":
70, 
1
}
Code Block
{
"userDate1":
"71",
  
"
userDate2
postToAccount": "
72
9500507060523627372",
"vbvPassword":
"73",
   "
visaMiniIndicator
cardNumber": "
74
***************8578",
"visaPlusIndicator": "75" } Code Block{
   "
panToken
currentCardActivation": "
0004217470595215803
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

Obtener cuenta mediante Pantoken

Bloqueo de tarjetas - Bloqueo

Code Block
{
  "
panToken
blockCode": "
0004217470595215803
Z",
  "
cardSequence
panToken":
2147483647, 
 "
foreignUse
0004217470885923553"
:
,
0
} Code Block{
 
"
postToAccount
cardSequence":
"9500508261544464147"
1,
"blockCode":
"Z",
 
"
cardNumber
functionCode": "
***************0252", "currentCardActivation": "N", "dateBlock": "2023-09-04" }
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.

POST → /v1/cards/embosser/block

Descripción

Request

Response

HTTP Codes

Bloqueo de tarjetas - Desbloqueo

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

...