✅ New fields added to the card transactions (Card Transactions API)

  • authorisationCode (string)

    • Authorisation code generated for approved and declined authorisation requests.
  • paymentToken (object)
    Provides payment toeken information. The following fields were added:

FieldTypeDescription
idstringUnique identifier of the payment token.
creatorstringSource or provider of the token, e.g., MC-MDES, VISA-T.
expiryDatestringExpiry date of the token (YYYY-MM-DD).
typestringType of token (e.g., SE for Secure Element PAN).
statusstringToken status code; e.g., "00" = Active.
creatorStatusstringStatus from token creator’s system, e.g., "A" = Active.
walletstringWallet provider, e.g., APPLE.
deviceTypestringType of device used, e.g., M for Mobile.
languageCodestringDevice’s preferred language, e.g., en.
deviceTelephoneNumberstringTelephone number associated with the device.
deviceIpAddressstringIP address of the device used during token activation. It may arrive in either of 2 formats:

Hex format: FFFFFFFF (255.255.255.255)
Decimal format: A17F001E (081.5.006.255)
deviceIdstringUnique identifier of the device.
deviceNamestringName of the device.
activationCodestringCode used to activate the token.
activationExpiryDateTimestringExpiry date/time of the activation code.
activationMethodDatastringData used in the activation method (e.g., phone number).
activationMethodstringActivation method code (e.g., 1 = SMS).

We’ve introduced idempotency support for all POST endpoints via the X-Idempotency-Key request header. This helps prevent duplicate processing in case of retries or network issues.

  • Repeated requests with the same key and identical body will return the original response.
  • Responses now include an X-Idempotency-Status header (processed or replayed).
  • A 400 error is returned if a reused key is sent with a different request body.

This makes retrying requests safer and more predictable — especially useful in distributed or unreliable environments. More details can be found at the guides.

This release includes adding an attributes field to the Client model. The attribute field is a key-value map that can store any additional metadata you'd like to link to the client. There are some reserved keys for each service provider.

Here are the client attributes details of creating a client Client Create API

POST /clients
{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "client": {
            "identity": {
                "type": "individual",
                "givenName": "Railsr",
                "familyName": "Rlb",
                "birthDate": "1987-01-01",
                "country": "GB",
                "identifications": [
                    {
                        "type": "identity-card",
                        "identificationNumber": "12345677",
                        "issuingCountry": "GB",
                        "issueDate": "2022-01-01",
                        "expirationDate": "2032-01-01"
                    }
                ]
            },
            "profile": {
                "identityType": "individual",
                "residentialAddress": {
                    "country": "GB",
                    "region": "England",
                    "city": "London",
                    "street": "Baker Street",
                    "houseNumber": "221B",
                    "postalCode": "EC1Y 1AA",
                    "refinement": ""
                },
                "phone": "1012555123",
                "email": "[email protected]"
            },
            "attributes": {
                "accountUsage": "sendAndReceiveMoneyTransfers",
                "riskScore": "low",
                "isPep": "false",
                "expectedVolumeRange": "5001-10000",
                "expectedVolumeType": "monthly",
                "expectedVolumeCurrency": "GBP"
            }
        }
    },
    "connect": {},
    "metadata": {}
}
POST /clients
{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "client": {
            "identity": {
                "type": "corporate",
                "legalName": "Foo Bar Inc.",
                "tradingName": "",
                "country": "GB",
                "identifications": [
                    {
                        "type": "registration-number",
                        "identificationNumber": "12345678"
                    }
                ],
                "incorporationDate": "2019-09-09",
                "corporationType": "ltd"
            },
            "profile": {
                "registrationAddress": {
                    "country": "GB",
                    "region": "Dewsbury Moor",
                    "city": "Dewsbury",
                    "street": "98 Low Rd",
                    "houseNumber": "15",
                    "postalCode": "WF13 3PS",
                    "refinement": ""
                },
                "identityType": "corporate",
                "phone": "1012555123",
                "email": "[email protected]"
            },
            "addresses": {
                "tradingAddress": {
                    "country": "GB",
                    "region": "Dewsbury Moor",
                    "city": "Dewsbury",
                    "street": "92 Low Rd",
                    "houseNumber": "21",
                    "postalCode": "WF13 3PS",
                    "refinement": ""
                }
            },
            "attributes": {
                "accountUsage": "receiveClientFunds",
                "riskScore": "low",
                "expectedVolumeRange": "0-25000",
                "expectedVolumeType": "monthly",
                "expectedVolumeCurrency": "GBP",
                "businessNatures": "20200",
                "companyType": "private",
              	"website": "https//www.abc.com"
            },
            "relatedLegalEntities": [
                {
                    "relation": "director",
                    "identity": {
                        "type": "individual",
                        "givenName": "foo",
                        "familyName": "bar",
                        "birthDate": "1987-01-01",
                        "country": "GB"
                    },
                    "profile": {
                        "phone": "",
                        "addresses": {
                            "residential": {
                                "country": "GB",
                                "postalCode": "12345",
                                "city": "London",
                                "street": "122B Baker street"
                            }
                        }
                    }
                },
                {
                    "relation": "shareholder",
                    "identity": {
                        "type": "corporate",
                        "country": "GB",
                        "identificationNumbers": null,
                        "legalName": "Sub foo bar",
                        "incorporationDate": "2019-09-09",
                        "corporationType": null
                    },
                    "profile": {
                        "phone": "",
                        "addresses": {
                            "registration": {
                                "country": "GB",
                                "postalCode": "12345",
                                "city": "London",
                                "street": "122B Baker street"
                            }
                        }
                    }
                },
                {
                    "relation": "director-and-shareholder",
                    "identity": {
                        "type": "individual",
                        "givenName": "sub 2 foo",
                        "familyName": "bar",
                        "birthDate": "1987-01-01",
                        "country": "GB"
                    },
                    "profile": {
                        "phone": "",
                        "addresses": {
                            "residential": {
                                "country": "GB",
                                "postalCode": "12345",
                                "city": "London",
                                "street": "122B Baker street"
                            }
                        }
                    }
                }
            ]
        }
    },
    "connect": {},
    "metadata": {}
}

