Versions Compared

Key

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

...

Descripción

Request

Response

HTTP Codes

Bloqueo de tarjetas

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

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

Mirror

Account

Info

Consulta de bloqueos​

Repositorio sincronizado con Fiserv​

Disminuye peticiones al Proveedor​

GetAccountDetails

Descripción

Request

Response

GRPC Codes

Realiza la consulta de bloqueos de cuenta.

Code Block
{
  "
organizationNumber
accountNumber":
999,
 "9500501520328494829"
}
Code Block
{
  "
foreignOrg
accountData": {
 
999,
   "
cardNumber
accountNumber": "
000123456ID5IXX1234
9500501520328494829",
    "
cardSequence
customerNumber": 
1
"0995000000000035249",
    "
functionCode
blockCode1": "
U
M",
    "
blockCode
blockCode1Date": "
U
2023-09-07",
    "
warningCode1
blockCode2": "
0
M",
    "
warningCode7
blockCode2Date": "
0
2023-08-11",
    "
processingFlag1
accountMakerDateOfBirth": "
Z
",
    "
processingFlag2
availableCredit": 
"Z"
0,
    "
processingFlag3
userAmounts9": 
"Z"
0,
    "
processingFlag4
userAmounts10": 
"Z"
0,
    "
processingFlag5
userAmounts7": 0
 
"Z"
 }
}
200

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.

Mirror

Account

Info

Consulta de bloqueos​

Repositorio sincronizado con Fiserv​

Disminuye peticiones al Proveedor​

GetAccountDetails

SetAccountBlock

Descripción

Request

Response

GRPC Codes

Realiza

la consulta de

bloqueos/desbloqueo de cuenta.

Code Block
{
  "
accountNumber
blockCode": "
9500501520328494829
"
} Code Block{
,
  "
accountData
blockCodeIndicator": 
{ "accountNumber": "9500501520328494829",
1,
  
"
customerNumber
foreignUse": 
"0995000000000035249"
0,

  "
blockCode1
functionCode": "
M
U",

  "
blockCode1Date
accountNumber": "
2023-09-07
9500501520328494829"
,

}
Code Block
{
  
"
blockCode2
functionCode": "
M
B",

  "
blockCode2Date
accountNumber": "
2023-08-11
9500501520328494829",
  
"
accountMakerDateOfBirth
blockCode1Local": "M",

  "
availableCredit
localOrganization": 
0, "userAmounts9": 0, "userAmounts10": 0, "userAmounts7": 0 } }

0 OK: Solicitud exitosa.

3 Bad Request:
950
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

...

SynchronizeMirrorAccount

Descripción

Request

Response

GRPC Codes

Realiza bloqueos/desbloqueo de cuenta

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

Code Block
{
  "
blockCode
accountNumber": "
",
9500501520328494829"
}
Code Block
{
  "
blockCodeIndicator
accountData": {
1,
    "
foreignUse
accountNumber": 
0
"9500501520328494829",
    "
functionCode
customerNumber": "
U
0995000000000035249",
    "
accountNumber
blockCode1": "
9500501520328494829
M",
} Code Block{
    "
functionCode
blockCode1Date": "
B
2023-09-07",
    "
accountNumber
blockCode2": "
9500501520328494829
M",
    "
blockCode1Local
blockCode2Date": "
M
2023-08-11",
    "
localOrganization
accountMakerDateOfBirth": 
950 }
"",
    "availableCredit": 0,
    "userAmounts9": 0,
    "userAmounts10": 0,
    "userAmounts7": 0
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

...

...

Balance

Info

Consulta de balance​

Repositorio sincronizado con Fiserv​

Disminuye peticiones al Proveedor

GetAccountBalance

Descripción

Request

Response

GRPC Codes

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

Realiza la consulta de balance de cuenta.

