Card Accounts

Create Card Account

Changed on

Creates a new card account for the specified organization.

post/card-accounts

Request

Request body

organizationIdstring uuid required

The unique identifier of the organization.

namestring required

The name of the card account.

currencystring nullable

The currency code (e.g., EUR, USD).

Response

Card account created successfully

idstring uuid required

The id of the card account.

organizationIdstring uuid required

The id of the organization this card account belongs to.

namestring required

The name of the card account.

purposestring nullable

Optionally, a description of the purpose of the card account.

status'ACTIVE' | 'PENDING' | 'DEACTIVATED' | 'CANCELLED' | 'SUPERSEDED' required

The status of the card account.

  • ACTIVE - the card account is operational.
  • PENDING - the card account is not operational yet, e.g. because the organization is still onboarding.
  • DEACTIVATED - the card account was deactivated and can no longer be used.
  • CANCELLED - the card account was cancelled.
  • SUPERSEDED - the card account was replaced by a successor card account and is kept for historical reasons only. It stays readable, but no new cards, payments or payouts can be created on it. The successor is referenced by supersededBy. See the card account guide for details.
currencystring required

The currency of the card account.

defaultAccountboolean required

Indicates whether this is the default card account. There is always one active default card account.

accountType'CREDIT' | 'PREFUNDED' required

The account type of the card account.

paymentFrequency'DAILY' | 'WEEKLY' | 'BI_WEEKLY' | 'MONTHLY' | 'PREFUNDED' required

The payment frequency of the card account. This is the frequency with which the card account is settled for this organization. Only relevant for CREDIT-based card accounts.

paymentDefermentInDaysinteger required

The payment deferment in days of the card account. Only relevant for CREDIT-based card accounts.

activatedAtstring date-time nullable

The date and time when the card account was activated.

createdAtstring date-time required

The date and time when the card account was created.

supersededBystring uuid nullable

The id of the card account that took over from this one. Only set if this card account has status SUPERSEDED, null otherwise. Follow this id to find the card account that holds the current balance, limits and bank account information.

supersedesstring uuid nullable

The id of the card account this one took over from. Only set if this card account is the successor of a superseded card account, null otherwise. The superseded card account remains readable and keeps its historical transactions, statements and account entries.

supersededAtstring date-time nullable

The date and time when this card account was superseded. Only set together with supersededBy, null otherwise.

benefitCardAccountboolean

Set to true for the card account that is dedicated to funding benefit cards.

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • warning

      added the new SUPERSEDED enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status