8. Buyer Cards
7.1 Overview
Card: Users can add Cards to CPX buyers. Users can add Lodged or External Cards for the buyer. Using an external card, users can pay suppliers via their credit card. Users can add at max 2 external cards.
7.2 Attributes
| Field | Sub-field | Type | Description |
|---|---|---|---|
| totalRecords | Integer | Total number of records available | |
| totalType | String | Whether the records returned are an exact or in range | |
| recordCount | Number of records fetched | ||
| records | Array of objects | Details of the records fetched | |
| acl | Array | access control list for the cards fetched | |
| type | enum | Type of Card being added
| |
| cardHolderName | String | Name of Card holder | |
| cardRuleId | String | ID of card rule Not applicable for External Card | |
| id | String | Id/token of card product in CPX | |
| cardNumber | String | Card Number | |
| cvv | Security code/CVV for the card | ||
| securityCode | String | Security code/CVV for the card | |
| expirationString | String | Card expiry month and year | |
| expirationDate | String | Card expiry Date | |
| payments | Number | Payment Count corresponding to the card in relevant card statuses. | |
| availableBalance | Number | Current Balance on Card as per Card processor | |
| address | Object | Address details of the card holder/ Billing address details | |
| street1 | String | street address | |
| city | String | City | |
| state | String | State | |
| postalCode | String | Postal Code | |
| country | String | Country | |
| isDefault | enum | If the card is to be used as default card Only applicable for external card | |
| creditLimit | string | Credit limit for the card Only for P card | |
| dailySpendLimit | string | Daily spend limit for the card Only for P card | |
| sid | string | SupplierID of the supplier Only for P and Exact match cards | |
| network | Network associated with institution of buyer for which cards are listed | ||
| id | Id of Network associated with institution of buyer for which cards are listed | ||
| name | Name of network associated with institution of buyer for which cards are listed | ||
| nid | NID of Network associated with institution of buyer for which cards are listed | ||
| institution | Institution associated with buyer for which cards are listed | ||
| id | Id of Institution associated with buyer for which cards are listed | ||
| name | Name of Institution associated with buyer for which cards are listed | ||
| fid | FID of Institution associated with buyer for which cards are listed | ||
| vcnHost | vcnHost set for the Institution associated with buyer for which cards are listed | ||
| corpId | corpId set for the Institution associated with buyer for which cards are listed | ||
| buyer | Buyer for which cards are listed | ||
| id | Id of Buyer for which cards are listed | ||
| name | Name of Buyer for which cards are listed | ||
| bid | BID of Buyer for which cards are listed | ||
| vcnHost | vcnHost set for the Buyer for which cards are listed | ||
| supplier | Supplier associated with the card product | ||
| id | Id of Supplier associated with the card product | ||
| name | Name of Supplier associated with the card product | ||
| sid | SID of Supplier associated with the card product | ||
| vcnReference | vcnReference of the card product | ||
| vcnStatus | Status of the card product | ||
| pending | Date and time of creation of request of Lodged / Exact Match Card | ||
| success | Date and time of successful creation of Lodged / Exact Match Card | ||
| source | source / card provider of card product | ||
| cardType | Type of card Product | ||
| deleted | Boolean | Whether the card product is deleted | |
| disabled | Boolean | Whether the card product is disabled | |
| created | string | Date and time of creation of card product | |
| creator | id | string | Id of user creating the card product |
| username | string | Username of user creating the card product | |
| modified | string | Date and time of last modification of card product | |
| modifier | id | string | Id of user who has last modified the card product |
| username | string | Username of user who has last modified the card product | |
| cardRules | Array of objects | Card Rules associated with card products | |
| id | Id of card rule in CPX | ||
| host | string | VCN host for the card rule | |
| ruleType | enum | Rule type | |
| type | enum | Type of Card Rule Values | |
| name | string | Name of Card Rule | |
| expirationDays | string | Number of days after which card created by card rule expires. | |
| ruleValue | string | Template ID or Rule value for Card Rule | |
| isExactAmount | boolean | If amount should be an exact match to authorization to be authorized | |
| isDefault | boolean | If the card rule is default card rule | |
| billLevel | string | Billing level for Card rule |
7.3 Operations
7.3.1. Create Card
7.3.2. Delete Card
7.3.3. Update Card
7.3.4. Get Card List
Updated 3 days ago