Code Block
{
  "accountNumber": "9500501520328494829"
}
Code Block
{
  "
accountData": { "accountNumber"
accountOrCardNumber": "9500501520328494829",

  
"
customerNumber
currentBalance": 
"0995000000000035249"
998176210159,
  
"
blockCode1
availableCreditLimit": 
"M"
32237425576994724,
  
"
blockCode1Date
frozenBalance": 
"2023-09-07", "blockCode2": "M", "blockCode2Date": "2023-08-11", "accountMakerDateOfBirth": "", "availableCredit": 0, "userAmounts9": 0, "userAmounts10": 0, "userAmounts7": 0 } }
26000
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

SynchronizeMirrorBalance

Descripción

Request

Response

GRPC Codes

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

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

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Balance

Info

Consulta de balance​

Repositorio sincronizado con Fiserv​

Disminuye peticiones al Proveedor

...

TransferBalance

Descripción

Request

Response

GRPC Codes

Realiza

la consulta de balance de cuenta

una transferencia .

Code Block
{
  "
accountNumber
transactionData": {
    "
9500501520328494829
transactionAmount"
} Code Block{
: 1,
    "
accountOrCardNumber
actionCode": "
9500501520328494829
8012",
    "
currentBalance
authorizationCode": 
998176210159
"311S3q",
    "
availableCreditLimit
effectiveDate": 
32237425576994724,
"2023-06-21",
    "
frozenBalance
description": 
26000 }

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

SynchronizeMirrorBalance

Descripción

Request

Response

GRPC Codes

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

Code Block
{
  "accountNumber": "9500501520328494829"
}
Code Block{ "accountOrCardNumber": "9500501520328494829
"P2P",
    "paidConcept": "test",
    "memoPostedIndicator": "qqq",
    "suppressMonetaryTransaction": "qqq",
    "n1n2ByPass": "qqq",
    "
currentBalance
identifier": 
998176210159,
"S_IN",
    "
availableCreditLimit
box": 
32237425576994724
"3",
    "
frozenBalance
crPlaza": 
26000 }

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

TransferBalance

Descripción

Request

Response

GRPC Codes

Realiza una transferencia .

Code Block
{"10MON",
    "crStore": "50WHN",
    "transactionDatakeyTracking": {"KEYTRACKING0123456789",
    "transactionAmountsenderAccount": 1"senderAccount012345",
    "actionCodebeneficiaryAccount": "8012beneficiaryAccount1",
    "authorizationCodecounterpartInstitution": "311S3qaaaaa",
    "effectiveDateoperatingInstitution": "2023-06-21bbbbb",
    "descriptionfrcUprkBeneficiary": "P2PfrcUprkBenefi",
    "paidConceptorderingFrcUprk": "testorderingFrcUp",
    "memoPostedIndicatordevice": "qqq123456789-123456789-123456789-12",
    "suppressMonetaryTransactionip": "qqq198.162.200.200",
    "n1n2ByPasslatitude": "qqq"-109.699,
    "identifierlongitude": "S_IN"23.062,
    "boxrecipientName": "3recipientName01234567890123456",
    "crPlazaorderingName": "10MONorderingName012345678901234567",
    "crStorepaymentSourceId": "50WHNpaymentSourceId012345",
 
  "keyTrackingoperationType": "KEYTRACKING0123456789W",
  },
  "senderAccountxTransactionId": "senderAccount012345123",

   "beneficiaryAccountaccountNumber": "beneficiaryAccount19500501545918394337",
}
Code Block
{
   "counterpartInstitutionhistoryDate": "aaaaa2023-09-12",
 
  "operatingInstitutionhistoryTime": "bbbbb111208",
 
  "frcUprkBeneficiarytransactionData": "frcUprkBenefi",{
    "orderingFrcUprktransactionCode": "orderingFrcUp8012",
    "devicetransactionDescription": "123456789-123456789-123456789-12P2P RECIEVER",
    "ipcurrentBalance": "198.162.200.200-2122495",
    "latitudeopenToBuy": -109.699,"2122548"
    "longitude": 23.062,}
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

TransferPeerToPeer

Descripción

Request

Response

GRPC Codes

Realiza una transferencia P2P.

Code Block
{
  "from": {
    "
recipientName
accountNumber": "
recipientName01234567890123456
9500508496924050930",
    "
orderingName
actionCode": "
orderingName012345678901234567
8008",
    "
paymentSourceId
transactionDescription": "
paymentSourceId012345
P2P_TRANSFER_SOURCE",
    "
operationType
description": "
W
P2P_TRANSFER_SOURCE",
  
},
  
"
xTransactionId
authorizationCode": "
123
1234"
  },
  "
accountNumber
to": {
"9500501545918394337"
 
} Code Block{
   "
historyDate
accountNumber": "
2023-09-12
9500502030236002994",
    "
historyTime
actionCode": "
111208
8012",
  
"transactionData":
 
{
 
"
transactionCode
transactionDescription": "
8012
P2P_TRANSFER_TARGET",
    "
transactionDescription
description": "P2P
RECIEVER
_TRANSFER_SOURCE",
    "
currentBalance
authorizationCode": "
-2122495"
1234"
  },
    "
openToBuy
effectiveDate": "
2122548
2022-01-30"
} }

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

