Payment models
Payment models manage credit card information, billing agreements, and payment method configurations within Chargeworx.CreditCard / CreditCardNumber
Stores credit card payment method information with PCI-compliant data handling.CreditCard
| Property | Type | Description |
|---|---|---|
| Id | Guid | Unique card identifier |
| PersonId | Guid | Associated person reference |
| Last4 | String | Last 4 digits of card number |
| ExpirationMonth | Int | Card expiration month |
| ExpirationYear | Int | Card expiration year |
| CardType | String | Card brand (Visa, Mastercard, etc.) |
| IsActive | Boolean | Card active status |
CreditCardNumber
Stores tokenized or encrypted card numbers separately from card metadata.| Property | Type | Description |
|---|---|---|
| Id | Guid | Unique identifier |
| CreditCardId | Guid | Associated credit card reference |
| EncryptedNumber | String | Encrypted card number |
| Token | String | Processor token reference |
Relationships
- CreditCard belongs to a Person
- CreditCardNumber belongs to a CreditCard
CompanyProjectCreditCardPaymentInfo
Links credit cards to specific company projects for payment processing.Key properties
| Property | Type | Description |
|---|---|---|
| Id | Guid | Unique identifier |
| CompanyId | Guid | Associated company |
| ProjectId | Guid | Associated project |
| CreditCardId | Guid | Associated credit card |
| IsDefault | Boolean | Default payment method flag |
Relationships
- Belongs to a Company
- Belongs to a Project
- References a CreditCard
CompanyProjectBillingAgreement
Manages recurring billing agreements and subscription configurations.Key properties
| Property | Type | Description |
|---|---|---|
| Id | Guid | Unique identifier |
| CompanyId | Guid | Associated company |
| ProjectId | Guid | Associated project |
| AgreementId | String | External agreement reference |
| Status | String | Agreement status |
| StartDate | DateTime | Agreement start date |
| EndDate | DateTime? | Agreement end date |
Relationships
- Belongs to a Company
- Belongs to a Project
Person / Address / PersonAddress
Customer and billing address information models.Person
Represents a customer or cardholder.| Property | Type | Description |
|---|---|---|
| Id | Guid | Unique person identifier |
| FirstName | String | First name |
| LastName | String | Last name |
| String | Email address | |
| Phone | String | Phone number |
Address
Physical address information.| Property | Type | Description |
|---|---|---|
| Id | Guid | Unique address identifier |
| Street1 | String | Street address line 1 |
| Street2 | String | Street address line 2 |
| City | String | City |
| State | String | State/province |
| PostalCode | String | Postal/ZIP code |
| Country | String | Country code |
PersonAddress
Links persons to addresses.| Property | Type | Description |
|---|---|---|
| PersonId | Guid | Associated person |
| AddressId | Guid | Associated address |
| AddressType | String | Address type (Billing, Shipping) |
Relationships
- Person has many Addresses through PersonAddress
- Address has many Persons through PersonAddress