Here are the client attributes details of updating a client Client Update API

// the request below only updates the identity & profile & attributes of the individual client
PATCH /clients/<client-id>
{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "client": {
            "identity": {
                "type": "individual",
                "givenName": "Connect Individual",
                "familyName": "Railsbank",
                "birthDate": "1996-01-01",
                "country": "GB",
                "identifications": [
                    {
                        "type": "identity-card",
                        "identificationNumber": "12345677",
                        "issuingCountry": "GB",
                        "issueDate": "2022-01-01",
                        "expirationDate": "2032-01-01"
                    }
                ]
            },
            "profile": {
                "identityType": "individual",
                "residentialAddress": {
                    "country": "GB",
                    "region": "England",
                    "city": "London",
                    "street": "Baker Street",
                    "houseNumber": "221B",
                    "postalCode": "EC1Y 1AA",
                    "refinement": ""
                },
                "phone": "1012555128",
                "email": "[email protected]"
            },
            "attributes": {
                "accountUsage": "sendAndReceiveMoneyTransfers",
                "riskScore": "low",
                "isPep": "false",
                "expectedVolumeRange": "5001-10000",
                "expectedVolumeType": "monthly",
                "expectedVolumeCurrency": "GBP"
            }
        }
    },
    "connect": {},
    "metadata": {}
}
// the request below only updates the identity & the profile & attributes of the corporate client
PATCH /clients/<client-id>
{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "client": {
            "identity": {
                "type": "corporate",
                "legalName": "Foo Bar Inc.",
                "tradingName": "",
                "country": "GB",
                "identifications": [
                    {
                        "type": "registration-number",
                        "identificationNumber": "12345678"
                    }
                ],
                "incorporationDate": "2019-09-09",
                "corporationType": "ltd"
            },
            "profile": {
                "registrationAddress": {
                    "country": "GB",
                    "region": "Dewsbury Moor",
                    "city": "Dewsbury",
                    "street": "98 Low Rd",
                    "houseNumber": "17",
                    "postalCode": "WF13 3PS",
                    "refinement": ""
                },
                "identityType": "corporate",
                "phone": "1012555129",
                "email": "[email protected]"
            },
            "addresses": {
                "trading": {
                    "country": "GB",
                    "region": "Dewsbury Moor",
                    "city": "Dewsbury",
                    "street": "92 Low Rd",
                    "houseNumber": "21",
                    "postalCode": "WF13 3PS",
                    "refinement": ""
                }
            },
            "attributes": {
                "accountUsage": "receiveClientFunds",
                "riskScore": "low",
                "expectedVolumeRange": "0-25000",
                "expectedVolumeType": "monthly",
                "expectedVolumeCurrency": "GBP",
                "businessNatures": "20200",
                "companyType": "private",
              	"website": "https//www.abc.com"
            }
        }
    },
    "connect": {},
    "metadata": {}
}

