@bebapps/rapyd-sdk
Version:
An un-official [Rapyd](https://rapyd.net) SDK for Node.js.
95 lines (94 loc) • 2.65 kB
text/typescript
export interface CardDetails {
/**
* The ID of the hosted page. String starting with **hp\_issued\_**.
* Response only.
*/
id: string;
/**
* In the request, the ID of the issued card, a string starting with **ci_** or **card_**.
*
* In the response, an object containing the following fields:
* - `name` - The name of the person that the card is issued to.
* - `network` - The card network of the issued card.
*/
card: unknown;
/**
* The color of the card, specified by one of the following:
* - hexadecimal value
* - RGB
* - RGBA
* - CSS color name
* The default is **black**.
*/
card_color: string;
/**
* Time when the page URL expires, in [*Unix time*](ref:glossary). 5 minutes from creation of the page.
* Response only.
*/
expiration: number;
/**
* Determines the default language of the hosted page.
* The values are listed on [Hosted Page Language Support](ref:hosted-page-language-support).
*/
language: string;
/**
* The URL of the logo image that appears on the card. If the logo is 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';
/**
* The name that appears in the card image if nothing is specified for `logo`. To change this value, contact [Client Support](doc:client-support).
* Response only.
*/
merchant_alias: string;
/**
* Color for the client's website, defined in the Client Portal.
* Response only.
*/
merchant_color: string;
/**
* Contact details for customer support, containing the following fields:
* - `email` - Email address.
* - `url` - URL for the client's customer support service.
* - `phone_number` - Phone number for contacting the client's customer support service.
*
* To configure these fields, use the Client Portal.
*
* Response only.
*/
merchant_customer_support: { email: unknown; url: unknown; phone_number: unknown };
/**
* Language of the displayed page.
*
* Response only.
*/
merchant_language: string;
/**
* URL for the image of the client's logo.
*
* Response only.
*/
merchant_logo: string;
/**
* URL of the client's website.
* Response only.
*/
merchant_website: string;
/**
* URL where the customer is redirected to view an image of the card.
*
* Response only.
*/
redirect_url: string;
/**
* Reserved.
* Response only.
*/
status: string;
};