Get Payment Tokens

Description

Queries stored payment methods for display in customer payment method lists or selection interfaces. Returns masked card information (last 4 digits, expiration date) without exposing sensitive data.

Input

Path Parameter: projectId (guid, required) — Project identifier for authentication.
Query Parameters: model (CompanyProjectCreditCardPaymentInfoQueryRequest) — Query filters.

Output

Returns a CompanyProjectCreditCardPaymentInfoQueryResponse containing masked payment information entries.

Example Request

GET /api/payment/{projectId}/credit-card-payment-info
X-API-Key: {your-api-key}

Example Response

{
  "success": true,
  "code": 200,
  "entries": [
    {
      "id": "abc123",
      "maskedCardNumber": "************1111",
      "expirationDate": "12/2025",
      "cardType": "Visa"
    }
  ]
}

Errors

401 Unauthorized — Invalid or missing API key.
404 Not Found — Project not found.

Notes

Card numbers are masked showing only last 4 digits.
Results include payment tokens for use in subsequent transactions.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

projectId

string<guid>

required

The project identifier for authentication.

Query Parameters

string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities. Represents the response returned when querying credit card payment information for company projects.

success

boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

code

enum<string>

Result code indicating the outcome of the operation.

Available options:

Unknown,

Success,

BadRequest,

Unauthorized,

NotFound,

Error

Example:

200

errorMessage

string | null

Human-readable error message when an error occurs.

Example:

null

entries

object[] | null

Collection of entities matching the query criteria.

Show child attributes

entries.id

string<guid>

Unique identifier for this entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

entries.dateCreated

string<date-time>

UTC timestamp when this entity was created.

Example:

"2025-10-30T10:30:00Z"

entries.personAddress

object

Name and Address

Show child attributes

entries.personAddress.id

string<guid>

Unique identifier for this entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

entries.personAddress.dateCreated

string<date-time>

UTC timestamp when this entity was created.

Example:

"2025-10-30T10:30:00Z"

entries.personAddress.person

object

The personal identity details linked to the address.

Show child attributes

entries.personAddress.person.firstName

string | null

The person's given name.

Example:

"Jordan"

entries.personAddress.person.lastName

string | null

The person's family name.

Example:

"Nguyen"

Example:

{
  "FirstName": "Jordan",
  "LastName": "Nguyen"
}

entries.personAddress.address

object

The physical address tied to the person.

Show child attributes

entries.personAddress.address.addressLine1

string | null

The primary street line of the address.

Example:

"1600 Amphitheatre Parkway"

entries.personAddress.address.addressLine2

string | null

The optional secondary street line of the address.

Example:

"Suite 200"

entries.personAddress.address.city

string | null

The city portion of the address.

Example:

"Mountain View"

entries.personAddress.address.state

string | null

The state or province portion of the address.

Example:

"CA"

entries.personAddress.address.zip

string | null

The postal code portion of the address.

Example:

94043

Example:

{
  "AddressLine1": "1600 Amphitheatre Parkway",
  "City": "Mountain View",
  "State": "CA",
  "Zip": "94043"
}

Example:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dateCreated": "2025-10-30T10:30:00Z"
}

entries.companyProject

object

Company project information

Show child attributes

entries.companyProject.id

string<guid>

Unique identifier for this entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

entries.companyProject.dateCreated

string<date-time>

UTC timestamp when this entity was created.

Example:

"2025-10-30T10:30:00Z"

entries.companyProject.isActive

boolean

True if the entity is active; false if deactivated.

Example:

true

entries.companyProject.dateModified

string<date-time>

UTC timestamp of the most recent modification to this entity.

Example:

"2025-10-30T15:45:00Z"

entries.companyProject.comments

string | null

The free-form comments associated with the project.

entries.companyProject.softDescriptor

string | null

The soft descriptor sent to payment processors.

entries.companyProject.phone

string | null

The public contact phone number for the project.

entries.companyProject.projectName

string | null

The name of the project.

entries.companyProject.companyId

string<guid>

The identifier of the owning company.

entries.companyProject.companyName

string | null

The name of the owning company.

entries.companyProject.usersCount

integer<int32>

The number of users assigned to the project.

entries.companyProject.recaptchaThreshold

number<double> | null

The configured reCAPTCHA threshold for the project.

Example:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dateCreated": "2025-10-30T10:30:00Z",
  "isActive": true,
  "dateModified": "2025-10-30T15:45:00Z"
}

entries.creditCard

object

Credit card information

Show child attributes

entries.creditCard.year

integer<int32>

entries.creditCard.month

integer<int32>

entries.creditCard.last4

string | null

entries.creditCard.type

enum<string>

Available options:

VISA,

MasterCard,

AmericanExpress,

Discover

entries.creditCard.ccUpdaterStatusName

string | null

entries.creditCard.ccUpdaterStatusDescription

string | null

entries.creditCard.ccUpdaterStatusReasonCode

string | null

entries.creditCard.ccUpdaterDateUpdated

string<date-time> | null

entries.newPaymentInfoId

string<guid> | null

New PaymentInfoId if exists

entries.isCreditCardOutdated

boolean

Is credit card outdated

entries.newCreditCard

object

New credit card information if exists

Show child attributes

entries.newCreditCard.year

integer<int32>

entries.newCreditCard.month

integer<int32>

entries.newCreditCard.last4

string | null

entries.newCreditCard.type

enum<string>

Available options:

VISA,

MasterCard,

AmericanExpress,

Discover

entries.newCreditCard.ccUpdaterStatusName

string | null

entries.newCreditCard.ccUpdaterStatusDescription

string | null

entries.newCreditCard.ccUpdaterStatusReasonCode

string | null

entries.newCreditCard.ccUpdaterDateUpdated

string<date-time> | null

Example:

[]

Overview

Architecture

Getting started

Security

API reference

Admin UI

Data

Observability

Deployment

CI/CD

Runbooks

Contributing

Description

Input

Output

Example Request

Example Response

Errors

Notes

Authorizations

Path Parameters

Query Parameters

Response

Overview

Architecture

Getting started

Security

API reference

Admin UI

Data

Observability

Deployment

CI/CD

Runbooks

Contributing

​Description

​Input

​Output

​Example Request

​Example Response

​Errors

​Notes

Authorizations

Path Parameters

Query Parameters

Response

Description

Input

Output

Example Request

Example Response

Errors

Notes