This release includes adding an attributes field to the Account model. The attribute field is a key value field where additional information to be stored regarding the account can be sent. For example, a key-value whose key is account type and value is salary can be sent. Here, account type indicates the key, while salary is a value that holds the type value of this account. The attribute field is a field that can be sent when calling the Create Account API.

Here are the account attributes details of an account Account Create API

This release includes a new Webhook for incoming transfers. Below, you'll find the details about new additions that have been included in this release.

  • A new type of webhook for Incoming Transfers: incoming-transfer-updated-webhook
    If the incoming transfer is updated for any reason after it passes to the completed status, this webhook is sent. In this case, a new field called operationType is added under the webhook. This field indicates the operation for which this update was made. Incoming Transfer Webhooks
{
   "webhook":{
      "module":"incoming-transfers",
      "type":"incoming-transfer-updated",
      "operationType":"update-related-transaction-id"
   },
   "data":{
      "incomingTransfer":{
         "id":"00000000-0000-0000-0000-000000000000",
         "clientId":null,
         "accountId":"00000000-0000-0000-0000-000000000000",
         "transactionNumber":"20250120-YG2X8G",
         "status":"completed",
         "currency":"EUR",
         "amount":1000.00,
         "feeAmount":null,
         "feeCurrency":null,
         "outgoingTransferId":null,
         "serviceProviderId":"00000000-0000-0000-0000-000000000000",
         "serviceProviderReference":"00000000-0000-0000-0000-000000000000",
         "senderInformation":null,
         "senderName":"Donald Trump",
         "transferDate":"2025-01-20",
         "totalAmount":null,
         "provisionedAccountCreditId":"00000000-0000-0000-0000-000000000000",
         "serviceProvider":"clearbank-eu",
         "receiverAccount":{
            "bankName":null,
            "accountHolderName":"",
            "alias":"Customer Account",
            "country":"NL",
            "currency":"EUR",
            "routingCodes":{
               "bic":null
            },
            "accountNumber":null,
            "iban":"NL54CLRB0089338401",
            "ledgerNumber":"44579422"
         },
         "senderAccount":{
            "bankName":null,
            "accountHolderName":"Donald Trump",
            "alias":null,
            "country":null,
            "currency":"EUR",
            "routingCodes":{
               
            },
            "accountNumber":null,
            "iban":"NL55SHWG3508008115",
            "ledgerNumber":null
         },
         "scope":"external",
         "scheme":"sepa",
         "owner":"organization",
         "relatedTransaction":{
            "nature":"virtual",
            "id":"00000000-0000-0000-0000-000000000000"
         }
      }
   }
}

This release includes Open Banking EU APIs and changes for Open Banking GB APIs. Details about the modifications are included below.

Open Banking EU: In this context, all Open Banking APIs (GET, LIST, APPROVE, REVOKE, REJECT) have also become accessible to tenants in countries affiliated with the European Union. You can access it using the following links:


Open Banking GB: In this context, the Permission list is added to the consent object for accounts scope in GET and LIST APIs response payload. You can access the example response payload: Open Banking GB GET API Open Banking GB LIST API

We are replacing House Accounts by a new concept called Organization accounts. You can access them via backoffice and Platform API. Please refer to new Bank Accounts & Transaction Accounts docs for more details on the account structure. They are created for your specific needs by IF Team while your instance is setup.

Transactions on organization accounts are handled using the existing transaction APIs. Therefore, you'll see an addition of owner field on all transaction models and a couple of minor changes on the models based on the transaction type.

All list transaction APIs have a filter by owner option. Ideally, these APIs should return all data regardless of the value of owner. However, to be able to backward compatible we have to set clientas the default value for now. We expect all of our customers to send clientfilter parameter explicitly as soon as possible. After that, we can drop the default value and all list transaction APIs start to list client & organization transactions by default.

Please refer to Service Provider Account Models & Flow of Funds sections of the guides based on your service provider's account model.

We are excited to announce the recent launch of the Integrated Finance Cards API Card API Guide. Integrated Finance customers now have the opportunity to access a comprehensive suite of card issuing and processing features, seamlessly integrated with core banking and compliance capabilities.

If you have any questions, please feel free to reach out to us via our contact page at https://integrated.finance/contact-us.

Below, you will find details about the functionalities incorporated in this release for your reference.

Cards API changes: