UNPKG

@bebapps/rapyd-sdk

Version:

An un-official [Rapyd](https://rapyd.net) SDK for Node.js.

175 lines (173 loc) 5.59 kB
import { WalletContact } from '../../wallet/types/WalletContact'; export interface IssuedCard { /** * ID of the Issued Card object, a string starting with **ci_**. */ id: `ci_${string}`; /** * Time that the card was activated, in [*Unix time*](ref:glossary). Response only. */ activated_at: number; /** * Time that the card was assigned to a cardholder, in [*Unix time*](ref:glossary). Response only. */ assigned_at: number; /** * Bank Identifier Number for the institution issuing the card. Response only. */ bin: string; /** * Bank Identifier Number. Webhook only. */ bin_number: string; /** * Reason for blocking the card. One of the following: * - **blocked_reversible** * - **canceled** * - **compliance** * - **locked_incorrect_pin** * - **migrated** * - **none** - This is the default. * - **other** * - **reissued** * - **suspected_fraud** */ blocked_reason: 'blocked_reversible' | 'canceled' | 'compliance' | 'locked_incorrect_pin' | 'migrated' | 'none' | 'other' | 'reissued' | 'suspected_fraud'; /** * Card number or ID of the Card object, which is a string starting with **card_**. */ card: `card_${string}`; /** * The color of the card, specified by one of the following: * - HEX value - Color value * - RGB - Color code, six HEX digits. See [here](https://www.w3.org/wiki/CSS/Properties/color/RGB). * - RGBA - Color code * - Name - CSS color name. * If `card_color` value is not specified, the color is black. */ card_color: number; /** * ID of the Card object. String starting with **card_**. */ card_id: `card_${string}`; /** * Actual card number. */ card_number: string; /** * ID of the card program that the card is issued from. String starting with **cardprog_**. Required if `country` is blank or the client is licensed for two or more card programs in the country. To get the IDs your company is licensed for, contact [Client Support](doc:client-support). */ card_program: `cardprog_${string}`; /** * ID of the wallet contact that a card is assigned to. String starting with **cont_**. * * Relevant to [List Issued Cards](ref:list-issued-cards). */ contact: `cont_${string}`; /** * The country where the card is issued. Two-letter ISO 3166-1 ALPHA-2 code. Uppercase. Required if `card_program` is blank. */ country: string; /** * The country where the card is issued. Two-letter ISO 3166-1 ALPHA-2 code. Response only. */ country_iso_alpha_2: string; /** * Time of creation of the issued card object, in [*Unix time*](ref:glossary). Response only. */ created_at: number; /** * Currency or list of currencies. Three-letter ISO 4217 code for each currency. Uppercase. */ currency: (string)[]; /** * Indicates how many currencies are supported. One of the following: * - **single** - The card supports one currency. * - **multi** - The card supports several currencies. * * Response only. */ currency_type: 'single' | 'multi'; /** * Card security code. */ cvv: string; /** * Details of the issued card: * - `bin` - Bank Identifier Number. * - `last4` - Last four digits of the card. * - `sub_bin` - Card program. * - `expiration` - Month and year of the card expiration. * * Webhook only. */ details: object; /** * Expiration month of the card. Two digits. Relevant when the card issuer supports it for the country. */ expiration_month: string; /** * Expiration year of the card. Two digits. Relevant when the card issuer supports it for the country. */ expiration_year: string; /** * ID of the wallet contact that the card is assigned to. String starting with **cont_**. * Describes details about the wallet contact that the card is assigned to. See [Wallet Contact Object](ref:wallet-contact-object). Response only. */ ewallet_contact: `cont_${string}` | Partial<WalletContact>; /** * ID of the wallet contact that the card is assigned to. String starting with **cont_**. */ ewallet_contact_id: `cont_${string}`; /** * The URL of the logo image that appears on the card. If not specified, the name of the merchant appears. */ logo: string; /** * The orientation of the logo. One of the following: * - **landscape** - This is the default. * - **square** * - **portrait** */ logo_orientation: 'landscape' | 'square' | 'portrait'; /** * A JSON object defined by the client. */ metadata: object; /** * PIN code for the card. Must be a string. */ new_pin: string; /** * Page number to retrieve. * * Relevant to [List Issued Cards](ref:list-issued-cards). */ page_number: string; /** * Number of results per page, up to 100. Default is **10**. * * Relevant to [List Issued Cards](ref:list-issued-cards). */ page_size: string; /** * Instruction to change the status of the card. One of the following: * - **block** - Change status to **BLO**. * - **unblock** - Change status from **BLO** to **ACT**. * * Relevant to request to update issued card. * Status of the card. One of the following: * - **ACT** - Active. * - **BLO** - Blocked. * - **CAN** - Cancelled. * - **IMP** - Imported in bulk, but not yet personalized. * - **INA** - Inactive. * * Response only. */ status: 'block' | 'unblock' | 'ACT' | 'BLO' | 'CAN' | 'IMP' | 'INA'; /** * Two-digit code for the card program. Response only. */ sub_bin: string; };