9 posts tagged with "release"

Changelog​

New Transaction Status: pending​

A new pending status has been added to transaction objects. This status indicates that the transaction is currently being processed.

The following endpoints and webhooks now support the pending status:

• Retrieve Account Transactions
• Retrieve Account Transaction Details
• Retrieve Card Transactions
• Retrieve Card Transaction Details
• Card Transaction Event webhook
• Account Transaction Event webhook

Transaction Linking Fields​

New fields have been added to transaction objects to support linking related transactions:

• parentId: Identifier of a related parent transaction. For example, a refund transaction will reference the original purchase transaction it reverses.

This field is available in the following endpoints and webhooks:

• Retrieve Account Transactions
• Retrieve Account Transaction Details
• Retrieve Card Transactions
• Retrieve Card Transaction Details
• Card Transaction Event webhook
• Account Transaction Event webhook

Additionally, the following field has been added to card transaction objects:

• transferJobId: Identifier of the job associated with this transaction.

This field is available in the following endpoints and webhooks:

• Retrieve Card Transactions
• Retrieve Card Transaction Details
• Card Transaction Event webhook

Card Owner Address Information​

The address field has been added to card owner objects. This field contains the card owner's address details including:

• postalCode: Postal or ZIP code.
• city: City name.
• addressLine1: Primary street address.
• addressLine2: Secondary address line (apartment, suite, unit, etc.).

The address information is now returned in the following endpoints:

• Retrieve Card Owners
• Retrieve Card Owner Details
• Retrieve Card Details

Changelog​

New Endpoint: Retrieve Available BINs​

The new Retrieve Available BINs endpoint returns a list of BIN categories with detailed information about each BIN configuration, including:

• Category identifiers and types (e.g., travel, corporate expenses)
• BIN numbers and card networks
• Supported digital wallet tokenizations (Apple Pay, Google Pay)
• Tags for categorization and feature indication (e.g., 3DS requirements, use case optimization)
• Issuer country information
• Availability status

Configure BIN Restrictions​

You can now control which BINs are available for card issuance at the account level using the new accountBinDirections field:

• When creating a new account, specify which BIN categories and specific BINs should be available.
• When updating an account, modify the BIN configuration. Changes only affect newly issued cards; existing cards remain unchanged.

The accountBinDirections field accepts an array of BIN category configurations. For each category, you can:

• Specify the category identifier (binCategoryId)
• Optionally list specific BIN identifiers (cardBinIds) from that category

Enhanced BIN Information in Account Responses​

The following endpoints now return enriched BIN information in the binList field:

• Retrieve Account Details
• Retrieve Card Creation Restrictions

New fields:

• categoryIds: Array of BIN category identifiers that define the intended use case (e.g., travel, corporate expenses)
• tags: Array of tags for categorization and feature indication (e.g., apple_pay, travel, no_3ds)

Updated fields:

• bin: Now nullable to support category-based configurations
• issuerCountry: Now nullable
• cardNetwork: Now nullable
• cardTokenizations: Documentation corrected to reflect the actual enum values "Apple pay" and "Google pay" (previously documented incorrectly as "apple_pay" and "google_pay")

Issue Cards by BIN Category​

When calling Issue a New Card, you can now specify a BIN category.

• New field binCategoryId: Specify the intended use case for the card (e.g., travel, corporate expenses). The category determines which BIN will be used for card issuance.
• New field currency: Explicitly set the card currency (ISO 4217 format).
• Updated cardProviderBinId: Now optional (nullable).
• Updated limits: Now required. You must specify at least one spending limit when creating a card.

Changelog​

Enhanced Card Transaction Details​

The Retrieve Card Transactions endpoint now returns transaction details in each response item. The following fields are now included:

• amount: Transaction amount in the merchant's currency.
• currency: Source currency code (ISO 4217).
• feeAmount: Fee amount charged for the transaction.
• feeCurrency: Currency of the fee amount.
• merchantName: Name of the merchant or entity involved.
• merchantCountry: Country of the merchant.
• mcc: Merchant Category Code.
• rrn: Retrieval Reference Number assigned by the processor.
• authorizationCode: Code indicating approval of the transaction.
• authorizedBy: Entity that authorized the transaction.
• declineReason: Reason for transaction decline.
• transactionAt: Date and time when the transaction actually occurred.

Card Balance Operation Response Updates​

The following endpoints now return detailed response data instead of empty 204 responses:

• Top up card balance
• Withdraw card balance

Both endpoints now return a 200 status with transaction identifiers:

{
  "data": {
    "fromTransactionId": "9f283e59-21ec-4c74-ae32-156d49cd9cf2",
    "toTransactionId": "9f283e59-21ec-4c74-ae32-156d49cd9cf2"
  }
}

Provider Account Schema Refinement​

The Retrieve Available Provider Accounts endpoint response structure has been updated. The cardType field has been renamed to type.

Additional Enhancements​

• The Retrieve Card Details endpoint now includes activate as a possible value in the availableActions array.

