Create Card

Create Customer Card

The Create Card endpoint is used to issue a new card to a customer's account. The user must specify the customer's account ID, the currency for the card, and various compliance-related fields such as customer subtype, business activity, occupation, and source of funds. With this information, a new card can be created and linked to the customer's account. Once the card is issued, it's initially suppressed (deactivated) until it's activated by the customer or manager.

• Endpoint: /api/v1/customer/cards/create

• Method: POST

• Request Format: application/json

• Header Parameter

  • otp : required

Request Body

{
  "customersId": 14387,                     // required, number, e.g., 1001, 14387
  "currency": "USD",                        // required, string, possible: "USD"
  "cardReferenceId": "CARD-REF-001",       // required, string, can be any identifier
  "shippingMethod": "Standard",             // required, string, possible: "Standard", "Express"
  "cardProgramID": 1002,                    // required, number, must match an existing program ID
  "cardType": "Physical",                  //Physical OR Virtual
  "shippingAddress": {
    "shippingAddressLine1": "Suite 500",    // required, string, street or suite number
    "shippingAddressCity": "New York",      // required, string, valid city name
    "shippingAddressState": "Texas",        // required, string, state name or abbreviation
    "shippingAddressPostcode": "55050",     // required, string, postal/ZIP code
    "shippingAddressCountry": "USA"         // required, string, ISO country code or name
  },
  // Only required for customers older than 6 months
  "businessReviewDetails": {
    "legalEntityName": "Acme Corporation",              // required, string
    "doingBusinessAs": "Acme Co",                       // required, string
    "entityType": "LLC",                                // required, string, possible: "LLC", "Corporation", "Partnership", "Sole Proprietor"
    "registeredAddressStreet": "123 Main St",           // required, string
    "registeredAddressNumber": "10",                    // optional, string
    "registeredAddressCity": "Austin",                  // required, string
    "registeredAddressState": "TX",                     // required, string
    "registeredAddressPostcode": "73301",               // required, string
    "registeredAddressCountry": "USA",                  // required, string
    "operatingAddressStreet": "500 Market St",          // optional*, string, required if any operating field provided
    "operatingAddressNumber": "Suite 2",                // optional, string
    "operatingAddressCity": "Dallas",                   // optional*, string
    "operatingAddressState": "TX",                      // optional*, string
    "operatingAddressPostcode": "75001",                // optional*, string
    "operatingAddressCountry": "USA",                   // optional*, string
    "businessActivities": ["Retail", "E-commerce"],    // required, array of strings, at least one
    "regionOfOperations": ["USA", "EU"],               // required, array of strings, at least one
    "fundsReceivedFromUSA": true,                       // required, boolean, true/false
    "fundsSentToUSA": false,                            // required, boolean, true/false
    "hasOwnershipStructureChangedSinceOnboarding": false,                                                        // required, boolean, cannot be TRUE
    "sourceOfFunds": ["Business Revenue", "Investments"],  // required, array of strings, at least one
    "authorizedCapital": 100000,                        // required, number, must be > 0
    "comingYearTurnOverPlanned": 500000                 // required, number, must be > 0
  },
  "personalReviewDetails": {
    "sourceOfFunds": ["Salary", "Investments"],       // required, array of strings, at least one
    "estimatedGrossAnnualIncome": 90000,              // required, number, must be > 0
    "estimatedNetWorth": 250000,                      // required, number, must be > 0
    "activelyEmployed": true,                          // required, boolean
    "employedCompanyName": "Global Tech Inc",        // required, string
    "employedJobTitle": "Software Engineer"          // required, string
  }
}

Response Body

{
  "id": 1359,
  "details": {
    "customersId": 14387,
    "customersReference": "card-ref-1",
    "card": {
      "id": 1359,
      "currency": "USD",
      "cardNumber":"9aUb61b4b0EDk92pD7SCOg==",
      "totalBalance": 0,
      "availableBalance": 0,
      "pendingBalance": 0,
      "bDeactivated": true
    }
  },
  "status": "1",
  "errors": []
}