Branch Management
Branch functionality is a key feature of the CoreCard system that allows the client to better distribute the management of sales, distribution, and operations of their card programs. Branch functionality allows the client to set up their sales and distribution network at multiple levels, assign and manage products accordingly. The client can be a bank, program manager, travel agent, or any other type of entity that operates a card program.
BranchClosed
Action: POST
Endpoint: /api/BranchClosed
Use this API to close a Branch.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
BranchCode string Mandatory |
Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "BranchCode": "CC10000" }
Response Fields Detail
Fields | Description |
---|---|
InactiveCards Int32 |
|
CardIntransitToBranch Int32 |
|
CardIntransitToOtherBranch Int32 |
|
AvailableSubBranches Int32 |
|
ErrorFound string |
Indicates result of API processing. If any error found then “Yes”, else “No” |
ErrorMessage string |
Return Error Message in case of Error. Please refer Appendix for Error Code - Message mapping. |
ErrorNumber string |
Return Error Code in case of Error. Please refer Appendix Error Code - Message mapping. |
IsOperation_Successful boolean |
gets or sets IsOperation_Successful |
UniqueID string |
Unique ID Ex: 1234567890123456789 |
UniqueIDflag string |
Unique ID Flag. Valid values: 0 or 1 |
ReplaceVariable string |
gets or sets ReplaceVariable |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": {} }
BranchSearch
Action: POST
Endpoint: /api/BranchSearch
Use this API to search a branch using fields like Branch Name, Branch Code, Branch Location and Branch Status.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
InstitutionID Int32 Mandatory |
Institution ID of product. Valid Values:0-9 Example : 1230 Allowable Values: 4 |
BranchName string Optional |
Branch name Valid values:- A-Z, a-z, 0-9 Example : Georgia Branch Allowable Values: 100 |
BranchCode string Optional |
Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006 Allowable Values: 20 |
BranchStatus string Optional |
whether the branch is Open or close Valid value 1 to 5 1 - Opened 2 - InActive 3 - Deleted 4 - Closed 5 - Moved Example : 1 Allowable Values: 2 |
BranchLocation string Optional |
Location of the branch. Valid values : A-Z, a-z Example: Houston Allowable Values: 100 |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "InstitutionID": 1230, "BranchName": "Convenient Card Top branch", "BranchCode": "CC10000", "BranchStatus": "1", "BranchLocation": "" }
Response Fields Detail
Fields | Description |
---|---|
BranchSearchRecords array |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "BranchSearchRecords": [ { "BranchID": 5737, "BranchName": "Convenient Card Top branch", "BranchCode": "CC10000", "ParentBranchName": "Convenient Card Top branch(CC10000)", "ParentBranchCode": "CC10000", "BranchStatus": "1", "BranchStatusDescription": "Opened", "BranchLocation": "CC10000", "AddressLine1": "Addrress1", "AddressLine2": "Addrress2", "StateorProvince": "NY", "City": "New York City", "Country": "US", "PostalCode": "12345" } ] } }
CreateBranch
Action: POST
Endpoint: /api/CreateBranch
Use this API for Branch Creation.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
InstitutionID Int32 Mandatory |
Institution ID of product. Valid Values:0-9 Example : 1230 Allowable Values: 4 |
BranchCode string Mandatory |
Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006 Allowable Values: 20 |
BranchName string Mandatory |
Branch name Valid values:- A-Z, a-z, 0-9 Example : Georgia Branch Allowable Values: 100 |
ParentBranchCode string Mandatory |
Code of the parent branch. Valid values :A-Z, a-z, 0-9 Example: 0895 Allowable Values: 20 |
BranchLocation string Optional |
Location of the branch. Valid values : A-Z, a-z Example: Houston Allowable Values: 100 |
PostalCode string Mandatory |
Postal Code of Branch Valid Values:A-Z,a-z,0-9 Example: 30093 Allowable Values: 10 |
AddressLine1 string Mandatory |
Address Line 1 of the Branch Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Allowable Values: 50 |
AddressLine2 string Optional |
Address Line 2 of the Branch Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Allowable Values: 50 |
City string Mandatory |
City of Branch Valid values: A-Z, a-z, 0-9 Example: Norcross Allowable Values: 25 |
State string Mandatory |
State of Branch Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US) Allowable Values: 5 |
Country string Mandatory |
Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values Allowable Values: 5 |
BankInfo Int32 Mandatory |
Bank Information. Valid values : 1, 2 1 - Add Bank Information 2 - Use Branch Parent Bank Example: 1 Allowable Values: 1 |
ContactPersonName string Optional |
Name of the contact person of the branch. Valid values : A-Z, a-z Example: Adam Wilson Allowable Values: 50 |
OfficePhoneNumber string Optional |
Office phone number of the branch Valid values are 0-9 Example : 79747955668 Allowable Values: 20 |
MobileNumber string Optional |
Mobile Phone Number of contact person of branch Valid Values: 0-9 Example: 9876543210 Allowable Values: 20 |
FaxNumber string Optional |
Amount to be posted. Valid value: 0-9. Example : 300, 3.5 Allowable Values: 20 |
EmailAddress string Optional |
E Mail Address of Branch Valid Values: A-Z, a-z, 0-9 @ . Example: ansh@gmail.com Allowable Values: 50 |
BankName string Optional |
Name of the bank Valid values are A-Z, a-z, 0-9 Example : BANCFIRST , Bank of America Allowable Values: 200 |
BankAccountOwner string Conditional |
Bank Account Owner's name Valid values : A-Z, a-z Example: Daniel Ross Condition:It is mandatory when BankInfo=1 Allowable Values: 40 |
AccountType string Conditional |
Type of Bank account. Valid vales 0,1 or 2 0 - Checking 1 - Savings 2 - General Ledger Example: 1 Condition:It is mandatory when BankInfo=1 Allowable Values: 9 |
ABANumber string Conditional |
Destination Routing and Transit number of institutions. Valid Values: 0-9 Example: 623852453 Condition:It is mandatory when BankInfo=1 Allowable Values: 9 |
BankAccountNumber string Conditional |
Bank Account Number Valid Values:0-9 Example: 1122345678 Condition:It is mandatory when BankInfo=1 Allowable Values: 30 |
CustomerReceiptInformationText string Optional |
Customer Receipt of the branch. Valid values are A-Z, a-z, 0-9 ,HTML tag Example: Hi CustomerName This is Branch Receipt. Allowable Values: 8000 |
BranchPlasticCodeMappingParameters array Mandatory |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "InstitutionID": 1230, "BranchCode": "CC10000", "BranchName": "Convenient Card Top branch", "ParentBranchCode": "", "BranchLocation": "", "PostalCode": "12345", "AddressLine1": "Address1", "AddressLine2": "Address1", "City": "New York City", "State": "NY", "Country": "US", "BankInfo": 1, "ContactPersonName": "", "OfficePhoneNumber": "8546956325", "MobileNumber": "", "FaxNumber": "", "EmailAddress": "abc@example.com", "BankName": "BANK OF AMERICA, N.A.", "BankAccountOwner": "CC Owner", "AccountType": "1", "ABANumber": "111000012", "BankAccountNumber": "300000000001112", "CustomerReceiptInformationText": "", "BranchPlasticCodeMappingParameters": [ { "ProductID": 1758, "PlasticCode": "34", "ServiceFee": 1.44, "ServiceFeeLoad": 0.34 } ] }
Response Fields Detail
Fields | Description |
---|---|
BranchId Int32 |
Branch ID Valid values: 0-9 Example: 1001 |
BranchCode string |
Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006 |
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": { "BranchId": 5757, "BranchCode": "CC10000" } }
GetBranchDetails
Action: POST
Endpoint: /api/GetBranchDetails
Use this API to get Branch Details by providing Branch code.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
BranchCode string Mandatory |
Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006 Note: It will required for get Branch Detail |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "BranchCode": "CC10000" }
Response Fields Detail
Fields | Description |
---|---|
AddressInformation
|
|
BranchInformation
|
|
CustomerInformation
|
|
BranchBankAccountParameters
|
|
BranchPlasticCodeMappingParameters array |
Sample Response Body
{ "Message": "Processed Successfully.", "Status": true, "ErrorCode": "00000", "ResponseData": { "AddressInformation": { "Addressline1": "Addrress1", "Addressline2": "Addrress2", "City": "New York City", "State": "NY", "Country": "US", "Postalcode": "12345" }, "BranchInformation": { "InstitutionID": 1230, "BranchID": 5757, "ParentBranchName": "", "BranchName": "Convenient Card Top branch", "ParentBranchCode": "", "BranchCode": "CC10000", "BranchStatus": "1", "BranchLocation": "Convenient Card Top branch", "CustomerReceiptInfo": "", "BankInformation": "1" }, "CustomerInformation": { "ContactName": "CC Manager", "OfficePhoneNumber": "", "MobilePhoneNumber": "", "FaxNumber": "", "EmailAddress": "" }, "BranchBankAccountParameters": { "BankName": "BANK OF AMERICA, N.A.", "BankAccountOwner": "CC owner", "AccountType": "1", "ABANumber": "111000012", "BankAccountNumber": "300000000001112" }, "BranchPlasticCodeMappingParameters": [ { "ProductID": 1755, "ProductName": "Convenient Visa Incentive Card", "PlasticCode": "34", "PlasticCodeName": "Corporate Incentive Card/Valid (34)", "ServiceFee": 1.23, "ServiceFeeLoad": 3.45 } ] } }
UpdateBranch
Action: POST
Endpoint: /api/UpdateBranch
Use this API for updating Branch information like address and phone number.
Request Fields Detail
Fields | Description |
---|---|
APIVersion string Mandatory |
Version of the API to be invoked Example: 1.3 Allowable Values: 10 |
IPAddress string Mandatory |
IP Address of sender Example: 10.206.0.204 Allowable Values: 15 |
Source string Mandatory |
Source from where API Call is initiated. CoreCard have multiple value of source for internal system (CoreMoney, SelfService, IVR, MobileSelfService) For external system expected source will be WEB. Allowable Values: 50 |
CallerID string Optional |
Caller Id of source from where API is initiated. It is End User phone number. Example: 7204454214 Condition - applicable in Case of IVR Allowable Values: 20 |
CalledID string Optional |
Called Id of destination for which API is initiated. It is Corecard IVR number. Example: 7314145404 Condition - applicable in Case of IVR Allowable Values: 20 |
SessionID string Optional |
Reserved for future use Allowable Values: 50 |
ANI string Optional |
Reserved for future use Allowable Values: 0 |
DNS string Optional |
Reserved for future use Allowable Values: 0 |
Language string Optional |
Flag to retrieve error message in specific language Example: 'en' for English Allowable Values: 2 |
RequestDate string Optional |
Request Date Time of API Format: MM-DD-YYYYTHH:MM:SS Example:- 11-12-2021T13:05:10 Allowable Values: 19 |
InstitutionID Int32 Mandatory |
Institution ID of product. Valid Values:0-9 Example : 1230 Allowable Values: 4 |
BranchCode string Mandatory |
Code assigned to branch from where the card was issued. Valid Values:0-9, A-Z Example:C1006 Allowable Values: 20 |
BranchID Int32 Mandatory |
Branch ID Valid values: 0-9 Example: 1001 Allowable Values: 4 |
BranchName string Mandatory |
Branch name Valid values:- A-Z, a-z, 0-9 Example : Georgia Branch Allowable Values: 100 |
BranchLocation string Optional |
Location of the branch. Valid values : A-Z, a-z Example: Houston Allowable Values: 100 |
PostalCode string Mandatory |
Postal Code of Branch Valid Values:A-Z,a-z,0-9 Example: 30093 Allowable Values: 10 |
AddressLine1 string Mandatory |
Address Line 1 of the Branch Valid values : A-Z, a-z, 0-9 Example: 15 Penang Street Point Allowable Values: 50 |
AddressLine2 string Optional |
Address Line 2 of the Branch Valid values: A-Z, a-z, 0-9 Example: 1 mecca way Allowable Values: 50 |
City string Mandatory |
City of Branch Valid values: A-Z, a-z, 0-9 Example: Norcross Allowable Values: 25 |
State string Mandatory |
State of Branch Valid values are A-Z, a-z Example: GA Please refer Appendix Section : State Codes(US) Allowable Values: 5 |
Country string Mandatory |
Two Character Country Code Valid values :A-Z, a-z Example: US Refer Appendix section : Country Code Values Allowable Values: 5 |
BankInfo Int32 Mandatory |
Bank Information. Valid values : 1, 2 1 - Add Bank Information 2 - Use Branch Parent Bank Example: 1 Allowable Values: 1 |
ContactPersonName string Optional |
Name of the contact person of the branch. Valid values : A-Z, a-z Example: Adam Wilson Allowable Values: 50 |
OfficePhoneNumber string Optional |
Office phone number of the branch Valid values are 0-9 Example : 79747955668 Allowable Values: 20 |
MobileNumber string Optional |
Mobile Phone Number of contact person of branch Valid Values: 0-9 Example: 9876543210 Allowable Values: 20 |
FaxNumber string Optional |
FAX number of branch Valid values are 0-9 Example:9632581470 Allowable Values: 20 |
EmailAddress string Optional |
E Mail Address of Branch Valid Values: A-Z, a-z, 0-9 @ . Example: ansh@gmail.com Allowable Values: 50 |
BankName string Optional |
Name of the bank Valid values are A-Z, a-z, 0-9 Example : BANCFIRST , Bank of America Allowable Values: 200 |
BankAccountOwner string Conditional |
Bank Account Owner's name Valid values : A-Z, a-z Example: Daniel Ross Condition:It is mandatory when BankInfo=1 Allowable Values: 40 |
AccountType string Conditional |
Type of Bank account. Valid vales 0,1 or 2 0 - Checking 1 - Savings 2 - General Ledger Example: 1 Condition:It is mandatory when BankInfo=1 Allowable Values: 9 |
ABANumber string Conditional |
Destination Routing and Transit number of institutions. Valid Values: 0-9 Example: 623852453 Condition:It is mandatory when BankInfo=1 Allowable Values: 9 |
BankAccountNumber string Conditional |
Bank Account Number Valid Values:0-9 Example: 1122345678 Condition:It is mandatory when BankInfo=1 Allowable Values: 30 |
CustomerReceiptInformationText string Optional |
Customer Receipt of the branch. Valid values are A-Z, a-z, 0-9 ,HTML tag Example: Hi CustomerName This is Branch Receipt. Allowable Values: 8000 |
BranchPlasticCodeMappingParameters array Mandatory |
Sample Request Body
{ "APIVersion": "1.3", "IPAddress": "10.206.2.197", "Source": "WEB", "CallerID": "", "CalledID": "", "SessionID": "", "ANI": "", "DNS": "", "Language": "en", "RequestDate": "", "InstitutionID": 1230, "BranchCode": "CC10000", "BranchID": 5737, "BranchName": "Convenient Card Top branch", "BranchLocation": "", "PostalCode": "12345", "AddressLine1": "Address1", "AddressLine2": "Address1", "City": "New York City", "State": "NY", "Country": "US", "BankInfo": 1, "ContactPersonName": "", "OfficePhoneNumber": "", "MobileNumber": "", "FaxNumber": "", "EmailAddress": "abc@example.com", "BankName": "BANK OF AMERICA, N.A.", "BankAccountOwner": "CC Owner", "AccountType": "1", "ABANumber": "111000012", "BankAccountNumber": "300000000001112", "CustomerReceiptInformationText": "", "BranchPlasticCodeMappingParameters": [ { "ProductID": 1758, "PlasticCode": "34", "ServiceFee": 1.44, "ServiceFeeLoad": 0.34 } ] }
Response Fields Detail
Fields | Description |
---|
Sample Response Body
{ "Message": "Successful.", "Status": true, "ErrorCode": "00000", "ResponseData": {} }