...
Note |
---|
IMPORTANTE: El servicio de Aggregation es el que se usarán para las pruebas correspondientes en ambientes de QA y ST: Account + Customer en Genesys Card en Spin |
Detalle de endpoints
Table of Contents |
---|
minLevel | 1 |
---|
maxLevel | 6 |
---|
outline | false |
---|
type | list |
---|
printable | false |
---|
|
Ejemplo body:
El detalle que se muestra es el camino deseado (happy path) de los endpoints desarrollados.
El código esperado es un 200 + un body, en estos casos
Ejemplo de body - EnableToken (POST /tokens/key):
Body - Request
{
"deviceId": "15703c1c-352a-11ee-be56-0242ac120002",
"keyId": "05616256-352a-11ee-be56-0242ac120002",
"publicKey": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCR9+qdg/HrRLzgkbphCnQpN+NscOEY8vQO/M+/U4erX3ZK9IcV9MulLyY4faIBV2LeJpeUDzemFygjz/e+as6gKjbrJ7jHldl0stpfyUv6Se5iwC2wunevURLjnyk31Af9QtJr5KGsNrtyVzNYis92LGUY64tHEVNoL6DmrD/JJwIDAQAB",
"publicKeyAlgorithm": "RSA"
}
Panel |
---|
panelIconId | atlassian-note |
---|
panelIcon | :note: |
---|
bgColor | #FFBDAD |
---|
|
Body - Response { "seed": "PGh9l4M6kfEWQPSAlB2ELD9p1GTMZ/lQSzkBg2n/lhTOsZtNh2lvhoRkCCBnsGuZgjBGPIfHFye3yi/b5YUKl+2CA673Fg66WruKTU58ywk/rZYUKXOku2NI8PliZG9P9/nrgrZ75D5SxsuUv0DIj8A0WfdYu16PLFnH4MGhD6A=" } |
Mirror
Account
Info |
---|
Consulta de bloqueos Repositorio sincronizado con Fiserv Disminuye peticiones al Proveedor |
GetAccountDetails
...
Descripción
...
Request
...
Response
...
HTTP Codes
...
GRPC Codes
Aggregation
Estos son los componentes que se estarán usando para la ejecución de pruebas en el proyecto:
Account Aggregation Service
Info |
---|
Incorpora los servicios de Account Mirror y Balance Mirror Validación de campos mandatorios antes del envío a Fiserv Expone endpoints a través de un API REST y gRPC |
POST → /v1/accounts/details
Descripción | Request | Response | HTTP Codes | GRPC Codes |
---|
Realiza la consulta de bloqueos de cuenta Activa | Code Block |
---|
{
"accountNumber": "9500507060523627372"
} |
| Code Block |
---|
{
"accountData": {
"accountNumber": "9500507060523627372",
"customerNumber": "0995000000000078206"
}
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
Realiza la consulta de bloqueos de cuenta |
.Inactiva | Code Block |
---|
{
"accountNumber": " |
|
9500501520328494829 | Code Block |
---|
{
"accountData": {
"accountNumber": " |
|
95005015203284948299500501403742215502",
"customerNumber": " |
|
09950000000000352490995000000000080639",
"blockCode1": " |
|
MU",
"blockCode1Date": "2023-09- |
|
07MX",
"blockCode2Date": "2023- |
|
08-11",
"accountMakerDateOfBirth": "",
"availableCredit": 0,
"userAmounts9": 0,"userAmounts10": 0,
"userAmounts7": 0
OK Bad Request: Request con campos no válidos. |
500 Internal Server Error401: 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. |
SetAccountBlock
DescripciónRealiza bloqueos/desbloqueo de cuenta.Request | Response | HTTP Codes | GRPC Codes | Realiza la consulta de bloqueos de cuenta Expirada | |
blockCode",blockCodeIndicator1,"foreignUse": 0,
"functionCode":"U",9500501520328494829} Code Block |
{"functionCode":"B",accountNumber9500501520328494829,
"blockCode1Local":"M","localOrganization": 950
OK Bad Request: Request con campos no válidos. |
500 Internal Server ErrorDescripción | Request | Response | HTTP Codes | GRPC Codes |
Sincroniza el mirror de account con la información de Fiserv.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. |
SynchronizeMirrorAccount
Realiza la consulta de bloqueos de cuenta Bloqueada | Code Block |
---|
{
"accountNumber": " |
|
9500501520328494829 | Code Block |
---|
{
"accountData": {
"accountNumber": " |
|
95005015203284948299500509377699205330",
"customerNumber": " |
|
09950000000000352490995000000000080636",
"blockCode1": " |
|
MZ",
"blockCode1Date": "2023-09- |
|
07",
"blockCode2": "M",
"blockCode2Date": "2023-08-11",
"accountMakerDateOfBirth": "","availableCredit": 0,
"userAmounts9": 0,
"userAmounts10": 0,
"userAmounts7": 0
OK Bad Request: Request con campos no válidos. |
500 Internal Server Error401: 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. |
Balance
Info |
---|
Consulta de balance Repositorio sincronizado con Fiserv Disminuye peticiones al Proveedor |
GetAccountBalance
Descripción | Request | Response | 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"
} |
| |
accountOrCardNumber9500501520328494829currentBalance998176210159availableCreditLimit32237425576994724frozenBalance26000 OK Bad Request: Request con campos no válidos. 401: Apy Key no válida. 500 |
Internal Server ErrorDescripción | Request | Response | HTTP Codes | GRPC Codes |
Sincroniza el mirror de balance con la información de Fiserv.: Servicios no disponibles. | 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
SynchronizeMirrorBalance
Realiza bloqueos/desbloqueo de cuenta - Bloquear (foreignUse= 1) | Code Block |
---|
{
"blockCode": "U",
"blockCodeIndicator": 0,
"foreignUse": 1,
"functionCode": "B",
"accountNumber": "9500501520328494829"
} |
| |
accountOrCardNumber9500501520328494829currentBalance998176210159"availableCreditLimit":32237425576994724,
frozenBalance26000 OK Bad Request: Request con campos no válidos. 401: Apy Key no válida. 500 |
Internal Server ErrorDescripción | Request | Response | HTTP Codes | GRPC Codes |
---|
Realiza una transferencia . | : Servicios no disponibles. | 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
TransferBalance
Realiza bloqueos/desbloqueo de cuenta - Desbloquear | |
transactionData {
transactionAmount: 1
actionCode"8012"
authorizationCode"311S3q" effectiveDate2023-06-21
descriptionP2P",paidConcepttestmemoPostedIndicatorqqqsuppressMonetaryTransactionqqqn1n2ByPass"qqq",
"identifier": "S_IN",
"box": "3",
"crPlaza": "10MON | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
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",
" |
|
crStore50WHNkeyTrackingKEYTRACKING0123456789123456789-123456789-123456789-12",
" |
|
senderAccountsenderAccount012345beneficiaryAccount"beneficiaryAccount1"-109.699,
"longitude": 23.062,
" |
|
counterpartInstitutionaaaaarecipientName01234567890123456",
" |
|
operatingInstitutionbbbbborderingName012345678901234567",
" |
|
frcUprkBeneficiaryfrcUprkBenefipaymentSourceId012345"
},
"xTransactionId": "123",
" |
|
orderingFrcUprkorderingFrcUp9500508152383529456",
"operationType": "D"
} |
| |
device123456789123456789123456789-12ip198.162.200.200latitude -109.699,longitude23.062,recipientNamerecipientName01234567890123456orderingNameorderingName012345678901234567",
| 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 | |
paymentSourceId "paymentSourceId012345",operationType"W"
},xTransactionId123accountNumber9500501545918394337} Code Block |
{historyDate0912historyTime111208"transactionData":{ transactionCode8012transactionDescriptionP2P RECIEVERcurrentBalancesuppressMonetaryTransaction": " |
|
-2122495"openToBuy": "2122548"
}
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 | HTTP Codes | GRPC Codes |
---|
Realiza una transferencia P2P. | Code Block |
{
"from": {"n1n2ByPass": "qqq",
"identifier": "S_IN",
"box": "3",
" |
|
accountNumber9500508496924050930actionCode8008transactionDescriptionP2P_TRANSFER_SOURCEKEYTRACKING0123456789",
" |
|
descriptionP2P_TRANSFER_SOURCEauthorizationCode1234 } "counterpartInstitution": "aaaaa",
" |
|
to {accountNumber9500502030236002994actionCode8012transactionDescriptionP2P_TRANSFER_TARGET123456789-123456789-123456789-12",
" |
|
descriptionP2P_TRANSFER_SOURCEauthorizationCode"1234"
}effectiveDate"2022-01-30"transactionAmount100"recipientName01234567890123456",
" |
|
deviceabcfghjfghjklghjkfghjk5678956789orderingName012345678901234567",
" |
|
ip198.162.123.148",paymentSourceId012345"
},
" |
|
latitude.56565656
longitude-23.565656 xTransactionId123effectiveDate20220130transactionAmount100actionOutputArea"actionData":[ {"transactionCode": "8000",
|
|
authorizationCode1234",
| 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. | |
accountNumber"9500508496924050930", transactionDescriptionP2P SENDER
feeAmount0
transactionCode 8008,
"currentBalance": -5988391 creditLimit 0,
openToBuy": 598649100 authorizationNumber507925
{
authorizationCode"1234",
{
"accountNumber": "9500502030236002994",
"actionCode": "8012",
"transactionDescription": "P2P |
|
RECIEVER_TRANSFER_TARGET",
"description": "P2P_TRANSFER_SOURCE",
" |
|
feeAmount0, transactionCode8012,"2022-01-30",
"transactionAmount": 100,
" |
|
currentBalance-169434"abcfghjfghjklghjkfghjk5678956789",
"ip": "198.162.123.148",
" |
|
creditLimit0123.56565656,
"longitude": -23.565656,
" |
|
openToBuy17133400,
"authorizationNumber | Code Block |
---|
{
"effectiveDate": "2022-01-30",
"transactionAmount": " |
|
332272100",
"actionOutputArea": {
"actionData": [
{
|
|
}
]
}
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 | 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" "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,
" |
|
crPlaza10MONcrStore50WHNkeyTrackingHellobeneficiaryAccountHello", "senderAccount": "HellocounterpartInstitutionoperatingInstitutionHellofrcUprkBeneficiarysuppressMonetaryTransaction": " |
|
HelloorderingFrcUprkHellodevice"123456789-123456789-123456789-12"ip198.162.200.200latitude-109.699longitude23.062recipientNameorderingNamebeneficiaryAccount": "Hello",
" |
|
paymentSourceIdbf0469d7-b507-44d6-af7d-d4edea6340f1"
},xTransactionIdcounterpartInstitution": " |
|
123accountNumber9500508020127353147} Code Block |
{historyDate2023-09-12historyTime111311
"transactionData": {transactionCode8038123456789-123456789-123456789-12",
" |
|
transactionDescriptionCASHOUT WITH QR-CODE(FREE BAL)currentBalance"1382946"openToBuy"1382326"
}
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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": 023.062,
"recipientName": "Hello",
"orderingName": "Hello",
"paymentSourceId": "bf0469d7-b507-44d6-af7d-d4edea6340f1"
},
"xTransactionId": "123",
"accountNumber": "9500508020127353147"
} |
| |
postToAccounthistoryDate": "2023-09-08",
"historyTime": " |
|
9500508261544464147"blockCode"transactionData": {
"transactionCode": " |
|
ZcardNumbertransactionDescription": " |
|
***************0252CASHOUT WITH QR-CODE(FREE BAL)",
" |
|
currentCardActivationNdateBlock2023-09-04 | 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 Bloqueo de tarjetasRegistro del cliente en la el proveedor de clientes. | |
blockCodeZpanToken0004217470885923553cardSequence1functionCodeB //B para bloquear - u Desbloquear
} | 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 | GRPC Codes |
---|
Realiza la consulta de bloqueos de cuenta. | Code Block |
---|
{
"accountNumber": "9500501520328494829"
} |
| Code Block |
{
"accountData": {,
"colony": "Lomas",
"city": "Lomas de Alvarez",
"state": "COL",
"postalCode": "99980",
"dateOfBirth": "2000-08-06",
"stateOfBirth": "CDMX",
"email": "lmedina@palo-it.com",
" |
|
accountNumber9500501520328494829customerNumber0995000000000035249blockCode1MblockCode1Date2023-09-07blockCode2MblockCode2Date2023-08-11accountMakerDateOfBirthavailableCredit0userAmounts9 0userAmounts10identificationNumberFlag": |
|
0,userAmounts70
} OK Bad Request: Request con campos no válidos. |
500 Internal Server Error401: 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 |
---|
Realiza bloqueos/desbloqueo de cuentaActualización de los datos del cliente en el proveedor de clientes. | |
blockCodeemail": "lmedina@palo-it.com",
" |
|
blockCodeIndicatorforeignUse0functionCodeUaccountNumber"9500501520328494829"
} Code Block |
{functionCodeBaccountNumber9500501520328494829blockCode1LocalMlocalOrganization950
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 | HTTP Codes | GRPC Codes |
---|
Realiza una transferencia . | Code Block |
{
"transactionData": {transactionAmount1actionCode8012authorizationCode"311S3q"effectiveDate2023-06-21descriptionP2PpaidConcepttestmemoPostedIndicator"qqq"suppressMonetaryTransactionqqqn1n2ByPassqqqidentifier"S_IN"box3crPlaza10MONcrStore"50WHN"keyTracking"KEYTRACKING0123456789"senderAccountsenderAccount012345",beneficiaryAccount"beneficiaryAccount1",counterpartInstitutionaaaaaoperatingInstitutionbbbbbfrcUprkBeneficiaryfrcUprkBenefi,orderingFrcUprkorderingFrcUpdevice"123456789-123456789-123456789-12",ip "198.162.200.200","latitude":-109.699,longitude23.062"recipientName": "recipientName01234567890123456",orderingName"orderingName012345678901234567""paymentSourceId":"paymentSourceId012345"},xTransactionId"123""accountNumber": "9500501545918394337"
} Code Block |
{historyDate"2023-09-12","historyTime": "111208",transactionDatalimitForDepositTransactions": |
|
{"transactionCode":"8012","transactionDescription":"P2PRECIEVER",currentBalance"-2122495","openToBuy":"2122548"}}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 | HTTP Codes | GRPC Codes |
---|
Realiza una transferencia P2P. | Code Block |
{from {accountNumberaccountMonthlyAmountLoad": |
|
"9500508496924050930",actionCode"8008""transactionDescription":"P2P_TRANSFER_SOURCE",descriptionaccountMonthlyAmountCash": |
|
"P2P_TRANSFER_SOURCE","authorizationCode":"1234", "to": | 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": " |
|
9500502030236002994actionCode8012transactionDescriptionP2P_TRANSFER_TARGETdescription"P2P_TRANSFER_SOURCE"authorizationCode"1234"
}effectiveDate"2022-01-30","transactionAmount":100,
deviceabcfghjfghjklghjkfghjk5678956789,"ip": "198.162.123.148",latitude123.56565656longitude-23.565656,
"xTransactionId": "123"
} | 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 | |
effectiveDate2022-01-30transactionAmount"100"actionOutputArea{
"actionData": [
{
"authorizationCode | Code Block |
---|
{
"postToAccount": " |
|
1234",
"accountNumber": "9500508496924050930",
"transactionDescription": "P2P SENDER",
"feeAmount9500508261544464147",
"blockCode": " |
|
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"
}
]
}
}200 OK: Solicitud exitosa.
400 Bad Request "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. |
500 Internal Server Error: Servicios no disponibles.
0 OK: Solicitud exitosa.
3 Bad Request: Request con campos no válidos.
13 Internal Server Error: 401: Apy Key no válida. 500: Servicios no disponibles. |
...
PUT /cards/embosser/block
Descripción | Request | Response | HTTP Codes |
---|
GRPC Codes | Realiza una transferencia QR.transactionData {
transactionAmount: 20
actionCode8038
authorizationCode"Q1er44"
effectiveDate2022-08-24",
"description": "QR code test - normal hours",
"paidConcept": "Hello",
"memoPostedIndicator": " ",
"suppressMonetaryTransaction": "YB" //B para bloquear - u Desbloquear
} |
| | 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",
" |
|
n1n2ByPassNidentifier0,
"box": "1crPlaza10MONcrStore50WHNkeyTrackingHellobeneficiaryAccount": "Hello",
"senderAccountaccountMakerDateOfBirth": |
|
"Hello,
"counterpartInstitution": "HellooperatingInstitution"Hello"frcUprkBeneficiary"Hello"orderingFrcUprk"Hello"device"123456789-123456789-123456789-12", | 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. | |
ip198.162.200.200",
"blockCodeIndicator": 1,
" |
|
latitude-109.699,
longitude23.062 recipientNameHello, orderingNameHello
paymentSourceIdbf0469d7-b507-44d6-af7d-d4edea6340f1"
}xTransactionId123accountNumber"9500508020127353147" | 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. | |
historyDate2023-09-12",historyTime "111311",transactionData {transactionCode8038transactionDescriptionCASHOUT WITH QR-CODE(FREE BAL)currentBalanceblockCode1Date": "2023-09- |
|
1382946openToBuy1382326}
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 | HTTP Codes | GRPC Codes |
---|
Realiza la consulta de balance de cuenta. | Code Block |
---|
{
"accountNumber": "9500501520328494829"
} |
| Code Block |
---|
{
"accountOrCardNumber": "9500501520328494829",
"currentBalance": 998176210159,
"availableCreditLimit": 32237425576994724,
"frozenBalance": 26000
} |
| 200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | "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 |
---|
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. |
...
Consulta de balance Repositorio sincronizado con Fiserv Disminuye peticiones al Proveedor |
GetAccountBalance
Descripción | Request | Response |
---|
HTTP CodesCreación del clienteRealiza la consulta de balance de cuenta. | |
logo60, addressCiruelas
houseNumber"12345"
externalNumber"8007"
colony"Lomas",
"city": "Lomas de Alvarez",
"state": "COL",
"postalCode": "99980 | 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",
|
|
dateOfBirth"2000-08-06",
stateOfBirth"CDMX"
email "lmedina@palo-it.com",
"firstName": "Judith", | 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": {
" |
|
lastName"Medina"maternalLastNameRuizmobilePhoneNumber5521163588identificationNumber4152554487415113698ine1234117890099occupationTestergenderCode1user4suppressMonetaryTransaction": " |
|
1identificationNumberFlag2"
} Code Block |
{customerNumber0995000000000080589"
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 | HTTP Codes | GRPC Codes |
---|
Actualizar cliente | Code Block |
{emaillmedina@palo-it.comnumberType1customerNumber0995000000000077863KEYTRACKING0123456789",
" |
|
addressCiruelasdateOfBirth1999-02-06city"Villa de Alvarez"aaaaa",
"operatingInstitution": "bbbbb",
" |
|
countryCodeMEXcountyCDMXcolonyADOLFO LOPEZ MATEOS123456789-123456789-123456789-12",
"ip": "198.162.200.200",
" |
|
externalNumber1007firstNameSandrarecipientName01234567890123456",
" |
|
genderCode2"orderingName012345678901234567",
" |
|
houseNumber123
ine1234117890099,lastNameVelasco
maritalStatus0,
maternalLastNameMedina
middleNameRosa mobilePhoneIndicator1,mobilePhoneNumber31211635899occupationtransactionDescription": " |
|
NURSEownOrRentResidenceFlag0postalCode 54070,
"stateOfBirth": "DF"
} | 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. | |
outputArea
customerNumber0995000000000077863
accountNumber0995000000000077863
responseCodetransactionDescription": "P2P_TRANSFER_SOURCE", |
|
leveldescription": "P2P_TRANSFER_SOURCE", |
|
transactionAmount0, countryLimit "dailyLimitLoad": 0,
"monthlyLimitLoad": 0,
"accountNumber": "9500502030236002994",
" |
|
dailyLimitCash0 "transactionDescription": "P2P_TRANSFER_TARGET",
" |
|
monthlyLimitCash0,"P2P_TRANSFER_SOURCE",
"authorizationCode": "1234"
},
" |
|
limitForDepositTransactions0"2022-01-30",
"transactionAmount": 100,
|
|
}, "device": "abcfghjfghjklghjkfghjk5678956789",
" |
|
accountLimit{"198.162.123.148",
"latitude": 123.56565656,
|
|
accountDailyAmountLoad0,-23.565656,
"xTransactionId": "123"
} |
| |
"effectiveDate": "2022-01-30",
" |
|
accountMonthlyAmountLoad0"100",
"actionOutputArea": {
"actionData": [
|
|
"accountDailyAmountCash":0, accountMonthlyAmountCash0}
"accountNumber": "9500508496924050930",
|
|
}
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 | HTTP Codes | GRPC Codes |
---|
Vincular cuenta al cliente | Code Block |
{accountNumbertransactionDescription": " |
|
9500505675946730065alternateCustomer{expirationDatetransactionCode": 8008,
"currentBalance" |
|
2023-08-22"},customerNumber"0995000000000075954",0,
"openToBuy": 598649100,
" |
|
qualification2""customerTypeIndicator0"foreignUseIndicator":0
} Code Block |
{customerNumber0995000000000045697accountNumbertransactionDescription": " |
|
1650
}200 OK: Solicitud exitosa. 400 Bad Request: Request con campos no válidos. 500 Internal Server Error: Servicios no disponibles. | 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 |
{addressLine11addressLine2"2",assignedSpendingLimitscurrentBalance": -169434,
|
|
{maximumSpendingLimit3spendingFrequency4spendingTransaction5
}, | 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. | |
atmCashAmount6,atmCashNumber7"atmCashSingleTransactionLimit":8, authorizationCriteriaTableNumber9authorizationSpendingLimitTable10blockCode11"branchNumber": 12,
cardAction13, "cardActionReasonCode": "14"cardDelayDays":15, panToken16"cardSequence":17, cardholderAffiliationGroupId18"cardholderFlag":"19", citysuppressMonetaryTransaction": " |
|
20"currentCardActivation":"21",
customerNumber22deliveryOption23deviceIndicator24embossedName125embossedName226enrollmentStatusVBV27expirationDate28firstIssueBranch29internetPurchaseAmount30internetPurchaseNumber31internetPurchaseSingleTransactionLimit32languageCode33maximumAuthorizationFrequency34"123456789-123456789-123456789-12",
" |
|
name135name1TypeIndicator36"name2":"37",
name2TypeIndicator38nextCardExpirationDate39numberOfCardsRequested40overTheCounterCashAmount42,"bf0469d7-b507-44d6-af7d-d4edea6340f1"
|
|
"overTheCounterCashNumber": 43overTheCounterCashSingleTransactionLimit44pinMailerDelayDays 45,
pinOffset: 46,pinSuppression47plasticId48posServiceCode49,accountNumber50postalCode51,"CASHOUT WITH QR-CODE(FREE |
|
"processType": 52,programId53,
"reissueDeliveryOption": 54,requestedCardType55, "retailPurchaseAmt": 56, | 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 | |
retailPurchaseNumber57retailPurchaseSingleTransactionLimit58securedCodeActivate59,
"stateOrProvince | Code Block |
---|
{
"postToAccount": " |
|
60 typeCardMailer61 typeOfCard62 user1 63,
user2: 64 user365,
"user4": 66,
"user5": 67,
"user6": 68,
"user7": 69 | 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",
" |
|
user8 70, "userDate1": "71userDate2"72"vbvPassword73,"visaMiniIndicator": "74",
"visaPlusIndicator": "75"bloquear - u Desbloquear
} |
| |
"panToken": "0004217470595215803",
} | 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 Code Block |
{Obtener cuenta mediante Pantoken | Realiza la consulta de bloqueos de cuenta. | Code Block |
---|
{
"accountNumber": "9500501520328494829"
} |
| Code Block |
---|
{
"accountData": {
" |
|
panToken0004217470595215803cardSequence2147483647foreignUse0
} Code Block |
{
"postToAccount9500508261544464147 "blockCodeZ "cardNumber***************0252",
"currentCardActivation": "N",
"dateBlock": "2023-09-04"
}200: Solicitud exitosa.
400500: 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. |
401: Apy Key no válida.
13 Internal Server Error: Servicios no disponibles. |
...
SetAccountBlock
Descripción | Request | Response |
---|
HTTP Bloqueo de tarjetas | Code Block |
{Realiza bloqueos/desbloqueo de cuenta. | Code Block |
---|
{
"blockCode": "",
"blockCodeIndicator": 1,
"foreignUse": 0,
" |
|
blockCodeZpanToken0004217470885923553",cardSequence1functionCodeB //B para bloquear - u Desbloquear
} | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | Aggregation
Estos son los componentes que se estarán usando para la ejecución de pruebas en el proyecto:
Account Aggregation Service
Info |
---|
Incorpora los servicios de Account Mirror y Balance Mirror Validación de campos mandatorios antes del envío a Fiserv Expone endpoints a través de un API REST y gRPC |
...
,
"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 |
---|
HTTP la consulta de bloqueos de cuentaaccountNumber"9500501520328494829"
} Code Block |
{
"accountData": {
"accountNumber": "9500501520328494829",
"customerNumber{
"transactionAmount": 1,
"actionCode": " |
|
0995000000000035249 blockCode1M blockCode1Date0906 "blockCode2M blockCode2Date2023-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 |
{blockCodememoPostedIndicator": "qqq",
" |
|
blockCodeIndicatorsuppressMonetaryTransaction": |
|
1foreignUse0functionCodeUaccountNumber9500501520328494829
} Code Block |
{
"functionCodeU accountNumber9500501520328494829 "localOrganization950
}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 |
{"KEYTRACKING0123456789",
" |
|
accountNumber9500501520328494829} Code Block |
{ "accountData":{ accountNumber9500501520328494829 customerNumbercounterpartInstitution": " |
|
0995000000000035249 blockCode1M "blockCode1Date2023-09-06 blockCode2M blockCode2Date20230811
}
}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 |
{accountNumber9500501520328494829"
} 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. | Code Block |
{198.162.200.200",
"latitude": -109.699,
"longitude": 23.062,
"recipientName": "recipientName01234567890123456",
"orderingName": "orderingName012345678901234567",
"paymentSourceId": "paymentSourceId012345"
},
"xTransactionId": "123",
"accountNumber": " |
|
9500501520328494829
"accountOrCardNumber
"historyDate": "2023-09-12",
"historyTime": "111208",
"transactionData": {
"transactionCode": " |
|
9500501520328494829 currentBalance998176209259,
"availableCreditLimit"P2P RECIEVER",
"currentBalance": |
|
1823760996,
"frozenBalance": 26000.0
}200"-2122495",
"openToBuy": "2122548"
}
} |
| 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. |
...
TransferPeerToPeer
Descripción | Request | Response |
---|
HTTP GRPC Codes |
---|
Realiza una transferencia P2P. | |
transactionDatatransactionAmount 1,
actionCode: "8012"authorizationCode311S3qeffectiveDatetransactionDescription": " |
|
2023-06-21P2P_TRANSFER_SOURCE",
"description": "P2P_TRANSFER_SOURCE",
" |
|
paidConcepttest, "memoPostedIndicator": "qqq",
suppressMonetaryTransaction"qqq",n1n2ByPassqqqidentifierS_INboxtransactionDescription": " |
|
3crPlaza10MONcrStore50WHNkeyTrackingKEYTRACKING0123456789senderAccount"senderAccount012345"beneficiaryAccountbeneficiaryAccount1abcfghjfghjklghjkfghjk5678956789",
" |
|
counterpartInstitutionaaaaaoperatingInstitution"bbbbb"frcUprkBeneficiary"frcUprkBenefi"orderingFrcUprkorderingFrcUp, device123456789123456789123456789-12
ip198.162.200.200 latitude-109.699,longitude 23.062,recipientNamerecipientName01234567890123456",orderingNameorderingName012345678901234567paymentSourceIdtransactionDescription": " |
|
paymentSourceId012345},xTransactionId123accountNumber"9500501545918394337","operationType":"W"} Code Block |
{ historyDate"2023-09-08",
"historyTime"122250",
"transactionData": {
"transactionCode": "8012",
"transactionDescription": "P2P RECIEVER",
"currentBalance": "-2122495",
"openToBuy": "2122546"
}
}200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | PUT → /v1/balances/transfers-p2p
Descripción | Request | Response | HTTP Codes |
---|
Realiza una transferencia P2P. | Code Block |
{
"from": {0,
"openToBuy": 598649100,
"authorizationNumber": "507925"
},
{
" |
|
accountNumber9500508496924050930actionCode80089500502030236002994",
"transactionDescription": "P2P |
|
_TRANSFER_SOURCEdescription"P2P_TRANSFER_SOURCE",authorizationCode "1234"},to {accountNumber"9500502030236002994",actionCode"8012",transactionDescriptionP2P_TRANSFER_TARGET","description":"P2P_TRANSFER_SOURCE","authorizationCode": "1234"
},
| 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. | |
effectiveDate"2022-01-30",100deviceabcfghjfghjklghjkfghjk5678956789ip198.162.123.148latitude 123.56565656, "longitude": -23.565656xTransactionId123"}{
"effectiveDate": "2022-01-30",
"transactionAmount": "100",
"actionOutputArea": {
"actionData": [
{
"authorizationCode": "1234",
"accountNumber test - normal hours",
"paidConcept": " |
|
9500508496924050930
"transactionDescriptionP2PSENDER
"transactionCode
"suppressMonetaryTransaction": |
|
8008 "currentBalance":-5988391.0, "openToBuy":5.987391E8, authorizationNumber205229
},
{
"authorizationCode"1234" "accountNumber9500502030236002994
"transactionDescriptionP2P RECIEVER
"transactionCode8012,
"currentBalance": -169434.0,
"openToBuy": 1.70434E7,
"authorizationNumber"50WHN",
"keyTracking": "Hello",
"beneficiaryAccount": " |
|
923589 }
]
}
}200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | PUT → /v1/balances/transfers-qr
Descripción | Request | Response | HTTP Codes |
---|
Realiza una transferencia QR. | Code Block |
{ "senderAccount": "Hello",
" |
|
transactionData{transactionAmount20actionCode8038authorizationCodeQ1er44effectiveDate20220824descriptionQR code test - normal hours"198.162.200.200",
"latitude": -109.699,
"longitude": 23.062,
" |
|
paidConceptrecipientName": "Hello",
" |
|
memoPostedIndicator suppressMonetaryTransactionY",bf0469d7-b507-44d6-af7d-d4edea6340f1"
},
" |
|
n1n2ByPassN identifier: 0,
box1
crPlaza10MON
crStore"50WHN",keyTrackingHellobeneficiaryAccounttransactionDescription": " |
|
HelloCASHOUT WITH QR-CODE(FREE BAL)",
" |
|
senderAccountHellocounterpartInstitutionHello, "operatingInstitution | 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": " |
|
Hello, frcUprkBeneficiaryHello
orderingFrcUprk"Hello"
device"123456789-123456789-123456789-12",
ip "198.162.200.200", | 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 | |
latitude -109.699,
longitude: 23.062recipientNameHelloorderingNameHellopaymentSourceIdbf0469d7-b507-44d6-af7d-d4edea6340f1"
},xTransactionId123"accountNumber":"9500508020127353147"} Code Block |
{
"historyDate2023-09-08",
"historyTime": "122732 "transactionData":{ "transactionCode": "8038",
"transactionDescription": "CASHOUT WITHQR-CODE(FREE BAL)", currentBalance-1382946 openToBuy1382486 }}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. | Code Block |
{
logo60addressCiruelashouseNumber12345externalNumber8007colonyLomascityLomas de AlvarezstateCOLpostalCode99980dateOfBirth2000-08-06stateOfBirthCDMXemaillmedina@palo-it.comfirstName JudithlastNameidentificationNumberFlag": " |
|
Medina",maternalLastName"Ruiz", | 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 | |
mobilePhoneNumber5521163588identificationNumber"4152554487415113698"ine1234117890099occupationTestergenderCode1user4"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. | PUT → /customers
Descripción | Request | Response | HTTP Codes |
---|
Actualización de los datos del cliente en el proveedor de clientes. | Code Block |
{emaillmedina@palo-it.comnumberType1customerNumber0995000000000077863addressCiruelasdateOfBirth"1999-02-06""Sandra",
"genderCode": 2,
" |
|
city"Villa de Alvarez"123",
"ine": "1234117890099",
" |
|
countryCodeMEX"county"maritalStatus": 0,
"maternalLastName": " |
|
CDMXcolonyADOLFO LOPEZ MATEOS"Rosa",
"mobilePhoneIndicator": 1,
" |
|
externalNumber1007firstNameSandragenderCode2houseNumber"123"ine1234117890099",lastName"Velasco", "maritalStatus":0,maternalLastNameMedinamiddleNameRosa
"mobilePhoneIndicator":1, mobilePhoneNumber31211635899occupationNURSEownOrRentResidenceFlagpostalCode54070,"stateOfBirth":"DF"} Code Block |
{outputArea {customerNumber"0995000000000077863",accountNumber"0995000000000077863",responseCode"",levellimitForDepositTransactions": |
|
"","transactionAmount": 0countryLimitdailyLimitLoadaccountDailyAmountLoad": 0,
" |
|
monthlyLimitLoadaccountMonthlyAmountLoad": 0,
" |
|
dailyLimitCashaccountDailyAmountCash": 0,
" |
|
monthlyLimitCashaccountMonthlyAmountCash": 0 |
|
,"limitForDepositTransactions": 0 | 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
LinkAccountToCustomer
Descripción | Request | Response | GRPC Codes |
---|
Vincular cuenta al cliente | Code Block |
---|
{
"accountNumber": "9500505675946730065",
"alternateCustomer":
{
"expirationDate": "2023-08-22"
}, |
|
"customerNumber": "0995000000000075954",
" |
|
accountLimit{"2",
"customerTypeIndicator": 0,
"foreignUseIndicator": 0
} |
| |
accountDailyAmountLoad0"0995000000000045697",
"accountNumber": |
|
| 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 | |
accountMonthlyAmountLoad0,
"accountDailyAmountCash": 0,
"accountMonthlyAmountCash": 0
}
}
}"accountNumber": "0004217470072001676"
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
...
PUT → /
...
cards/account
Descripción | Request | Response | HTTP Codes |
---|
Vinculación del cliente en la cuenta de Spin.Desvincular una tarjeta de un número de cuenta | |
"accountNumber": "0004217470138987703",
"customerNumber": "0995000000000045698",
"qualification": "1",
customerTypeIndicatorcustomerOrAccountNumber": |
|
0
foreignUseIndicator 0,
alternateCustomer: { "expirationDate"2023/12/30"
}customerNumber0995000000000045697accountNumbercustomerOrAccountNumber": " |
|
1650 | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
Card Aggregation service
Info |
---|
Incorpora los endpoints de Card Validación de campos mandatorios antes del envío a Fiserv Expone endpoints a través de un API REST y gRPC |
...
POST → /v1/cards/embosser/details
Descripción | Request | Response | HTTP Codes |
---|
Obtener cuenta mediante Pantoken Activo | Code Block |
---|
{
"panToken": "0004217470595215803",
"cardSequence": 2147483647,
"foreignUse": 0
} |
| Code Block |
---|
{
"postToAccount": "9500508261544464147",
"blockCode": "Z",
"cardNumber": "***************0252",
"currentCardActivation": "N",
"dateBlock": "2023-09-04"
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles |
.PUT /account/prepaid
Descripción | Request | Response | HTTP Codes |
Vinculación de tarjetas a cuenta. |
Obtener cuenta mediante Pantoken Inactivo | |
customerOrAccountNumber1234567890123456800cardNumber"000123456ID5IXX1234"cardholderTypecustomerOrAccountNumber1234567890123456800cardNumber000123456ID5IXX1234
}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 |
{000123456ID5IXX1234",
}
Code Block |
{***************0252",
"currentCardActivation": "N",
" |
|
accountNumber0004217470041850252Descripción | Request | Response | HTTP Codes |
---|
Activación de tarjetas | Code Block |
{ | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
PUT /cards/activation
Obtener cuenta mediante Pantoken Expirado | Code Block |
---|
{
"panToken": "0004217470200073271",
"cardSequence": 1,
"foreignUse": 1
} |
| |
organizationNumber999"9500507060523627372",
"cardNumber": " |
|
000123456ID5IXX1234serviceTypecurrentCardActivation": " |
|
A,
"userData": "string"
} | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
POST → /v1/cards/embosser/block
Descripción | Request | Response | HTTP Codes |
---|
Bloqueo de tarjetas - Bloqueo | |
organizationNumber999,
logo: 1cardNumber000123456ID5IXX1234serviceType"A"numberCardsActivated 1,
foreignOrg": 1,
"numberForeignCardsActivated": 0
}
B" //B para bloquear - u Desbloquear
} |
| | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
PUT /cards/embosser/block
Descripción | Request | Response | HTTP Codes |
Bloqueo de tarjetas - Desbloqueo | Code Block |
---|
{
"blockCode": " |
|
Z00042174708859235530004217470752022413",
"cardSequence": 1,
"functionCode": " |
|
BU" //B para bloquear - u Desbloquear
} |
| | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
...