• The Retrieve Account Transactions endpoint now supports the authorized status value, indicating transactions that have been approved but not yet settled.

• The Retrieve Card Transaction Details endpoint now includes the mcc (Merchant Category Code) field.

Changelog​

Documentation Corrections​

• The request example for the Card Transaction Event webhook has been corrected to accurately reflect the payload sent by our platform.

• The previously undocumented authorized status is now included in the documentation for transaction objects:

  • The status field in the Account Transaction Event webhook may now show authorized.
  • The status field in the Retrieve Account Transaction Details endpoint may also return authorized.

Changelog​

Improvements to Account Creation Schema​

The Create a New Account request body has been updated. The enableCardBalance boolean field has been replaced with an enum and is now required. The possible values are:

• personal_card_balance: Each card has its own dedicated balance, separate from the main account balance.

• shared_account_balance: All cards share the main account balance; no individual card balances are maintained.

  Before:

  enableCardBalance: true
  

  Now:

  enableCardBalance: personal_card_balance
  

Changelog​

New Webhook: Card Status Event​

You can now subscribe to the Card State Event webhook, which notifies your system in real time whenever a card is created or its status changes.

This webhook delivers a payload identical to the Retrieve Card Details.

A control signature is included in the api-notification-sign header (SHA512) to ensure authenticity and security.

📘 Learn how to configure webhooks: Webhooks Setup Guide

Changelog​

Enhancements to Existing Endpoints​

• The Account Top-Up Event webhook and the Retrieve Top-Up Details endpoint now support a new status value: allocating.
• The Retrieve Cards for an Account endpoint response now includes the availableBalance field for each card.
• The Retrieve Card Transactions endpoint now accepts two additional values for the types filter parameter:
  • top_up
  • withdrawal

Account Creation Response Structure Updated​

• The response for Create a New Account has been updated for consistency with other endpoints.
  The account ID is now returned inside a data object:

  Before:

  {
    "id": "8f3d0c3d-9f3e-4ef6-8fae-c3169025dfcb"
  }
  

  Now:

  {
    "data": {
      "id": "8f3d0c3d-9f3e-4ef6-8fae-c3169025dfcb"
    }
  }
  

Changelog​

Webhooks Support Added​

You can now configure webhooks in the Client Portal to receive real-time notifications when important events occur in your system. Webhooks allow your application to instantly react to events such as card transactions, account activity, or incoming top-ups.

📘 Full setup instructions: Webhooks Setup Guide

You can now subscribe to three webhook types:

• Card Transaction Event: Triggered whenever a card transaction is updated.
• Account Transaction Event: Triggered on any account-related transaction change.
• Account Top-Up Event: Triggered when funds are added to an account.

Card Balance Management​

This release introduces new capabilities for managing card balances.

New Endpoints​

• Top up card balance - you can now top up a card’s balance directly from the associated account.
• Withdraw card balance - you can now to withdraw funds from a card’s balance back to the account.

Enhancements to Existing Endpoints​

• Create a New Account
  The request body now supports the enableCardBalance parameter, allowing you to specify whether new accounts should support dedicated card balances.

• Retrieve Account Details
  The response now includes additional fields:

  • holdedBalance: Current holded (on-hold) balance of the account.
  • availableBalance: Current available balance of the account.
  • isUsedCardBalance: Indicates whether cards under this account have their own dedicated balance, or if all transactions are settled directly from the account balance.

• Retrieve Card Creation Restrictions
  The response now includes:

  • cardBalance: Shows if the provider supports issuing cards with a dedicated balance.

• Retrieve Card Details
  The response now includes:

  • availableBalance: The available balance on the card.
  • spendedBalance: The total amount spent from the card’s balance.

• Retrieve All Accounts for a Company
  The response now includes:

  • undistributedBalance: Current undistributed balance of the account.
  • holdedBalance: Current holded (on-hold) balance of the account.

• Retrieve Available Provider Accounts The response now includes:

  • supportedCardBalances: An array listing the supported card balance types for the provider account.
    Possible values:
    • personal_card_balance: Each card has its own dedicated balance, separate from the main account balance.
    • shared_account_balance: All cards share the main account balance; no individual card balances are maintained.
  • cardType: Indicates the card types that can be issued under this provider account.
    Possible values:
    • virtual: Card exists only in digital form (no physical plastic card is issued).
    • physical: Physical plastic card.

Changelog​

Fees​

This release introduces the ability to set and view custom fees for individual accounts.

• The fees object is now included in the following endpoints:
  • Retrieve Account Details
  • Create a New Account
  • Update Account
• This object contains detailed fee settings for:
  • cardTransactions: Fee for each card transaction.
  • cardIssuing: Fee for issuing a new card.
  • topUpsAllocation: Fee for allocating top-up funds.

Access Control and Permissions

• By default, you cannot manage account-level fees. To request access to fee management, please contact support.

Validation and Business Rules

• Any account-level fee (percentage or fixed) cannot be set lower than the corresponding company-level fee. This rule is enforced for all fee types and actions.