TransferPeerToPeer

Descripción

Request

Response

GRPC Codes

Realiza una transferencia P2P.

Code Block
{,
    "fromtransactionAmount": {100,
    "accountNumberdevice": "9500508496924050930abcfghjfghjklghjkfghjk5678956789",
    "actionCodeip": "8008"198.162.123.148",
    "transactionDescriptionlatitude": "P2P_TRANSFER_SOURCE"123.56565656,
    "descriptionlongitude": "P2P_TRANSFER_SOURCE"-23.565656,
    "authorizationCodexTransactionId": "1234123"
 
},
Code Block
{
  "toeffectiveDate": {
 "2022-01-30",
  "accountNumbertransactionAmount": "9500502030236002994100",
 
  "actionCodeactionOutputArea": "8012",{
    "transactionDescriptionactionData": "P2P_TRANSFER_TARGET",[
      {
  "description": "P2P_TRANSFER_SOURCE",     "authorizationCode": "1234",
   },     "effectiveDateaccountNumber": "2022-01-309500508496924050930",

   "transactionAmount": 100,     "devicetransactionDescription": "abcfghjfghjklghjkfghjk5678956789P2P SENDER",
        "ipfeeAmount": "198.162.123.1480",
        "latitudetransactionCode": 123.56565656,8008,
        "longitudecurrentBalance": -23.5656565988391,
        "xTransactionIdcreditLimit": "123"
}
Code Block
{ 0,
        "effectiveDateopenToBuy": "2022-01-30"598649100,
  "transactionAmount": "100",      "actionOutputAreaauthorizationNumber": "507925"
{     "actionData": [ },
      {
        "authorizationCode": "1234",
        "accountNumber": "95005084969240509309500502030236002994",
        "transactionDescription": "P2P SENDERRECIEVER",
        "feeAmount": "0",
        "transactionCode": 80088012,
        "currentBalance": -5988391169434,
        "creditLimit": 0,
        "openToBuy": 59864910017133400,
        "authorizationNumber": "507925332272"
      },
    ]
 {    }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

FrozenBalanceTransfer

Descripción

Request

Response

GRPC Codes

Realiza una transferencia QR.

Code Block
{
  
"
authorizationCode
transactionData":
"1234",
 {
    "transactionAmount": 20,
    "
accountNumber
actionCode": "
9500502030236002994
8038",

    
"
transactionDescription
authorizationCode": "
P2P RECIEVER
Q1er44",

    "
feeAmount
effectiveDate": "
0
2022-08-24",

    "
transactionCode
description": 
8012,
"QR code test - normal hours",
    "
currentBalance
paidConcept": 
-169434
"Hello",
    
"creditLimit": 0
"memoPostedIndicator": " ",
    
"
openToBuy
suppressMonetaryTransaction": 
17133400,
"Y",
    "
authorizationNumber
n1n2ByPass": "
332272
N",
    "identifier": 0,
}
    
] } }

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

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

Descripción

Request

Response

GRPC Codes

Realiza una transferencia QR.

Code Block
{"box": "1",
    "transactionDatacrPlaza": {"10MON",
    "transactionAmountcrStore": 20"50WHN",
    "actionCodekeyTracking": "8038Hello",
    "authorizationCodebeneficiaryAccount": "Q1er44Hello",
    "effectiveDatesenderAccount": "2022-08-24Hello",
    "descriptioncounterpartInstitution": "QR code test - normal hoursHello",
    "paidConceptoperatingInstitution": "Hello",
    "memoPostedIndicatorfrcUprkBeneficiary": " Hello",
    "suppressMonetaryTransactionorderingFrcUprk": "YHello",
    "n1n2ByPassdevice": "N123456789-123456789-123456789-12",
    "identifierip": 0"198.162.200.200",
    "boxlatitude": "1"-109.699,
    "crPlazalongitude": "10MON"23.062,
    "crStorerecipientName": "50WHNHello",
    "keyTrackingorderingName": "Hello",
    "beneficiaryAccountpaymentSourceId": "Hello",bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "senderAccountxTransactionId": "Hello123",
    "counterpartInstitutionaccountNumber": "Hello9500508020127353147",
}
Code Block
{
   "operatingInstitutionhistoryDate": "Hello",
    "frcUprkBeneficiary": "Hello",
    "orderingFrcUprk": "Hello",
    "device": "123456789-123456789-1234567892023-09-12",
    "iphistoryTime": "198.162.200.200111311",
 
  "latitudetransactionData": -109.699,
    "longitude": 23.062,
    "recipientName": "Hello",
    "orderingName": "Hello",
    "paymentSourceId": "bf0469d7-b507-44d6-af7d-d4edea6340f1"
  },
  "xTransactionId": "123",
  "accountNumber": "9500508020127353147"
}
Code Block
{
  "historyDate": "2023-09-12",
  "historyTime": "111311",
  "transactionData": {
    "transactionCode": "8038",
    "transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
    "currentBalance": "-1382946",
    "openToBuy": "1382326"
  }
}

0 OK: Solicitud exitosa.

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

13 Internal Server Error: Servicios no disponibles.

Card

Info

Incorpora los endpoints de Card Mirror​

Sincronización de datos con el Mirror​

Expone endpoints a través de un API REST

POST → /v1/cards/embossers/details

{
    "transactionCode": "8038",
    "transactionDescription": "CASHOUT WITH QR-CODE(FREE BAL)",
    "currentBalance": "-1382946",
    "openToBuy": "1382326"
  }
}

0 OK: Solicitud exitosa.

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

401: Apy Key no válida.

500: Servicios no disponibles.

...

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

Bloqueo de tarjetas

Obtener cuenta mediante Pantoken

Code Block
{
  "
blockCode": "Z", "
panToken": "
0004217470885923553
0004217470595215803",
  "cardSequence": 
1
2147483647,
  "
functionCode
foreignUse": 
"B" //B para bloquear - u Desbloquear
0
}
Code Block
{
"organizationNumber": 999, "foreignOrg": 999, "cardNumber": "000123456ID5IXX1234", "cardSequence": 1, "functionCode": "U", "blockCode": "U", "warningCode1": "0", "warningCode7": "0", "processingFlag1
	"postToAccount": "9500508261544464147",
	"blockCode": "Z",
	"cardNumber": "***************0252",
	"currentCardActivation": "N",
	"dateBlock": "2023-09-04"
}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

PUT → /v1/cards/embossers/block

Descripción

Request

Response

HTTP Codes

Bloqueo de tarjetas

Code Block
{
  "blockCode": "Z",
  "processingFlag2panToken": "Z0004217470885923553",
  "processingFlag3cardSequence": "Z"1,
  "processingFlag4functionCode": "Z",
  "processingFlag5": "Z"
B" //B para bloquear - u Desbloquear
}
Code Block
{}

200: Solicitud exitosa.

400: Request con campos no válidos.

401: Apy Key no válida.

500: Servicios no disponibles.

...