Skip to main content

​
Primary key

document_id
uuiddefault:"Random UUID"publicrequired
The unique identifier for the payment method record.

​
Specific attributes

alias
varcharpublic
An alias for the payment method.
Rules: Max length: 100 characters
card_brand
varcharpublic
The brand of the card.
Rules: Posible values: VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, UNIONPAY, MAESTRO. Max length: 50 characters
card_brand_image
varcharpublic
The image of the brand of the card.
Rules: Max length: 150 characters
card_number
varcharpublicrequired
The card number (likely masked or tokenized for security).
Rules: Max length: 25 characters
card_sender
varcharpublic
The sender of the card, if applicable.
Rules: Max length: 250 characters
card_type
varcharpublicrequired
The type of the card
Rules: Possible values: CREDIT, DEBIT, PREPAID. Max length: 50 characters
card_user
varcharpublicrequired
The name of the card user.
Rules: Max length: 150 characters
card_username
varcharpublicrequired
The username associated with the card.
Rules: Max length: 150 characters
predetermined
booleandefault:"false"publicrequired
Indicates whether this is the predetermined payment method for the account.

​
Foreign keys

account
uuidpublicrequired
The unique identifier of the associated account. Ref: Account Schema
payment_gateway
uuidpublicrequired
The unique identifier of the associated payment gateway. Ref: PaymentGateway Schema

​
Tracking attributes

created_at
timestamppublic
The timestamp when the payment method record was created.
Rules: Precision: 6, with timezone
deleted_at
timestamppublic
The timestamp when the payment method record was deleted, if applicable.
Rules: Precision: 6, with timezone
is_actived
booleandefault:"true"public
Indicates whether the payment method record is active.
is_deleted
booleandefault:"false"public
Indicates whether the payment method record has been deleted.
updated_at
timestamppublic
The timestamp when the payment method record was last updated.
Rules: Precision: 6, with timezone