AppZone API Documentation
  • Overview
    • Welcome
    • Getting Started
    • Enterprise User Oauth
  • Account
    • Account API
      • Create Account
      • Account Enquiry
      • Freeze Account
      • Unfreeze Account
      • Check Freeze Status
      • Place Lien on Account
      • Remove Lien on Account
      • Check Lien Status
      • Activate Post-No-Debit on Account
      • Deactivate Post-No-Debit on Account
      • Check Post-No-Debit Status
      • Retrieve BVN Details
      • Create Customer and Account
      • Update Account Tier2
      • Get Bank One Balance Enquiry
      • Generate Account Statement
      • Get Active Savings Accounts by CustomerID
      • Search Transactions
      • Get Transactions
  • Customer
    • Customer API
      • Create Customer
      • Update Customer
      • Get Customer by Account Number
  • Loans
    • Loan API
      • Get Loans By Customer Id
      • Get Loan Repayment Schedule
      • Loan Creation Application 2
      • Get Loan Account Balance 2
  • Account Officer
  • Standing Order
    • Standing Order API
      • Standing Order Creation Application2
      • Get Standing Orders By Debit Account Number
      • Cancel Standing Order
  • Fixed Deposit
    • Fixed Deposits API
      • Create Fixed Deposit Account
      • Get Fixed Deposit Account By Account Number
      • Get Fixed Deposit Account By Liquidation Account
      • Get Fixed Deposit Account By Phone Number
  • Transfers
    • Transfer API
      • Name Enquiry
      • Intra Bank (Local) Fund Transfer
      • Intra Bank Transfer
  • Cards
    • Cards API
      • Retrieve Institution Configurations
      • Card Request
      • Get Customer Cards
      • Hotlist Customer Card
      • Check Card Generation Status
      • Link Card to Customer Account
      • Freeze Cards
      • Unfreeze Cards
      • Add Transaction Limit to Customer Card
      • View Transaction Limit on Customer Card
      • Update Transaction Limit on Customer Card
      • Disable channel for customer card
      • Get Card Delivery Options
      • Re-Enable Channel for Customer Card
  • Overdraft
    • Overdraft API
      • Create Overdraft
      • Get Overdraft Interests
      • Get Overdraft Fees
  • Transactions
    • Transactions API
      • Transaction Status Confirmation
      • Credit Customer Account
      • Debit Customer Account
      • Reversals
  • Bills Payment
    • Bills Payment API
      • Get Commercial Bank
      • Get Billers
      • Get Billers Category
      • Get Payment Items
      • Initiate Bills Payment Transaction
  • Messaging
    • Save Bulk SMS
    • Save Email
Powered by GitBook
On this page
  1. Cards
  2. Cards API

Retrieve Institution Configurations

This returns the list of configured options available to display to customer when initiating a card request.

Institution Configurations Includes :

  • Card Profiles: This contains a list of available card schemes for an institution on the CMS. A card scheme is assigned to an institution by its Sponsor Bank. An institution can however configure which of its assigned card schemes are available to customers via API requests. This configuration is managed by the institution on BankOne Portal under the Card Management Module.

  • Delivery Options: This returns the list of delivery options already configured by an institution on the CMS

  • Card Request Types: This returns a list of available card request types on the CMS

BatchIssuance: For this request type, the CMS initiates the process of card generation and informs afterwards the sponsor bank to begin card production.

InstantIssuance: For this request type, an institution already has a set of produced physical cards received from the sponsor bank and proceed to assign a card to the requested customer

To retrieve institution configurations you make a get request by appending token to the retrieve institution configuration URL path.

// Live URL
http://api.mybankone.com/thirdpartyapiservice/apiservice/Cards/
RetrieveInstitutionConfig/{Token}

GET https://staging.mybankone.com/thirdpartyapiservice/apiservice/Cards/ RetrieveInstitutionConfig/{Token}

Path Parameters

Name
Type
Description

Token*

String

Authentication Key for the request

{
 "IsSuccessful": true,
 "ResponseDescription": "Successful",
 "CardProfiles": [
 {
 "DisplayName": "Amacc WCF",
 "BIN": "50612402367",
 "Description": "qwert",
 "SponsorBank": "Test Commercial bank"
 },
 {
 "DisplayName": "Chichi Profile",
 "BIN": "50612402093",
 "Description": "For Chibueze Mfb Card",
 "SponsorBank": "Test Commercial bank"
 },
 {
 "DisplayName": "InternetBanking",
 "BIN": "50612402046",
 "Description": "AlvanaMFB",
 "SponsorBank": "Test Commercial bank"
 },
 {
 "DisplayName": "",
 "BIN": "50612402044",
 "Description": "AlvanaMFB",
 "SponsorBank": "Test Commercial bank"
 },
 {
 "DisplayName": "Platinum Card",
 "BIN": "50613602007",
 "Description": "AMMLcard",
 "SponsorBank": "Test Commercial bank"
 },
 {
 "DisplayName": "",
 "BIN": "49206903",
 "Description": "001_001_UBA Test",
 "SponsorBank": "Test Commercial bank"
 }
 ],
 "DeliveryOptions": [
 {
 "OptionName": "Sch delivery",
 "Status": "Active",
 "DeliveryDescription": "School Delivery"
 },
 {
 "OptionName": "house Delivery",
 "Status": "Active",
 "DeliveryDescription": "Deliver to my house"
 },
 {
 "OptionName": "Church Delivery",
 "Status": "Active",
 "DeliveryDescription": "Deliver to my church"
 }
 ],
 "RequestType": [
 "BatchIssuance",
 "InstantIssuance"
 ]
}

PreviousCards APINextCard Request

Last updated 3 years ago