Data Structure for Mirror Balance
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
This document contains the Balance Collection (MongoDB) definition. We could see java objects and JSON schema for MongoDB.
Sources
Account Balance Endpoint
Fiserv ednpoint:
/accounts/balance
Class:
FiservRepository
Service:
getAccountBalance
Request DTO properties
Code Block | ||
---|---|---|
| ||
@Builder.Default
protected String organizationNumber = "950";
protected String accountNumber; |
Responses DTO
Code Block | ||
---|---|---|
| ||
public class AccountBalanceResponseDTO {
private String accountOrCardNumber;
private Double currentBalance;
private Double availableCreditLimit;
private Double frozenBalance;
} |
FL-Balance Endpoint
Fiserv ednpoint:
/account/FL-balance
Class:
FiservRepository
Service:
transferBalanceFL
Request DTO
Code Block | ||
---|---|---|
| ||
package com.spin.banking.common.fiserv.request;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.spin.banking.common.domain.FalconIdentifier;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
@Builder
@JsonInclude(JsonInclude.Include.NON_NULL)
public class TransactionDataFLDTO {
private Long transactionAmount;
private String actionCode;
private String authorizationCode;
private String effectiveDate;
private String description;
private String paidConcept;
private String memoPostedIndicator;
private String suppressMonetaryTransaction;
private String n1n2ByPass;
private FalconIdentifier identifier;
private String box;
private String crPlaza;
private String crStore;
private String keyTracking;
private String beneficiaryAccount;
private String senderAccount;
private String counterpartInstitution;
private String operatingInstitution;
private String frcUprkBeneficiary;
private String orderingFrcUprk;
private String device;
private String ip;
private Double latitude;
private Double longitude;
private String recipientName;
private String orderingName;
private String paymentSourceId;
}
|
Response DTO
Code Block | ||
---|---|---|
| ||
public class BalanceTransferResponseDTO {
private String historyDate;
private String historyTime;
private BalanceTransferDetailsResponseDTO transactionData;
} |
Target (MongoDB)
...
Collection Name: balances
Schema:
Code Block | ||
---|---|---|
| ||
db.createCollection("balances",{
validator: {
$jsonSchema: {
bsonType: "object",
description: "Balance bject collection",
required: [
"accountOrCardNumber",
"availableCreditLimit",
"organizationNumber",
"accountNumber"
],
properties: {
"organizationNumber": {
bsonType: "string",
description: "organization Number must be a string and is required"
},
"accountNumber": {
bsonType: "string",
description: "account Number must be a string and is required"
},
"accountOrCardNumber": {
bsonType: "string",
description: "account or card number must be a string and is required"
},
"availableCreditLimit": {
bsonType: "double",
description: "available credit limit must be a number and is required"
}
"currentBalance": {
bsonType: "double",
description: "current balance must be a number"
},
"frozenBalance": {
bsonType: "double",
description: "frozen balance must be a number"
},
"historyDate": {
bsonType: "string",
description: "history Date must be a string"
},
"historyTime": {
bsonType: "string",
description: "history Time must be a string"
},
"transactionData": {
bsonType: "object",
description: "transaction data",
required: [
"transactionCode",
"currentBalance",
"openToBuy"
],
properties: {
"transactionCode": {
bsonType: "string",
description: "transaction code is required"
},
"transactionDescription": {
bsonType: "string",
description: "describe a transaction"
},
"currentBalance": {
bsonType: "long",
description: "current balance must be a long number and is required"
},
"openToBuy": {
bsonType: "long",
description: "open to Buy must be a long number and is required"
},
"transactionAmount": {
bsonType: "long",
description: ""
},
"actionCode": {
bsonType: "string",
description: "action Code"
},
"authorizationCode": {
bsonType: "string",
description: "authorization Code"
},
"effectiveDate": {
bsonType: "string",
description: "effective Date"
},
"description": {
bsonType: "string",
description: "description"
},
"paidConcept": {
bsonType: "string",
description: "paid Concept"
},
"memoPostedIndicator": {
bsonType: "string",
description: "memo Posted Indicator"
},
"suppressMonetaryTransaction": {
bsonType: "string",
description: "suppress Monetary Transaction"
},
"n1n2ByPass": {
bsonType: "string",
description: "n1 n2 by Pass"
},
"identifier": {
bsonType: "string",
description: "identifier"
},
"box": {
bsonType: "string",
description: "box"
},
"crPlaza": {
bsonType: "string",
description: "cr Plaza"
},
"crStore": {
bsonType: "string",
description: "cr Store"
},
"keyTracking": {
bsonType: "string",
description: "key Tracking"
},
"beneficiaryAccount": {
bsonType: "string",
description: "beneficiary Account"
},
"senderAccount": {
bsonType: "string",
description: "sender Account"
},
"counterpartInstitution": {
bsonType: "string",
description: "counterpart Institution"
},
"operatingInstitution": {
bsonType: "string",
description: "operating Institution"
},
"frcUprkBeneficiary": {
bsonType: "string",
description: "frc Up rk Beneficiary"
},
"orderingFrcUprk": {
bsonType: "string",
description: "ordering Frc Up rk"
},
"device": {
bsonType: "string",
description: "device"
},
"ip": {
bsonType: "string",
description: "ip"
},
"latitude": {
bsonType: "double",
description: "latitude"
},
"longitude": {
bsonType: "double",
description: "longitude"
},
"recipientName": {
bsonType: "string",
description: "recipient Name"
},
"orderingName": {
bsonType: "string",
description: "ordering Name"
},
"paymentSourceId": {
bsonType: "string",
description: "payment Source Id"
}
}
}
}
}
}
}); |
Target (Java)
Code Block | ||
---|---|---|
| ||
import lombok.Getter;
import lombok.Setter;
import org.springframework.data.annotation.Id;
import javax.validation.constraints.NotNull;
import org.hibernate.validator.constraints.Email;
import org.springframework.data.mongodb.core.mapping.Document;
// import org.springframework.data.mongodb.core.index.Indexed;
@Getter
@Setter
@Document(collection = "balances")
public class Balance {
@Id
private String id;
@NotNull(message="account or card number is mandatory")
private String accountOrCardNumber;
private Double currentBalance;
@NotNull(message="available credit limit is mandatory")
private Double availableCreditLimit;
private Double frozenBalance;
private String historyDate;
private String historyTime;
private TransactionData transactionData;
private Long transactionAmount;
private String actionCode;
private String authorizationCode;
private String effectiveDate;
private String description;
private String paidConcept;
private String memoPostedIndicator;
private String suppressMonetaryTransaction;
private String n1n2ByPass;
private FalconIdentifier identifier;
private String box;
private String crPlaza;
private String crStore;
private String keyTracking;
private String beneficiaryAccount;
private String senderAccount;
private String counterpartInstitution;
private String operatingInstitution;
private String frcUprkBeneficiary;
private String orderingFrcUprk;
private String device;
private String ip;
private Double latitude;
private Double longitude;
private String recipientName;
private String orderingName;
private String paymentSourceId;
} |
Code Block | ||
---|---|---|
| ||
import lombok.Getter;
import lombok.Setter;
import javax.validation.constraints.NotNull;
import org.springframework.data.mongodb.core.mapping.Document;
@Getter
@Setter
@Document
public class TransactionData {
@NotNull(message="transaction Code is mandatory")
private String transactionCode;
private String transactionDescription;
@NotNull(message="current Balance is mandatory")
private Long currentBalance;
@NotNull(message="open to Buy limit is mandatory")
private Long openToBuy;
} |
Data Structure for Account Mirror
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
This section presents the Fiserv endpoints of the Account domain and proposes the MongoDB data structure for Mirror Account based on the corresponding request/response.
Version control
...
Version
...
Major Changes
...
Doc
...
v1.0
...
Initial data structure
View file | ||
---|---|---|
|
...
v1.1
Deleted endpoints
Fields deleted for account details
View file | ||
---|---|---|
|
...
v1.2
...
Deleted endpoints
Document restructuring
New blocksBy field
View file | ||
---|---|---|
|
For more details on the changes made, please refer to the changelog file.
View file | ||
---|---|---|
|
Source
Fiserv - Account endpoint list
Account Details GET /account/details
Account Block Code POST /account/block-code
Target
Account Details
Source
Fiserv endpoint:
GET /account/details
Class:
FiservRepository
Service:
getAccountDetails
Response:
Code Block | ||
---|---|---|
| ||
public class AccountDetailsResponseDTO {
private AccountDataDTO accountData;
} |
Code Block | ||
---|---|---|
| ||
public class AccountDataDTO {
private String accountNumber;
private String customerNumber;
private String blockCode1;
private String blockCode1Date;
private String blockCode2;
private String blockCode2Date;
private String accountMakerDateOfBirth;
//this comes in pesos
private Double availableCredit;
//daily posted average balance
private Double userAmounts9;
//daily memo average balance
private Double userAmounts10;
//Total current memo balance
private Double userAmounts7;
public Double getAvailableCredit() {
return availableCredit * 100;
}
public Double getUserAmounts9() {
return userAmounts9 * 100;
}
public Double getUserAmounts7() {
return userAmounts7 * 100;
}
public Double getUserAmounts10() {
return userAmounts10 * 100;
}
} |
Request
Code Block | ||
---|---|---|
| ||
public class AccountDetailsRequestDTO {
private String organizationNumber;
private String accountNumber;
} |
Account Block Code
Source
Fiserv endpoint:
POST /account/block-code
Class:
FiservRepository
Service:
setAccountBlockCode
Response:
Code Block | ||
---|---|---|
| ||
public class AccountBlockUnblockResponseDTO {
private String functionCode;
private String accountNumber;
private String blockCode1Local;
private Integer localOrganization;
} |
Request
Code Block | ||
---|---|---|
| ||
public class AccountBlockUnblockRequestDTO extends AbstractAccountFiservBaseRequest {
private String blockCode;
private Integer blockCodeIndicator;
private Integer foreignUse;
private String functionCode;
} |
Code Block | ||
---|---|---|
| ||
public abstract class AbstractAccountFiservBaseRequest extends AbstractFiservBaseRequest {
protected String accountNumber;
} |
Code Block | ||
---|---|---|
| ||
public abstract class AbstractFiservBaseRequest {
@Builder.Default
protected String organizationNumber = "950";
} |
Target (MongoDB) Account Mirror
Collection name:
accountDetails
Schema:
Code Block language json db.createCollection("accountDetails", { validator: { $jsonSchema: { bsonType: "object", title: "Account Details Object Validation", required: ["accountNumber"], properties: { accountNumber: { bsonType: "string", description: "'accountNumber' must be a string and is required" }, customerNumber: { bsonType: "string", description: "'customerNumber' must be a string" }, blockCode1: { bsonType: "string", description: "'blockCode1' must be a string" }, blockCode1Date: { bsonType: "string", description: "'blockCode1Date' must be a string" }, blockCode2: { bsonType: "string", description: "'blockCode2' must be a string" }, blockCode2Date: { bsonType: "string", description: "'blockCode2Date' must be a string" }, blocksBy: { bsonType: "string", description: "'blocksBy' must be a string" } } } } });
Index
Code Block language json db.accountDetails.createIndex({accountNumber: 1});
Target (Java) Account Mirror
Code Block | ||
---|---|---|
| ||
import lombok.Getter;
import lombok.Setter;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;
@Getter
@Setter
@Document(collection = "accountDetails")
public class AccountDetail {
@Id
private String id;
@NotNull(message="account number is mandatory")
private String accountNumber;
private String customerNumber;
private String blockCode1;
private String blockCode1Date;
private String blockCode2;
private String blockCode2Date;
private String blocksBy;
} |
Data Structure for Card Mirror
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
Fiserv - Card endpoint list:
Create a Card POST /cards/embosser
Link Card PUT /account/prepaid
Card Activation PUT /cards/activation
Block Card PUT /cards/embosser/block
Block/Unblock (pin) PUT /cards/pin/status
Update Card Pin PUT /cards/pin
Get Security Code Detail POST /cards/pin/security-codes
Invalid Attemps POST /cards/pin/invalid-attemps
Get Credit Card Info POST /cards/embosser/card-pan
Create a Card
Source
Fiserv endpoint:
/cards/embosser
Class:
FiservRepository
Service:
createCard
Request
Code Block | ||
---|---|---|
| ||
public class CardRequestDTO {
private String addressLine1;
private String addressLine2;
private AssignedSpendingLimitsDTO assignedSpendingLimits;
private int atmCashAmount;
private int atmCashNumber;
private int atmCashSingleTransactionLimit;
private String authorizationCriteriaTableNumber;
private String authorizationSpendingLimitTable;
private String blockCode;
private int branchNumber;
private int cardAction;
private String cardActionReasonCode;
private int cardDelayDays;
private String cardNumber;
private int cardSequence;
private String cardholderAffiliationGroupId;
private String cardholderFlag;
private String city;
private String currentCardActivation;
private String customerNumber;
private int deliveryOption;
private String deviceIndicator;
private String embossedName1;
private String embossedName2;
private String enrollmentStatusVBV;
private String expirationDate;
private int firstIssueBranch;
private int internetPurchaseAmount;
private int internetPurchaseNumber;
private int internetPurchaseSingleTransactionLimit;
private String languageCode;
private int maximumAuthorizationFrequency;
private String name1;
private int name1TypeIndicator;
private String name2;
private int name2TypeIndicator;
private String nextCardExpirationDate;
private int numberOfCardsRequested;
private int organizationNumber;
private int overTheCounterCashAmount;
private int overTheCounterCashNumber;
private int overTheCounterCashSingleTransactionLimit;
private int pinMailerDelayDays;
private int pinOffset;
private int pinSuppression;
private String plasticId;
private int posServiceCode;
private String postToAccount;
private int postalCode;
private int processType;
private int programId;
private int reissueDeliveryOption;
private String requestedCardType;
private int retailPurchaseAmt;
private int retailPurchaseNumber;
private int retailPurchaseSingleTransactionLimit;
private int securedCodeActivate;
private String stateOrProvince;
private String typeCardMailer;
private String typeOfCard;
private int user1;
private int user2;
private int user3;
private int user4;
private int user5;
private int user6;
private int user7;
private int user8;
private String userDate1;
private String userDate2;
private String vbvPassword;
private String visaMiniIndicator;
private String visaPlusIndicator;
} |
Response
Code Block | ||
---|---|---|
| ||
public class AddCardResponseDTO {
private String panToken;
} |
Link Card
Source
Fiserv endpoint:
/account/prepaid
Class:
FiservRepository
Service:
linkCardToAccount
Request
Code Block | ||
---|---|---|
| ||
public class CardToAccountLinkingRequestDTO {
private String cardNumber;
private Integer cardholderType;
private String customerOrAccountNumber;
} |
Response
Code Block | ||
---|---|---|
| ||
public class CardToAccountLinkingResponseDTO {
private String cardNumber;
private String customerOrAccountNumber;
} |
Card Activation
Source
Fiserv endpoint:
/cards/activation
Class:
FiservRepository
Service:
activateCard
Request
Code Block | ||
---|---|---|
| ||
public class CardActivationRequestDTO {
@NotNull(message = "userId is required")
private String userId;
@NotNull(message = "panToken is required")
@Size(min = 12, max = 19, message = "panToken length must be between 12 and 19")
private String panToken;
@NotNull(message = "cardNumber is required")
@Size(min = 12, max = 19, message = "cardNumber length must be between 12 and 19")
private String cardNumber;
private OxxoStoreDTO oxxoStoreDTO;
}
public class OxxoStoreDTO {
@NotBlank private String id;
@NotBlank private String place;
@NotBlank private String store;
private String storeName;
private String stateName;
private String oxxoStoreStateCode;
private String colony;
private String municipality;
private String city;
private Integer postalCode;
@NotNull
@Min(value = -90)
@Max(value = 90)
private Double latitud;
@NotNull
@Min(value = -180)
@Max(value = 180)
private Double longitud;
@NotNull
private Integer affiliationNumber;
} |
Response
Code Block | ||
---|---|---|
| ||
public class CardActivationResponseDTO {
private String cardNumber;
} |
Block Activation
Source
Fiserv endpoint:
/cards/embosser/block
Class:
FiservRepository
Service:
blockCard
Request
Code Block | ||
---|---|---|
| ||
public class CardBlockingRequestDTO {
@NotBlank(message = "userId is Required")
private String userId;
@NotNull(message = "blockingReason is required")
private BlockingReason blockingReason;
}
public enum BlockingReason {
FROZEN("A", true),
GUARDIAN("B"),
DECEASED("D"),
VOLUNTARY_CANCELLATION("C"),
LOST("L"),
STOLEN("S"),
DAMAGED("E"),
FRAUD("F", true),
MISHANDLING("V"),
ACCOUNT_WITHOUT_CARD("X"),
PREVENTIVE("Y");
private String fiservBlockCode;
private boolean unblockable;
BlockingReason(String fiservBlockCode) {
this(fiservBlockCode, false);
}
public static BlockingReason resolveFromFiservCode(String fiservCode){
return Arrays.stream(values()).filter(blockingReason -> blockingReason.fiservBlockCode.equals(fiservCode)).findAny().orElse(null);
}
} |
Response
Code Block | ||
---|---|---|
| ||
public class CardBlockingResponseDTO {
private String name;
} |
Block/Unblock
Source
Fiserv endpoint:
/cards/pin/status
Class:
FiservRepository
Service:
activateCard
Request
Code Block | ||
---|---|---|
| ||
public class FiservCardPinBlockUnblockRequestDTO {
private String cardNumber;
private Integer cardSequenceNumber;
private String channel;
private Integer organizationNumber;
private String serviceFunctionCode;
} |
Response
Code Block | ||
---|---|---|
| ||
public class FiservCardPinBlockUnblockResponseDTO {
private String cardNumber;
private Integer cardSequenceNumber;
} |
Update Card Pin
Source
Fiserv endpoint:
/cards/pin
Class:
FiservRepository
Service:
activateCard
Request
Code Block | ||
---|---|---|
| ||
public class FiservCardPinUpdateRequestDTO {
private String cardNumber;
private String channel;
private String keyAssociationNumber;
private String newPinBlock;
private Integer organizationNumber;
} |
Response
Code Block | ||
---|---|---|
| ||
public class FiservCardPinUpdateResponseDTO {
private String cardNumber;
} |
Get Security Code Detail
Source
Fiserv endpoint:
/cards/pin/security-codes
Class:
FiservRepository
Service:
activateCard
Request
Code Block | ||
---|---|---|
| ||
public class SecurityCodeDetailsRequestDTO extends AbstractFiservBaseRequest {
private String cardNumber;
private String channel;
private String keyAssociation;
} |
Response
Code Block | ||
---|---|---|
| ||
public class SecurityCodeDetailsResponseDTO {
private String pinEncrypt;
} |
Invalid Attemps
Source
Fiserv endpoint:
/cards/pin/invalid-attemps
Class:
FiservRepository
Service:
activateCard
Request
Code Block | ||
---|---|---|
| ||
public class PinInvalidAttemptsRequestDTO {
private String cardNumber;
private int cardSequenceNumber;
} |
Response
Code Block | ||
---|---|---|
| ||
public class PinInvalidAttemptsResponseDTO {
private PinInvalidAttemptsOutputAreaDTO outputArea;
}
public class PinInvalidAttemptsOutputAreaDTO {
private String cardNumber;
private int cardSequenceNumber;
private int cardInvalidPinTries;
private String cardInvalidPinTryDate;
private int maxNumberInvalidPinTries;
private String exceededInvalidPinTries;
private String blockedIndicator;
} |
Get Credit Card Info
Source
Fiserv endpoint:
/cards/embosser/card-pan
Class:
FiservRepository
Service:
activateCard
Request
Code Block | ||
---|---|---|
| ||
public class FiservCardRequestDTO extends AbstractFiservBaseRequest {
private Integer cardSequence;
private String functionType;
private String cardNumber;
public enum FunctionType {
CARD_NUMBER("C"),
PAN_TOKEN("P");
private String type;
FunctionType(String type) {
this.type = type;
}
public String getValue() {
return type;
}
}
} |
Response
Code Block | ||
---|---|---|
| ||
public class FiservCardResponseDTO {
private Integer organizationNumber;
private Integer logo;
private String cardNumber;
private String accountNumber;
private Integer cardSequence;
private String panToken;
} |
Target (MongoDB Schema)
Collection Name:
cards
Schema
...
language | js |
---|
...
El código se encuentra alojado en el Github y clúster de Genesys / Spin en ambientes de DEV + QA + Stage/Staging
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Mirror
Balance Mirror
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 3.0.8 |
Interfaz | gRPC |
Clúster | Genesys |
Account Mirror
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 3.0.8 |
Interfaz | gRPC |
Clúster | Genesys |
Card Mirror
Tecnología | Gradle |
---|---|
Pipeline | Spin |
Lenguaje | Java 8 |
Spring boot | 2.5 |
Interfaz | Rest |
Clúster | Spin |
Gateway
Fiserv Gateway
Tecnología | Gradle |
---|---|
Pipeline | Spin |
Lenguaje | Java 8 |
Spring boot | 2 |
Interfaz | Rest |
Clúster | Spin |
Account Gateway
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 3.0.8 |
Interfaz | gRPC |
Clúster | Genesys |
Customer Gateway
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 3.0.8 |
Interfaz | gRPC |
Clúster | Genesys |
Aggregation
Account Aggregation
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 3.0.8 |
Interfaz | gRPC / Rest |
Clúster | Genesys |
Customer Aggregation
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 3.0.8 |
Interfaz | gRPC / Rest |
Clúster | Genesys |
Card Aggregation
Tecnología | Gradle |
---|---|
Pipeline | Spin |
Lenguaje | Java 8 |
Spring boot | 2 |
Interfaz | Rest |
Clúster | Spin |
Librerías
Common API
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 3.0.8 |
Interfaz | gRPC |
Clúster | Genesys |
Core Chassis
Tecnología | Maven |
---|---|
Pipeline | Genesys |
Lenguaje | Java 17 |
Spring boot | 2.7.12 |
Interfaz | gRPC |
Clúster | Genesys |