12 posts tagged with "release"

Changelog​

Card Owner KYC: Path Parameter Changed​

The path parameter companyUuid has been changed to companyProviderUuid in the following endpoints:

• Upload Card Owner KYC Document — PUT /api/v1/cards/companies/{companyProviderUuid}/card-owners/{cardOwnerId}/kyc/document
• Submit Card Owner KYC — PATCH /api/v1/cards/companies/{companyProviderUuid}/card-owners/{cardOwnerId}/kyc

companyProviderUuid is the identifier of the provider company. It can be obtained from the companyProviderId field returned by Retrieve Account Details.

New Field in Account Details: companyProviderId​

The companyProviderId field has been added to the Retrieve Account Details endpoint response. It contains the identifier of the provider that the account is linked to.

Changelog​

New Endpoints: Card Owner KYC​

Two new endpoints have been added to support Know Your Customer (KYC) verification for card owners. Some card products require the card owner to pass KYC before a card can be issued.

• Upload Card Owner KYC Document — uploads a scan or photo of the card owner's identity document.
• Submit Card Owner KYC — submits the card owner's KYC data, including personal details, identity document metadata, and residential address.

To complete KYC, upload the identity document first, then submit the KYC data. The submit endpoint returns the unique id of the KYC submission, which can be used to track its status.

KYC Status in Card Owner Data​

The kyc array has been added to the Retrieve Card Owner Data endpoint response. It contains the history of KYC submissions for the card owner, each with a kycId and the current status — one of created, approved, or denied.

Changelog​

New Endpoints: Account Balance Transfers​

Two new endpoints have been added to support balance transfers between accounts:

• Retrieve Accounts Available for Transfer — returns a paginated list of accounts that are available as destinations for a balance transfer from the specified account.
• Transfer Account Balance — transfers a specified amount from the source account to a destination account.

New Field in Account Details: isTransferAllowed​

The isTransferAllowed boolean field has been added to the Retrieve Account Details endpoint response. This field indicates whether balance transfers are allowed for the account.

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"
    }
  }