COMING SOON
Issue a new debit, credit, prepaid, or gift card to a Customer Account. A new integrated Financial Account will be created for the issued card.
To issue a new card, you will need:
Issued cards are shipped in an inactive state. Use the Activate Card API to activate a card once it has been received by the Customer.
POST /v1/integrated-cards
Authorization: Bearer <access_token>
Idempotency-Key: <key>
where <key> is a v4 UUID or any other unique string with a minimum length of 6 characters and a maximum length of 255 characters.
The idempotency key identifies the request. If a network error occurs, you can safely retry the request using the same idempotency key and the request will only be executed once. This ensures that calling the API multiple times will not result in duplicate requests. For more information, see Idempotent Calls.
name REQUIRED
string, min length: 1, max length: 100
Name for the Financial Account. This is an informal name used for the account in RocketKOR. The issued card is linked to this Financial Account.
subtype REQUIRED
string enum, values: DEBIT, CREDIT, PREPAID, GIFT
Type of card.
defaultFlag
boolean, default: false
Whether this is the Customer’s default Financial Account for transactions. If set to true, defaultFlag will be set to false for the Customer’s previous default Financial Account.
currency REQUIRED
string, min length: 3, max length: 3, default value: USD
Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code. RocketKOR supports USD and CAD currencies.
accountHolderId REQUIRED
string (UUID)
ID of the Customer Account for which the card is being issued.
card REQUIRED
object
Details for the issued card attached to the Financial Account.
solution REQUIRED
string
Name of the RocketKOR solution used for the card issuance.
startingNumber REQUIRED
string
Starting numbers for the card as defined in the Card Program. These numbers identify the card BIN (Bank Identification Number) and the Card Program ID.
programId REQUIRED
string
Card Program ID.
shippingMethod
string enum, values: NORMAL, URGENT, VIP, BULK, BULK_URGENT, BULK_VIP
default value: NORMAL
Card shipping method. The following values are supported:
extraEmbossingLine
string
Information to print on the 4th embossing line of the card.
usCitizen REQUIRED
boolean
Whether the Customer is a citizen of the United States.
referralSource
string
Referral link/URL in the client application that is the source of the request.
acceptedTermsDate REQUIRED
string (date), format: yyyy-MM-dd
Date that the terms and conditions were accepted in the client application.
readPrivacyPolicyDate REQUIRED
string (date), format: yyyy-MM-dd
Date the privacy policy was marked as read in the client application.
acceptedAgreement REQUIRED
boolean
Whether the cardholder agreement was accepted in the client application.
alertType
string enum, values: ADMIN_ONLY, ADMIN_PROMO, NEITHER
Type of alerts to send to the Customer. The following values are supported:
issuedLanguageCode
string
Language code for the language in which the card is issued. The following values are supported:
nameOnCard
string, min length: 1, max length: 60
Customer’s name as it appears on the card.
Returns the Issued Card Financial Account object. This object contains details about the integrated Financial Account, the Issued Card object (which contains details for the issued card), and the Issued Card Provider Details object (which contains provider details for the issued card).
SAMPLE REQUEST
{
"name": "Debit Card",
"subtype": "CREDIT",
"defaultFlag": false,
"currency": "USD",
"accountHolderId": "6d0b12d8-6e9d-4021-85da-b42ab3845f11",
"card": {
"solution": "card-issuing",
"startingNumber": "412345",
"programId": "123",
"shippingMethod": "NORMAL",
"extraEmbossingLine": "",
"usCitizen": true,
"referralSource": "www.abc.com",
"acceptedTermsDate": "2023-02-09",
"readPrivacyPolicyDate": "2023-02-09",
"acceptedAgreement": true,
"alertType": "ADMIN_ONLY",
"issuedLanguageCode": "en_US"
}
}
SAMPLE RESPONSE
{
"id": "7d08a89d-2ac5-4ed3-a6ca-ad7c974c994e",
"businessAccountId": "b535dce9-b71a-4f7b-b27f-73e47b13e7a5",
"name": "Debit Card",
"category": "INTEGRATED",
"type": "CARD",
"subtype": "DEBIT",
"defaultFlag": false,
"currency": "USD",
"accountHolderId": "6d0b12d8-6e9d-4021-85da-b42ab3845f11",
"accountHolderType": "CUSTOMER",
"state": "ACTIVE",
"stateReason": "CARD_ACTIVATED",
"maskedAccountNumber": "******4823",
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"createdAt": "2021-09-20T22:09:31.947Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"updatedAt": "2021-10-20T22:09:31.947Z",
"card": {
"firstName": "Mark",
"middleName": "David",
"lastName": "Strong",
"cardNumberTail": "4242",
"expiry": "2027-12",
"billingAddress": {
"addressLine1": "625 Queen St",
"addressLine2": "",
"addressLine3": "",
"city": "Vancouver",
"stateCode": "BC",
"countryCode": "CAN",
"postalCode": "V5K 0A1"
}
},
"_embedded": {
"providerDetails": {
"solution": "card-issuing",
"startingNumber": "412345",
"programId": "123",
"shippingMethod": "NORMAL",
"extraEmbossingLine": "",
"usCitizen": true,
"referralSource": "www.abc.com",
"acceptedTermsDate": "2023-02-09",
"readPrivacyPolicyDate": "2023-02-09",
"acceptedAgreement": true,
"alertType": "ADMIN_ONLY",
"issuedLanguageCode": "en_US",
"cardNumber": "412345987442231477",
"expiry": "2027-12",
"nameOnCard": "John Smith",
"issuedDateTime": "2023-02-09",
"reissueDateTime": "2023-03-09",
"reissueType": "REISSUED_FOR_SAME_CARD_NUMBER",
"reissueReason": "DAMAGED",
"externalBankAccount": {
"bankName": "Citibank",
"routingNo": "228264850",
"accountNumber": "16322",
"accountNumberTail": "22",
"nameOnAccount": "Mary Jones",
"businessName": "ABC Corporation"
},
"externalCardReferenceId": "123456",
"fulfillmentHouse": "123456"
}
}
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
