...
Note |
---|
IMPORTANTE: El servicio de Aggregation es el que se usarán para las pruebas correspondientes en ambientes de QA y ST: Account + Customer en Genesys Card en Spin |
Detalle de endpoints
Table of Contents |
---|
minLevel | 1 |
---|
maxLevel | 6 |
---|
outline | false |
---|
type | list |
---|
printable | false |
---|
|
Ejemplo body:
El detalle que se muestra es el camino deseado (happy path) de los endpoints desarrollados.
El código esperado es un 200 + un body, en estos casos
Ejemplo de body - EnableToken (POST /tokens/key):
Body - Request
{
"deviceId": "15703c1c-352a-11ee-be56-0242ac120002",
"keyId": "05616256-352a-11ee-be56-0242ac120002",
"publicKey": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCR9+qdg/HrRLzgkbphCnQpN+NscOEY8vQO/M+/U4erX3ZK9IcV9MulLyY4faIBV2LeJpeUDzemFygjz/e+as6gKjbrJ7jHldl0stpfyUv6Se5iwC2wunevURLjnyk31Af9QtJr5KGsNrtyVzNYis92LGUY64tHEVNoL6DmrD/JJwIDAQAB",
"publicKeyAlgorithm": "RSA"
}
Panel |
---|
panelIconId | atlassian-note |
---|
panelIcon | :note: |
---|
bgColor | #FFBDAD |
---|
|
Body - Response { "seed": "PGh9l4M6kfEWQPSAlB2ELD9p1GTMZ/lQSzkBg2n/lhTOsZtNh2lvhoRkCCBnsGuZgjBGPIfHFye3yi/b5YUKl+2CA673Fg66WruKTU58ywk/rZYUKXOku2NI8PliZG9P9/nrgrZ75D5SxsuUv0DIj8A0WfdYu16PLFnH4MGhD6A=" } |
Mirror
Account
Info |
---|
Consulta de bloqueos Repositorio sincronizado con Fiserv Disminuye peticiones al Proveedor |
GetAccountDetails
...
Descripción
...
Request
...
Response
...
HTTP Codes
Aggregation
Estos son los componentes que se estarán usando para la ejecución de pruebas en el proyecto:
Account Aggregation Service
Info |
---|
Incorpora los servicios de Account Mirror y Balance Mirror Validación de campos mandatorios antes del envío a Fiserv Expone endpoints a través de un API REST y gRPC |
POST → /v1/accounts/details
Descripción | Request | Response | HTTP Codes | GRPC Codes |
---|
Realiza la consulta de bloqueos de cuenta Activa | Code Block |
---|
{
"accountNumber": "9500507060523627372"
} |
| Code Block |
---|
{
"accountData": {
"accountNumber": "9500507060523627372",
"customerNumber": "0995000000000078206"
}
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
Realiza la consulta de bloqueos de cuenta |
.Inactiva | Code Block |
---|
{
"accountNumber": " |
|
9500501520328494829 | Code Block |
---|
{
"accountData": {
"accountNumber": " |
|
95005015203284948299500501403742215502",
"customerNumber": " |
|
09950000000000352490995000000000080639",
"blockCode1": " |
|
MU",
"blockCode1Date": "2023-09- |
|
07MX",
"blockCode2Date": "2023- |
|
0811,"accountMakerDateOfBirth": "",
"availableCredit": 0,
"userAmounts9": 0,
"userAmounts10": 0,
"userAmounts7": 0
}
}2 | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. |
4 3 Bad Request: Request con campos no válidos. |
5 13 Internal Server Error: Servicios no disponibles. |
SetAccountBlock
Descripción | Request | Response | HTTP Codes |
Realiza la consulta de bloqueos |
/desbloqueo .blockCodeaccountNumber": "9500501566817108768" |
|
, "blockCodeIndicator": 1,foreignUse0,"functionCode":"U",9500501520328494829} Code Block |
{"functionCode":"B",accountNumber9500501520328494829,"blockCode1Local":"M", "localOrganization": 950
}2 | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. |
4 3 Bad Request: Request con campos no válidos. |
5 Descripción | Request | Response | HTTP Codes |
---|
Sincroniza el mirror de account con la información de Fiserv. | Code Block |
{
13 Internal Server Error: Servicios no disponibles. |
SynchronizeMirrorAccount
Realiza la consulta de bloqueos de cuenta Bloqueada | Code Block |
---|
{
"accountNumber": " |
|
9500501520328494829 | Code Block |
---|
{
"accountData": {
|
|
"accountNumber":"9500501520328494829",
customerNumber0995000000000035249 "blockCode1": "M",blockCode1Date2023-09-07
"blockCode2":"M",blockCode2Date2023-08-11"accountMakerDateOfBirth": "",
availableCredit0,
"userAmounts9": 0, "userAmounts10": 0,
"userAmounts7": 0
}
}2 | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. |
4 3 Bad Request: Request con campos no válidos. |
5 13 Internal Server Error: Servicios no disponibles. |
Balance
Info |
---|
Consulta de balance Repositorio sincronizado con Fiserv Disminuye peticiones al Proveedor |
...
POST → /v1/accounts/blocks
Descripción | Request | Response | HTTP Codes | GRPC Codes |
---|
Realiza |
la consulta de balance de cuenta.bloqueos/desbloqueo de cuenta - Bloquear (foreignUse= 0) | |
accountNumber9500501520328494829} Code Block |
{ accountOrCardNumber"9500501520328494829"currentBalance998176210159availableCreditLimit32237425576994724frozenBalance260002 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | SynchronizeMirrorBalance
Descripción | Request | Response | HTTP Codes |
---|
Sincroniza el mirror de balance con la información de Fiserv. | Code Block |
{accountNumber9500501520328494829} Code Block |
{accountOrCardNumberaccountNumber": "9500501520328494829",
" |
|
currentBalance998176210159
"availableCreditLimit":32237425576994724,frozenBalance260002 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. |
4 3 Bad Request: Request con campos no válidos. |
5 Descripción | Request | Response | HTTP Codes |
---|
Realiza una transferencia . | 13 Internal Server Error: Servicios no disponibles. |
TransferBalance
Realiza bloqueos/desbloqueo de cuenta - Bloquear (foreignUse= 1) | |
transactionData { transactionAmount: 1
actionCode"8012"
authorizationCode"311S3q"
effectiveDate2023-06-21
descriptionP2P,"paidConcept":test",
"memoPostedIndicator"qqqsuppressMonetaryTransactionqqqn1n2ByPass"qqq",
"identifier": "S_IN",
"box": "3",
"crPlaza": "10MON",
"crStore": "50WHN",
"keyTracking": "KEYTRACKING0123456789",
"senderAccount": "senderAccount012345", | 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"
} |
| |
beneficiaryAccountbeneficiaryAccount1counterpartInstitutionaaaaaoperatingInstitutionbbbbbfrcUprkBeneficiary": "frcUprkBenefi",
"orderingFrcUprk": "orderingFrcUp",
"device": "123456789-123456789-123456789-12localOrganization": 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. |
Realiza una transferencia - Número de cuenta Bloqueada | Code Block |
---|
{
"transactionData": {
"transactionAmount": 1000,
"actionCode": "8000",
"authorizationCode": "311S3q",
"effectiveDate": "2023-06-21",
"description": "P2P",
"paidConcept": "test",
"memoPostedIndicator": "qqq",
"suppressMonetaryTransaction": "qqq",
"n1n2ByPass": "qqq",
"identifier": "S_IN",
"box": "3",
"crPlaza": "10MON",
"crStore": "50WHN",
"keyTracking": "KEYTRACKING0123456789",
"senderAccount": "senderAccount012345",
"beneficiaryAccount": "beneficiaryAccount1",
"counterpartInstitution": "aaaaa",
"operatingInstitution": "bbbbb",
"frcUprkBeneficiary": "frcUprkBenefi",
"orderingFrcUprk": "orderingFrcUp",
"device": "123456789-123456789-123456789-12",
"ip": "198.162.200.200",
"latitude": -109.699,
"longitude": 23.062,
"recipientName": "recipientName01234567890123456",
"orderingName": "orderingName012345678901234567",
"paymentSourceId": "paymentSourceId012345"
},
"xTransactionId": "123",
"accountNumber": "9500508176491773011",
"operationType": "D"
} |
| Code Block |
---|
{
"historyDate": "2023-09-18",
"historyTime": "164818",
"transactionData": {
"transactionCode": "8000",
"openToBuy": "2000"
}
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
PUT → /v1/balances/transfers-p2p
Descripción | Request | Response | HTTP Codes | GRPC Codes |
---|
Realiza una transferencia P2P. | Code Block |
---|
{
"from": {
"accountNumber": "9500508496924050930",
" |
|
ip198.162.200.200latitude -109.699, "longitude": 23.062recipientNamerecipientName01234567890123456orderingNameorderingName012345678901234567,paymentSourceId"paymentSourceId012345"},
xTransactionId123accountNumber9500501545918394337} Code Block |
{historyDatetransactionDescription": " |
|
2023-09-12historyTime111208transactionData{transactionCode8012transactionDescription"P2P RECIEVER"currentBalance-2122495abcfghjfghjklghjkfghjk5678956789",
" |
|
openToBuy2122548"}
}2 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | TransferPeerToPeer
Descripción | Request | Response | HTTP Codes |
---|
Realiza una transferencia P2P. | Code Block |
{ "latitude": 123.56565656,
" |
|
from {accountNumber9500508496924050930, "actionCode | Code Block |
---|
{
"effectiveDate": " |
|
8008 "transactionDescriptionP2P_TRANSFER_SOURCE100",
"actionOutputArea": {
"actionData": [
{
" |
|
descriptionP2P_TRANSFER_SOURCE "authorizationCode12349500508496924050930",
"transactionDescription": "P2P |
|
}SENDER",
"transactionCode": 8008,
" |
|
to{
"accountNumber-5988391.0,
"openToBuy": 5.987391E8,
"authorizationNumber": " |
|
9500502030236002994 "actionCode8012 "transactionDescriptionP2P_TRANSFER_TARGET "description "transactionDescription": "P2P |
|
_TRANSFER_SOURCE "authorizationCode"1234"
},
"effectiveDate"2022-01-30",
"transactionAmount": 100,
"device-169434.0,
"openToBuy": 1.70434E7,
"authorizationNumber": " |
|
abcfghjfghjklghjkfghjk5678956789, "ip": "198.162.123.148", | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 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": {
" |
|
latitude123.56565656longitude-23.565656xTransactionId123} Code Block |
{0130transactionAmount100",
"actionOutputArea": {QR code test - normal hours",
|
|
actionData["Hello",
"memoPostedIndicator": |
|
{
authorizationCodesuppressMonetaryTransaction": " |
|
1234
accountNumber9500508496924050930transactionDescriptionP2P SENDER feeAmount0
transactionCode8008,
currentBalance-5988391,
creditLimit0,
openToBuy598649100 authorizationNumbercounterpartInstitution": " |
|
507925Hello",
"operatingInstitution": "Hello",
|
|
}, "frcUprkBeneficiary": "Hello",
|
|
{ "orderingFrcUprk": "Hello",
" |
|
authorizationCode1234123456789-123456789-123456789-12", |
|
accountNumber9500502030236002994198.162.200.200",
"latitude": -109.699,
" |
|
transactionDescription"P2P RECIEVER",
feeAmount0
transactionCode8012,
currentBalance-169434,"bf0469d7-b507-44d6-af7d-d4edea6340f1"
|
|
creditLimit0"123",
"accountNumber": "9500508020127353147"
} |
| Code Block |
---|
{
"historyDate": |
|
"openToBuy"2023-09-08",
"historyTime": |
|
17133400"122732",
"transactionData": |
|
"authorizationNumber3322728038",
"transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
|
|
}
]
}
}2 "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. |
4 3 Bad Request: Request con campos no válidos. |
5 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
Code Block |
{
"transactionData": {
"transactionAmount": 20,Descripción | Request | Response | HTTP Codes |
---|
Realiza una transferencia QR. | GRPC Codes |
---|
Registro del cliente en la el proveedor de clientes. | |
actionCode8038authorizationCodeQ1er44effectiveDate2022-08-24descriptionQR code test - normal hourspaidConceptHellomemoPostedIndicatorcity": "Lomas de Alvarez",
" |
|
suppressMonetaryTransactionYn1n2ByPassNidentifier": 0,
"box1crPlaza10MONcrStore50WHNkeyTrackingHellobeneficiaryAccountHellosenderAccountHellocounterpartInstitutionHellooperatingInstitutionHellofrcUprkBeneficiaryHelloorderingFrcUprkHellodevice123456789-123456789-123456789-12ip "198.162.200.200latitudeidentificationNumberFlag": |
|
-109.699,longitude": 23.062,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. | |
recipientNameHelloorderingName"Hello"paymentSourceIdbf0469d7-b507-44d6-af7d-d4edea6340f1"},
xTransactionId123
"accountNumber":"9500508020127353147"
} Code Block |
{historyDate20230912"historyTime":"111311", transactionData {
"transactionCode": "8038",
"transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)currentBalance-1382946openToBuy1382326
}}2 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | Card
Info |
---|
Incorpora los endpoints de Card Mirror Sincronización de datos con el Mirror Expone endpoints a través de un API REST |
POST → /v1/cards/embossers/details
Descripción | Request | Response | HTTP Codes |
---|
Obtener cuenta mediante Pantoken | Code Block |
{panToken0004217470595215803cardSequence2147483647"foreignUse":0
} Code Block |
{ postToAccount9500508261544464147 blockCode"Z" "cardNumber***************0252 currentCardActivationN dateBlock2023-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 |
{Velasco",
"maritalStatus": 0,
" |
|
blockCodeZpanToken0004217470885923553cardSequencemobilePhoneIndicator": 1,
" |
|
functionCodeB //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 |
---|
Realiza la consulta de bloqueos de cuenta. | Code Block |
{
"accountNumber": "9500501520328494829,
"occupation": "NURSE",
"ownOrRentResidenceFlag": 0,
"postalCode": 54070,
"stateOfBirth": "DF"
} |
| |
accountDataaccountNumber9500501520328494829customerNumber0995000000000035249blockCode1MblockCode1Date2023-09-07blockCode2"M"blockCode2Date "2023-08-11""accountMakerDateOfBirth": "",availableCredit"userAmounts9":0,userAmounts10"userAmounts7":0}}2 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | SetAccountBlock
Descripción | Request | Response | HTTP Codes |
---|
Realiza bloqueos/desbloqueo de cuenta. | Code Block |
{blockCode"","blockCodeIndicator": 1,foreignUselimitForDepositTransactions": 0 |
|
,"functionCode":"U","accountNumber":"9500501520328494829" Code Block |
{"functionCode": "B",accountNumber"9500501520328494829","blockCode1Local":"M","localOrganization":950}2 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | TransferBalance
Descripción | Request | Response | HTTP Codes |
---|
Realiza una transferencia . | Code Block |
{transactionData{"transactionAmount":1,actionCodeaccountMonthlyAmountLoad": |
|
"8012""authorizationCode": "311S3q",effectiveDate"2023-06-21","description":"P2P",paidConceptaccountMonthlyAmountCash": |
|
"test","memoPostedIndicator":"qqq","suppressMonetaryTransaction":"qqq", "n1n2ByPass": "qqq", | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | 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. | |
identifierS_INbox3crPlaza10MONcrStore"50WHN"keyTracking"KEYTRACKING0123456789"senderAccount "senderAccount012345",beneficiaryAccountbeneficiaryAccount1,"counterpartInstitution": "aaaaa",operatingInstitutionbbbbbfrcUprkBeneficiaryfrcUprkBenefi,
"orderingFrcUprk": "orderingFrcUp",
"device": "123456789-123456789-123456789-12 | 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",
|
|
ip"198.162.200.200",
latitude-109.699,
"longitude": 23.062,
"recipientName": "recipientName01234567890123456",
"orderingName": "orderingName012345678901234567",
"paymentSourceId": "paymentSourceId012345"
},
"xTransactionId": "123 | 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",
" |
|
accountNumber9500501545918394337operationType"W"historyDatecustomerOrAccountNumber": " |
|
2023-09-12historyTime111208 "transactionData": {
"transactionCode": "8012",
"transactionDescription": "P2P RECIEVER",
"currentBalance": "-2122495", | 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",
}
|
| |
openToBuy2122548
}2 OK4 Bad Request400: Request con campos no válidos. |
5 Internal Server Error401: 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 |
---|
Realiza una transferencia P2P.from{
"accountNumber": "9500508496924050930",
actionCode8008",
"transactionDescription": "P2P_TRANSFER_SOURCE
descriptionP2P_TRANSFER_SOURCE
authorizationCode1234}"organizationNumber": 999,
" |
|
to{
accountNumber9500502030236002994
actionCode8012A",
"numberCardsActivated": 1,
" |
|
transactionDescription"P2P_TRANSFER_TARGET",
descriptionnumberForeignCardsActivated": |
|
"P2P_TRANSFER_SOURCE",
| 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 | |
authorizationCode1234
} effectiveDate2022-01-30
transactionAmount100 deviceabcfghjfghjklghjkfghjk5678956789",
"ip": "198.162.123.148",
"latitude": 123.56565656,
"longitude": -23.565656,
"xTransactionId": "123B" //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"
} |
| |
effectiveDate "2022-01-30",transactionAmount100actionOutputArea {
actionData:[ {
"authorizationCode1234
accountNumber9500508496924050930
transactionDescriptionP2P SENDER
feeAmount0
transactionCodeaccountMakerDateOfBirth": |
|
8008 currentBalance-5988391
creditLimit
openToBuy598649100
authorizationNumber"507925" },
{
| 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. | |
authorizationCode1234",
"blockCodeIndicator": 1,
|
|
accountNumber"9500502030236002994" "transactionDescriptionP2P RECIEVER
feeAmount0,
transactionCode 8012,
currentBalance: -169434
creditLimit0,
"openToBuy": 17133400 "authorizationNumber": "332272"
}
]
}
}2 "blockCode1Local": "M",
"localOrganization": 950
} |
| 0 OK: Solicitud exitosa. |
4 3 Bad Request: Request con campos no válidos. |
5 13 Internal Server Error: Servicios no disponibles. |
...
SynchronizeMirrorAccount
Descripción | Request | Response |
---|
HTTP Realiza una transferencia QRSincroniza el mirror de account con la información de Fiserv. | |
transactionData { transactionAmount: 20, actionCode"8038",authorizationCodeQ1er44effectiveDate2022-08-24descriptionQR code test - normal hourspaidConceptHello",
"memoPostedIndicator": " ",
"suppressMonetaryTransaction": "Yn1n2ByPassNidentifier0boxaccountMakerDateOfBirth": " |
|
1crPlaza"10MON"crStore"50WHN"keyTracking"Hello"beneficiaryAccount"Hello", "senderAccount": "Hello",
| 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. | |
counterpartInstitutionHello, operatingInstitutionHello
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. |
SynchronizeMirrorBalance
Descripción | Request | Response | GRPC Codes |
---|
Sincroniza el mirror de balance con la información de Fiserv. | |
ip198.162.200.200",
latitude-109.699,
longitude23.062
recipientNameavailableCreditLimit": 32237425576994724,
" |
|
Hello, | 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 . | |
orderingName"Hello",paymentSourceId"bf0469d7-b507-44d6-af7d-d4edea6340f1" },xTransactionId123accountNumber9500508020127353147"
} Code Block |
{historyDate0912historyTime111311transactionData{transactionCode8038transactionDescriptionsuppressMonetaryTransaction": " |
|
CASHOUT WITH QR-CODE(FREE BAL)currentBalance-1382946openToBuy1382326
}
}2 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | GetAccountBalance
Descripción | Request | Response | HTTP Codes |
---|
Realiza la consulta de balance de cuenta. | Code Block |
{accountNumber9500501520328494829} Code Block |
{accountOrCardNumber9500501520328494829currentBalance998176210159availableCreditLimit32237425576994724"KEYTRACKING0123456789",
" |
|
frozenBalance": 26000
}2 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | Customer Adapter
Info |
---|
Permite tener la comunicación entre Spin y Fiserv para los módulos de customer. Este componente se desarrolló para desacoplar los procesos core de Spin y el proveedor financiero para lograr una mayor escalabilidad. |
CreateCustomer
Descripción | Request | Response | HTTP Codes |
---|
Creación del cliente | Code Block |
{senderAccount": "senderAccount012345",
" |
|
logo60addresscounterpartInstitution": " |
|
CiruelashouseNumber12345externalNumber8007colonyLomascityLomas de Alvarez123456789-123456789-123456789-12",
" |
|
stateCOLpostalCode"99980"dateOfBirth"2000-08-06"stateOfBirthCDMXrecipientName01234567890123456",
" |
|
emaillmedina@palo-it.comorderingName012345678901234567",
" |
|
firstNameJudith
lastNameMedina,maternalLastNameRuiz
mobilePhoneNumber5521163588, identificationNumber4152554487415113698
ine1234117890099
occupation"Tester",genderCode1user4transactionDescription": " |
|
1identificationNumberFlag2} Code Block |
{
customerNumber09950000000000805892 4 3 Bad Request: Request con campos no válidos. |
5 13 Internal Server Error: Servicios no disponibles. |
...
TransferPeerToPeer
Descripción | Request | Response |
---|
HTTP Actualizar clienteRealiza una transferencia P2P. | |
email"lmedina@palo-it.com",numberType1customerNumber0995000000000077863addresstransactionDescription": " |
|
CiruelasdateOfBirth1999-02-06cityVilla de Alvarez, "countryCode": "MEX",
county"CDMX",colonyADOLFO LOPEZ MATEOSexternalNumber1007firstNametransactionDescription": " |
|
SandragenderCode2houseNumber123ine1234117890099lastName"Velasco"maritalStatus0"abcfghjfghjklghjkfghjk5678956789",
" |
|
maternalLastNameMedinamiddleName"Rosa"mobilePhoneIndicator1mobilePhoneNumber31211635899, occupationNURSE
ownOrRentResidenceFlag0 postalCode54070,stateOfBirth"DF"
} Code Block |
{"outputArea":customerNumber09950000000000778631234",
"accountNumber": " |
|
0995000000000077863responseCodetransactionDescription": "P2P SENDER",
" |
|
leveltransactionAmount0countryLimit{
dailyLimitLoad
monthlyLimitLoad0598649100,
"authorizationNumber": "507925"
|
|
"dailyLimitCash":0monthlyLimitCash0"1234",
"accountNumber": "9500502030236002994",
|
|
"limitForDepositTransactions "transactionDescription": |
|
0 }accountLimit{
accountDailyAmountLoad0,
accountMonthlyAmountLoad
accountDailyAmountCash0
accountMonthlyAmountCash0}2 4 3 Bad Request: Request con campos no válidos. |
5 13 Internal Server Error: Servicios no disponibles. |
...
FrozenBalanceTransfer
Descripción | Request | Response |
---|
HTTP Vincular cuenta al cliente | Code Block |
{Realiza una transferencia QR. | Code Block |
---|
{
"transactionData": {
"transactionAmount": 20,
"actionCode": "8038",
"authorizationCode": "Q1er44",
"effectiveDate": "2022-08-24",
" |
|
accountNumber9500505675946730065QR code test - normal hours",
" |
|
alternateCustomer{ "memoPostedIndicator": " ",
" |
|
expirationDatesuppressMonetaryTransaction": " |
|
2023-08-22"
}customerNumber"0995000000000075954"qualification2customerTypeIndicator0foreignUseIndicator0
} Code Block |
{
customerNumber0995000000000045697accountNumber1650
}2 OK: Solicitud exitosa. 4 Bad Request: Request con campos no válidos. 5 Internal Server Error: Servicios no disponibles. | Card Gateway
Info |
---|
Permite tener la comunicación entre Spin y Fiserv para los módulos de card. |
POST → /v1/cards/embosser
Descripción | Request | Response | HTTP Codes |
---|
Add a new card to account
| Code Block |
{
"addressLine1": "1",
"addressLine2": "2,
"senderAccount": "Hello",
"counterpartInstitution": "Hello",
"operatingInstitution": "Hello",
" |
|
assignedSpendingLimits{maximumSpendingLimit3spendingFrequency4"123456789-123456789-123456789-12",
" |
|
spendingTransaction5
},atmCashAmount6,atmCashNumber7"atmCashSingleTransactionLimit":8,
authorizationCriteriaTableNumber9authorizationSpendingLimitTable10blockCode11",bf0469d7-b507-44d6-af7d-d4edea6340f1"
|
|
"branchNumber": 12cardAction13cardActionReasonCode14",cardDelayDays15panToken16cardSequence17,cardholderAffiliationGroupId18cardholderFlagtransactionDescription": " |
|
19",CASHOUT WITH QR-CODE(FREE BAL)",
" |
|
city20currentCardActivation21", | 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 | |
customerNumber22deliveryOption23deviceIndicator "24",
"embossedName1 | Code Block |
---|
{
"postToAccount": " |
|
25 embossedName226 enrollmentStatusVBV27 expirationDatecurrentCardActivation": " |
|
28 firstIssueBranch 29, "internetPurchaseAmount": 30, | 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 | |
internetPurchaseNumber 31,
internetPurchaseSingleTransactionLimit: 32languageCode33maximumAuthorizationFrequency34name135",
"name1TypeIndicator": 36,
"name2": "37",
"name2TypeIndicator": 38,
"nextCardExpirationDate": "39",
"numberOfCardsRequested": 40,
"overTheCounterCashAmount": 42,
"overTheCounterCashNumber": 43,
"overTheCounterCashSingleTransactionLimit": 44,
"pinMailerDelayDays": 45,
"pinOffset": 46,
"pinSuppression": 47,
"plasticId": "48",
"posServiceCode": 49,
"accountNumber": "50",
"postalCode": 51,
"processType": 52,
"programId": 53,
"reissueDeliveryOption": 54,
"requestedCardType": "55",
"retailPurchaseAmt": 56,
"retailPurchaseNumber": 57,
"retailPurchaseSingleTransactionLimit": 58,
"securedCodeActivate": 59,
"stateOrProvince": "60",
"typeCardMailer": "61",
"typeOfCard": "62",
"user1": 63,
"user2": 64,
"user3": 65,
"user4": 66,
"user5": 67,
"user6": 68,
"user7": 69,
"user8": 70,
"userDate1": "71",
"userDate2": "72",
"vbvPassword": "73",
"visaMiniIndicator": "74",
"visaPlusIndicator": "75"
} Code Block |
---|
{
"panToken": "0004217470595215803",
} |
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 | 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. |
POST → /v1/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
} |
| | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
Aggregation
Estos son los componentes que se estarán usando para la ejecución de pruebas en el proyecto:
Account Aggregation Service
Info |
---|
Incorpora los servicios de Account Mirror y Balance Mirror Validación de campos mandatorios antes del envío a Fiserv Expone endpoints a través de un API REST y gRPC |
POST → /v1/accounts/details
Descripción | Request | Response | HTTP Codes |
---|
Realiza la consulta de bloqueos de cuenta. | Code Block |
---|
{
"accountNumber": "9500501520328494829"
} |
| Code Block |
---|
{
"accountData": {
"accountNumber": "9500501520328494829",
"customerNumber": "0995000000000035249",
"blockCode1": "M",
"blockCode1Date": "2023-09-06",
"blockCode2": "M",
"blockCode2Date": "2023-08-11"
}
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
POST → /v1/accounts/blocks
Descripción | Request | Response | HTTP Codes |
---|
Realiza bloqueos/desbloqueo de cuenta. | Code Block |
---|
{
"blockCode": "",
"blockCodeIndicator": 1,
"foreignUse": 0,
"functionCode": "U",
"accountNumber": "9500501520328494829"
} |
| Code Block |
---|
{
"functionCode": "U",
"accountNumber": "9500501520328494829",
"localOrganization": 950
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
POST → /v1/accounts/syncs
Descripción | Request | Response | HTTP Codes |
Sincroniza el mirror de account con la información de FiservB" //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 | GRPC Codes |
---|
Realiza la consulta de bloqueos de cuenta. | Code Block |
---|
{
"accountNumber": "9500501520328494829"
} |
| Code Block |
---|
{
"accountData": {
"accountNumber": "9500501520328494829",
"customerNumber": "0995000000000035249",
"blockCode1": "M",
"blockCode1Date": "2023-09-07",
"blockCode2": "M",
"blockCode2Date": "2023-08-11",
"accountMakerDateOfBirth": "",
"availableCredit": 0,
"userAmounts9": 0,
"userAmounts10": 0,
"userAmounts7": 0
}
} |
| 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
SetAccountBlock
Descripción | Request | Response | GRPC Codes |
---|
Realiza bloqueos/desbloqueo de cuenta. | Code Block |
---|
{
"blockCode": "",
"blockCodeIndicator": 1,
"foreignUse": 0,
"functionCode": "U",
"accountNumber": "9500501520328494829"
} |
| Code Block |
---|
{
"functionCode": "B",
"accountNumber": "9500501520328494829",
"blockCode1Local": "M",
"localOrganization": 950
} |
| 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
TransferBalance
Descripción | Request | Response | GRPC Codes |
---|
Realiza una transferencia . | Code Block |
---|
{
"transactionData": {
"transactionAmount": 1,
"actionCode": "8012",
"authorizationCode": "311S3q",
"effectiveDate": "2023-06-21",
"description": "P2P",
"paidConcept": "test",
"memoPostedIndicator": "qqq",
"suppressMonetaryTransaction": "qqq",
"n1n2ByPass": "qqq",
"identifier": "S_IN",
"box": "3",
"crPlaza": "10MON",
"crStore": "50WHN",
"keyTracking": "KEYTRACKING0123456789",
"senderAccount": "senderAccount012345",
"beneficiaryAccount": "beneficiaryAccount1",
"counterpartInstitution": "aaaaa",
"operatingInstitution": "bbbbb",
"frcUprkBeneficiary": "frcUprkBenefi",
"orderingFrcUprk": "orderingFrcUp",
"device": "123456789-123456789-123456789-12",
"ip": "198.162.200.200",
"latitude": -109.699,
"longitude": 23.062,
"recipientName": "recipientName01234567890123456",
"orderingName": "orderingName012345678901234567",
"paymentSourceId": "paymentSourceId012345"
},
"xTransactionId": "123",
"accountNumber": "9500501545918394337"
} |
| Code Block |
---|
{
"historyDate": "2023-09-12",
"historyTime": "111208",
"transactionData": {
"transactionCode": "8012",
"transactionDescription": "P2P RECIEVER",
"currentBalance": "-2122495",
"openToBuy": "2122548"
}
} |
| 0 OK: Solicitud exitosa. 3 Bad Request: Request con campos no válidos. 13 Internal Server Error: Servicios no disponibles. |
TransferPeerToPeer
Descripción | Request | Response | GRPC Codes |
---|
Realiza una transferencia P2P. | |
accountNumber "9500501520328494829"} Code Block |
"accountData":{ "accountNumber":"9500501520328494829", customerNumber0995000000000035249 blockCode1M blockCode1DatetransactionDescription": " |
|
2023-09-06 "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/balances | POST → /v1/balances
Descripción | Request | Response | HTTP Codes |
---|
Realiza la consulta de balance de cuenta. | Code Block |
{,
"to": {
"accountNumber": " |
|
9500501520328494829
} Code Block |
{
"accountOrCardNumber9500501520328494829 "currentBalance": 998176209259,
"availableCreditLimit "transactionDescription": |
|
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 |
{accountNumber9500501520328494829"
} Code Block |
{
"accountOrCardNumberP2P_TRANSFER_SOURCE",
"authorizationCode": " |
|
9500501520328494829 "currentBalance998176209259,
"availableCreditLimit"2022-01-30",
"transactionAmount": |
|
1823760996 frozenBalance": 26000.0
}200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. | PUT → /v1/balances/transfers
Descripción | Request | Response | HTTP Codes |
---|
Realiza una transferencia . | Code Block |
{device": "abcfghjfghjklghjkfghjk5678956789",
" |
|
transactionData{transactionAmount1actionCode"8012"authorizationCode311S3q, 20230621
descriptionP2P
paidConcept"test",memoPostedIndicator "qqq","suppressMonetaryTransaction": "qqq",n1n2ByPassqqqidentifierS_INboxtransactionDescription": " |
|
3crPlaza10MONcrStore"50WHN",keyTracking"KEYTRACKING0123456789",senderAccount"senderAccount012345"beneficiaryAccount"beneficiaryAccount1"counterpartInstitutionaaaaa,"operatingInstitution": "bbbbb",
"frcUprkBeneficiary":"frcUprkBenefi",orderingFrcUprkorderingFrcUpdevice123456789-123456789-123456789-12iptransactionDescription": " |
|
198.162.200.200latitude-109.699,
"longitude":23.062,recipientName"recipientName01234567890123456",orderingName"orderingName012345678901234567",paymentSourceId"paymentSourceId012345"},xTransactionId"123","accountNumber":"9500501545918394337"} Code Block |
{ historyDate2023-09-08, "historyTime":"122250", "transactionData":{ "transactionCode":"8012",
"transactionDescription": "P2P RECIEVER",
"currentBalance": "-2122495",
"openToBuy": "2122546"
200400500: 3 Bad Request: Request con campos no válidos. |
401: Apy Key no válida.
13 Internal Server Error: Servicios no disponibles. |
...
FrozenBalanceTransfer
Descripción | Request | Response |
---|
HTTP GRPC Codes |
---|
Realiza una transferencia |
P2PfromaccountNumber"9500508496924050930"8008transactionDescriptionP2P_TRANSFER_SOURCEdescriptionP2P_TRANSFER_SOURCEauthorizationCode1234"}, to":{ accountNumber9500502030236002994actionCode8012transactionDescriptionsuppressMonetaryTransaction": " |
|
P2P_TRANSFER_TARGETdescriptionP2P_TRANSFER_SOURCEauthorizationCode": "1234"
}effectiveDate2022-01-30transactionAmount100deviceabcfghjfghjklghjkfghjk5678956789ip198.162.123.148latitude123.56565656longitude-23.565656xTransactionIdcounterpartInstitution": " |
|
123
} Code Block |
{
"effectiveDate,
"operatingInstitution": " |
|
2022-01-30 transactionAmount100 "actionOutputArea":{ "actionData":[
{ authorizationCode1234
"accountNumber9500508496924050930123456789-123456789-123456789-12", |
|
"transactionDescriptionP2P SENDER
"transactionCode": 8008,
"currentBalance59883910
"openToBuy5987391E8
"authorizationNumber205229
},
{
"authorizationCode1234 "accountNumber9500502030236002994",
"transactionDescriptionbf0469d7-b507-44d6-af7d-d4edea6340f1"
},
"xTransactionId": " |
|
P2P RECIEVER transactionCode 8012, currentBalance: -169434.0,
"openToBuy": 1.70434E7,
"authorizationNumber | Code Block |
---|
{
"historyDate": " |
|
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 |
{2023-09-12",
"historyTime": "111311",
"transactionData": {
" |
|
transactionAmount20actionCodetransactionDescription": " |
|
8038CASHOUT WITH QR-CODE(FREE BAL)",
" |
|
authorizationCodeQ1er44effectiveDate2022-08-24",
| 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. | |
descriptionaccountNumber": "9500501520328494829" |
|
QR test - normal hours",
|
---|
{
"accountOrCardNumber": "9500501520328494829",
"currentBalance": 998176210159,
" |
|
paidConcept"Hello"
memoPostedIndicator" ", | 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 | |
suppressMonetaryTransactionYn1n2ByPassNidentifier0box1crPlaza10MONcrStore50WHNkeyTrackingHellobeneficiaryAccountHellosenderAccountHellocounterpartInstitutionHellooperatingInstitutionHellofrcUprkBeneficiaryHelloorderingFrcUprkHellodevice123456789-123456789-123456789-12ip198.162.200.200latitude-109.699longitude23.062recipientNameHelloorderingNameHellopaymentSourceId "bf0469d7-b507-44d6-af7d-d4edea6340f1"
},xTransactionIdidentificationNumberFlag": " |
|
123",accountNumber9500508020127353147 | 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 | |
historyDate2023-09-08 historyTime"122732" "transactionData": {
"transactionCode8038 transactionDescriptionCASHOUT WITH QR-CODE(FREE BAL) currentBalance1382946 "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 |
{logo60addressCiruelashouseNumber12345ADOLFO LOPEZ MATEOS",
"externalNumber": " |
|
8007colonyLomascity"Lomas de Alvarez"stateCOLpostalCode99980dateOfBirth2000-08-06stateOfBirth"CDMX"emaillmedina@palo-it.comfirstNameJudithlastName"Medina"maternalLastNameRuizmobilePhoneNumber5521163588identificationNumber"4152554487415113698"ine"1234117890099"occupationTester",genderCode "1",user41identificationNumberFlag2
} Code Block |
{customerNumber0995000000000080589
}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.comnumberType1customerNumber"0995000000000077863","address": "Ciruelas",dateOfBirth"1999-02-06""city":"VilladeAlvarez",countryCode"MEX""county": "CDMX",colony"ADOLFOLOPEZMATEOS","externalNumber":"1007",firstName"Sandra""genderCode":2,houseNumberlimitForDepositTransactions": 0
|
|
"123","ine":"1234117890099","lastName":"Velasco",maritalStatus0,"maternalLastName":"Medina",middleName"Rosa""mobilePhoneIndicator":1,mobilePhoneNumberaccountMonthlyAmountLoad": |
|
"31211635899""occupation":"NURSE",ownOrRentResidenceFlagaccountDailyAmountCash": 0,
|
|
"postalCode":54070,stateOfBirthaccountMonthlyAmountCash": |
|
"DF"
} Code Block |
{"outputArea":{ | 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 | |
customerNumber09950000000000778639500505675946730065",
"alternateCustomer":
{
" |
|
accountNumber0995000000000077863, responseCodecustomerNumber": "0995000000000075954", |
|
level "customerTypeIndicator": 0,
" |
|
transactionAmount, countryLimit{"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 | |
dailyLimitLoad 0,
"monthlyLimitLoad": 0,
dailyLimitCash 0,
monthlyLimitCash": 0,
| 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 | |
limitForDepositTransactionscustomerOrAccountNumber": |
|
0
} "accountLimit": {
"accountDailyAmountLoad": 0,
"cardNumber": "0004217470969640887",
" |
|
accountMonthlyAmountLoad0,
accountDailyAmountCash0,
"accountMonthlyAmountCash": 0
}
}"customerOrAccountNumber": "9500507060523627372"
} |
| 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
POST → /
...
v1/cards/embosser/details
Descripción | Request | Response | HTTP Codes |
---|
Vinculación del cliente en la cuenta de Spin.Obtener cuenta mediante Pantoken Activo | |
accountNumber0004217470138987703 customerNumber"0995000000000045698"
qualification": "1",
"customerTypeIndicator,
"foreignUseIndicator": 0,
"alternateCustomer": {
"expirationDate": "2023/12/30"
}
| Code Block |
---|
{
"postToAccount": "9500508261544464147",
"blockCode": "Z",
" |
|
customerNumber0995000000000045697***************0252",
"currentCardActivation": |
|
"accountNumber1650 | 200: Solicitud exitosa. 400: Request con campos no válidos. 401: Apy Key no válida. 500: Servicios no disponibles. |
Card Aggregation service
...
Incorpora los endpoints de Card
...
POST /cards/embosser/details
Descripción | Request | Response | HTTP Codes |
---|
Expone endpoints a través de un API REST y gRPC
Obtener cuenta mediante Pantoken Inactivo | Code Block |
---|
{
"panToken": "0004217470595215803",
"cardSequence": |
|
21474836470 9500508261544464147",
9500507060523627372",
"blockCode": "Z",
|
|
"cardNumber": "***************0252",
|
|
"currentCardActivation": "N",
|
|
"
}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
GET /cards/account
Descripción | Request | Response | HTTP Codes |
---|
Vinculación de tarjetas a cuenta s
| Code Block |
{
"accountNumber": "4444888833330009999",
"cardNumber": "000123456ID5IXX1234",
"isPrimaryCard: false
} Code Block |
{Descripción | Request | Response | HTTP Codes |
Activación de tarjetas | 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 | |
organizationNumber 999,
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. |
...