### Get Client API Request Example Source: https://developer.integrated.finance/docs/clients This example demonstrates how to make a GET request to retrieve client data, specifying metadata parameters to include profile and primary address information. The URL structure shows how to append query parameters for data shaping. ```http GET /clients/{clientId}?metadata.includeProfile=true&metadata.include=data.client.profile.primaryAddress ``` -------------------------------- ### Get Account Statements Response Example (JSON) Source: https://developer.integrated.finance/docs/client-accounts This is an example of the JSON response received when requesting account statements. It includes details about account statements, pagination, and metadata. ```json { "workflow": {}, "data": { "accountStatements": [ { "accountId": "00000000-0000-0000-0000-000000000000", "transactionNumber": "20210101-ABC123", "entryDateTime": "2021-09-13T11:13:19.168", "direction": "debit", "amount": 10.00, "transactionType": "incoming", "entryType": "fee", "balance": 100.00, "currency": "TRY", "narrative": "Transfer fee for 20210101-ABC123" } ] }, "connect": {}, "metadata": { "page": { "size": 20, "number": 0, "totalElements": 200, "totalPages": 10 } } } ``` -------------------------------- ### Get Account - Built-In Response Example Source: https://developer.integrated.finance/docs/client-accounts This JSON response demonstrates the structure when retrieving an account with a built-in connection. It includes account details and connection information under the 'connect.connection' object. This response format is used with the GET /accounts/{accountId}?metadata.include=connect.connection endpoint. ```json { "workflow": {}, "data": { "account": { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "status": "active", "country": "GB", "currency": "EUR", "alias": "EUR Account", "routingCodes": {}, "iban": null, "accountNumber": null, "ledgerNumber": "12345678", "availableBalance": 0, "serviceProvider": "service-provider-code", "accountHolderName": "Sherlock Holmes", "accountHolderIdentityType": "individual", "connection": { "id": "00000000-0000-0000-0000-000000000000", "method": "built-in", "serviceProvider": "railsbank", "reference": "00000000-0000-0000-0000-000000000000", "state": "completed-up-to-date", "status": "active", "error": null } } }, "connect": { "connection": { "id": "00000000-0000-0000-0000-000000000000", "serviceProvider": "service-provider-code", "reference": "00000000-0000-0000-0000-000000000000", "state": "completed-up-to-date", "status": "active", "error": null } }, "metadata": { "include": [ "connect.connection" ] } } ``` -------------------------------- ### Account Connection Webhook: connection-creation-failed (plug-in) Source: https://developer.integrated.finance/docs/client-accounts This example shows a webhook payload for a 'connection-creation-failed' event when using the 'plug-in' method. It highlights issues during the initial connection setup, such as an invalid IBAN, and provides details about the account and the specific error. ```json { "webhook":{ "module":"accounts", "type":"connection-creation-failed" }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "status":"pending", "country":"GB", "currency":"GBP", "alias":"GBP Account", "routingCodes":{ "sort-code":"123456" }, "iban":null, "accountNumber":"12345678", "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"service-provider-code", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual", "connection":{ "id":null, "method":"plug-in", "serviceProvider":"service-provider-code", "reference":null, "state":"creation-failed", "status":"null", "error":{ "category":"functional", "origin":"platform", "code":"invalid_iban", "message":"IBAN is invalid", "attributes":{ "iban_error":"IBAN is invalid." } } } } }, "connect":{ "connection":{ "id":null, "serviceProvider":"service-provider-code", "reference":null, "state":"creation-failed", "status":"null", "error":{ "category":"functional", "origin":"platform", "code":"invalid_iban", "message":"IBAN is invalid", "attributes":{ "iban_error":"IBAN is invalid." } } } }, "metadata":{ } } ``` -------------------------------- ### Get Account - Plug-In Response Example Source: https://developer.integrated.finance/docs/client-accounts This JSON response shows the structure for an account retrieved with a plug-in connection. It includes account details and connection information specific to the plug-in provider. This response is generated when using the GET /accounts/{accountId}?metadata.include=connect.connection endpoint with a plug-in service. ```json { "workflow": {}, "data": { "account": { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "status": "active", "country": "GB", "currency": "EUR", "alias": "EUR Account", "routingCodes": {}, "iban": null, "accountNumber": null, "ledgerNumber": "12345678", "availableBalance": 0, "serviceProvider": "service-provider-code", "accountHolderName": "Sherlock Holmes", "accountHolderIdentityType": "individual", "connection": { "id": "00000000-0000-0000-0000-000000000000", "method": "plug-in", "serviceProvider": "revolut", "reference": "00000000-0000-0000-0000-000000000000", "state": "completed-up-to-date", "status": "active", "error": null } } }, "connect": { "connection": { "id": "00000000-0000-0000-0000-000000000000", "serviceProvider": "service-provider-code", "reference": "00000000-0000-0000-0000-000000000000", "state": "completed-up-to-date", "status": "active", "error": null } }, "metadata": { "include": [ "connect.connection" ] } } ``` -------------------------------- ### Connection Object Examples (JSON) Source: https://developer.integrated.finance/docs/connection-objects Provides examples of connection objects in JSON format, illustrating different states such as 'completed-up-to-date' and 'dependency-failed'. These examples showcase the structure and potential error details. ```json { "id": "76b51f7a-2a4a-471f-a66d-d43e4c2728eb", "method": "built-in", "serviceProvider": "clearbank", "reference": "45ff4ac5-fe22-4233-8152-6a3272ae6569", "state": "completed-up-to-date", "status": "active", "error": null } ``` ```json { "id": "76b51f7a-2a4a-471f-a66d-d43e4c2728eb", "method": "built-in", "serviceProvider": "currencycloud", "reference": "45ff4ac5-fe22-4233-8152-6a3272ae6569", "state": "dependency-failed", "status": "pending", "error": { "category": "technical", "origin": "platform", "code": "generic", "message": "Error received from Currencycloud UK: Status: 400, Body: {\"error_code\":\"account_create_failed\",\"error_messages\":{\"\":[{\"code\":\"name_contains_numbers\",\"message\":\"Account name must not contain numbers.\",\"params\":{}}]}}", "attributes": {} } } ``` -------------------------------- ### Idempotent POST Request Example (First Request) Source: https://developer.integrated.finance/docs/idempotency-support This example demonstrates a first-time POST request to create a client. The `X-Idempotency-Key` header is included, and the response indicates `processed` status. ```http POST /v1/{instance-id}/clients X-Idempotency-Key: a1b2c3d4e5f6g7h8 Content-Type: application/json Request Body: { "workflow": { "code": "direct" }, "data": { "client": { "identity": { "type": "individual", "givenName": "John", "familyName": "Doe", "country": "GB" } } }, "connect": {}, "metadata": {} } Response: 201 Created X-Idempotency-Status: processed { "workflow": { "code": "direct", "createUser": null }, "data": { "client": { "id": "a116f50a-895d-472e-8cc1-31361ccccf56", "clientNumber": "25822466", "fullName": "John Doe", "status": "active", "identity": { "type": "individual", "country": "GB", "identifications": [], "givenName": "John", "familyName": "Doe", "birthDate": null } } }, "connect": {}, "metadata": {} } ``` -------------------------------- ### Get Client API Response Example Source: https://developer.integrated.finance/docs/clients This JSON response illustrates the structure of data returned when a GET request for client information is made with specific metadata inclusions. It includes client identity, risk assessment, profile details, and metadata about the request parameters. ```json { "workflow": {}, "data": { "client": { "identity": { "type": "corporate", "legalName": "I.F Technology Ltd", "incorporationDate": "1987-01-01", "country": "GB" }, "risk": "low", "profile": { "identityType": "corporate", "registrationAddress": { "country": "GB", "region": "England", "city": "London", "street": "Baker Street", "houseNumber": "221B", "postalCode": "XYZ ABC", "refinement": "" }, "phone": "+441234567890", "email": "abc@integrated.finance" } } }, "connect": {}, "metadata": { "includeProfile": true, "includePrimaryAddress": true } } ``` -------------------------------- ### Get Sub-Account - Plug-In Response Example Source: https://developer.integrated.finance/docs/client-accounts This JSON response outlines the structure for a sub-account retrieved via a plug-in connection. It provides sub-account details but does not include connection-specific data, similar to the built-in sub-account response. This format is used when retrieving sub-accounts without specific metadata requests. ```json { "workflow":{ }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "mainAccountId":"00000000-0000-0000-0000-000000000000", "status":"active", "country":"GB", "currency":"EUR", "alias":"EUR Account", "routingCodes":{ }, "iban":null, "accountNumber":null, "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"service-provider-code", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual" } }, "connect":{ }, "metadata":{ } } ``` -------------------------------- ### Retry Request Example (HTTP POST) Source: https://developer.integrated.finance/docs/idempotency-support This example demonstrates an HTTP POST request to the `/v1/{instance-id}/clients` endpoint. It includes an `X-Idempotency-Key` header and a JSON `Content-Type`. The request body contains client data, and this specific example illustrates a scenario where the body might differ from a previous request associated with the same idempotency key. ```http POST /v1/{instance-id}/clients X-Idempotency-Key: a1b2c3d4e5f6g7h8 Content-Type: application/json Request Body: { "workflow": { "code": "direct" }, "data": { "client": { "identity": { "type": "individual", "givenName": "John", "familyName": "Doe", "country": "GB" } } }, "connect": {}, "metadata": {} } ``` -------------------------------- ### Get Virtual Card - Response Example (JSON) Source: https://developer.integrated.finance/docs/card-lifecycle This JSON object represents a successful response from the GET /cards/{cardId} endpoint when requesting virtual card details, including connection status. ```json { "workflow": {}, "data": { "card": { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "userId": "00000000-0000-0000-0000-000000000000", "type": "virtual", "status": "active", "suspensionReason": null, "terminationReason": null, "serviceProvider": "thredd", "alias": "Gold Card", "bin": "999999", "pan": "999999******6526", "expirationDate": "12/26", "attributes": { "threddCardProduct": "00000" }, "connection": { "id": "000000000", "serviceProvider": "thredd", "reference": "000000000", "state": "completed-up-to-date", "status": "active", "method": "built-in", "error": null } } }, "connect": {}, "metadata": {} } ``` -------------------------------- ### List Card Transactions - Response Example Source: https://developer.integrated.finance/docs/card-transactions Example JSON response for the GET /card-transactions endpoint. It includes a list of card transactions, each with details such as IDs, amounts, status, merchant information, and POS data. This structure helps understand the data format returned by the API. ```json { "workflow": {}, "data": { "cardTransactions": [ { "id": "9fbdfd66-0d1d-47d8-9e29-7c2c38abba8e", "cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31", "clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96", "matchingTransactionId": null, "accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae", "accountCurrency": "EUR", "transactionNumber": "20240301-ABC123", "type": "payment", "status": "settled", "transactionAmount": 100.00, "transactionCurrency": "EUR", "feeAmount": 10.00, "feeCurrency": "EUR", "billingAmount": -1.00, "billingCurrency": "EUR", "settlementAmount": 100.00, "settlementCurrency": "EUR", "effectiveTransactionAmount": 100.00, "effectiveFeeAmount": 10.00, "transactionExchangeRate": null, "feeExchangeRate": null, "merchant": { "name": "Commuter Transport", "id": "merchantId", "networkId": "networkId", "taxId": "taxId", "address": { "country": "GB", "region": "England", "city": "London", "street": "Baker Street", "houseNumber": "221B", "postalCode": "XYZ ABC", "refinement": "" }, "phone": "+441234567890", "website": "abc@commutertransport.com", "category": { "code": "4111", "description": "Commuter Transport, Ferries" } }, "pos": { "cardholderPresent": null, "cardPresent": null, "cardDataInputMethod": null, "authentication": null, "chipFallback": null, "fraud": null, "securityProtocol": null, "cardAuthentication3DSecureMethod": "oob-biometric" }, "serviceProvider": "THD", "serviceProviderEntityId": "00000000-0000-0000-0000-000000000000", "serviceProviderEntityReference": "reference", "description": "description" } ] } } ``` -------------------------------- ### Account Webhook 'account-activated' Plug-In Example Source: https://developer.integrated.finance/docs/client-accounts This JSON object demonstrates an 'account-activated' webhook event utilizing a plug-in connection method. It provides account details and specific connection information relevant to third-party integrations. ```json { "webhook":{ "module":"accounts", "type":"account-activated" }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "status":"active", "country":"GB", "currency":"GBP", "alias":"GBP Account", "routingCodes":{ "sort-code":"123456" }, "iban":null, "accountNumber":"12345678", "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"service-provider-code", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual", "connection":{ "id":"00000000-0000-0000-0000-000000000000", "method":"plug-in", "serviceProvider":"revolut", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"active", "error":null } } }, "connect":{ "connection":{ "id":"00000000-0000-0000-0000-000000000000", "serviceProvider":"service-provider-code", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"active", "error":null } }, "metadata":{ } } ``` -------------------------------- ### Get Sub-Account - Built-In Response Example Source: https://developer.integrated.finance/docs/client-accounts This JSON response illustrates the structure for a sub-account retrieved with a built-in connection. It contains essential sub-account details but omits connection-specific information as it's not included in this response type. This is typically returned by the GET /accounts/{accountId} endpoint without specific metadata inclusions. ```json { "workflow":{ }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "mainAccountId":"00000000-0000-0000-0000-000000000000", "status":"active", "country":"GB", "currency":"EUR", "alias":"EUR Account", "routingCodes":{ }, "iban":null, "accountNumber":null, "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"railsbank", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual" } }, "connect":{ }, "metadata":{ } } ``` -------------------------------- ### Create an Account Source: https://developer.integrated.finance/docs/client-accounts Creates a new client account. This endpoint allows setting an account alias for labeling and a connect method for integration. ```APIDOC ## POST /accounts ### Description Creates a new client account. You can optionally set an alias for easier identification and specify a connection method for the service provider integration. ### Method POST ### Endpoint /accounts ### Parameters #### Query Parameters - **alias** (string) - Optional - An alias for the account, with a 30 character limit. Defaults to "{currency} Account" if not set. - **connect_method** (string) - Optional - The integration method. Can be "built-in" (default) or "plug-in". Defaults to "built-in" if not set. ### Request Body This endpoint does not require a request body, all parameters are passed as query parameters. ### Response #### Success Response (201) - **id** (string) - The unique identifier for the created account. - **ledger_number** (string) - The unique ledger number assigned to the account. - **alias** (string) - The alias of the account. - **currency** (string) - The currency of the account. - **connect_method** (string) - The connect method used for the account. #### Response Example ```json { "id": "acc_12345abcde", "ledger_number": "LN987654321", "alias": "Investment Funds", "currency": "EUR", "connect_method": "built-in" } ``` ``` -------------------------------- ### Create Individual Client with Attributes (Direct Workflow) Source: https://developer.integrated.finance/docs/clients This JSON example shows how to create an individual client using the 'direct' workflow, including additional attributes like account usage, risk score, and expected volume. This demonstrates extending client profiles beyond basic identity and address. ```json 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" } ] }, "risk": "medium", "profile": { "identityType": "individual", "residentialAddress": { "country": "GB", "region": "England", "city": "London", "street": "Baker Street", "houseNumber": "221B", "postalCode": "EC1Y 1AA", "refinement": "" }, "phone": "1012555123", "email": "abc@integrated.finance" }, "attributes": { "accountUsage": "other", "otherNotes": "free text field", "riskScore": "low", "isPep": "false", "expectedVolumeRange": "5001-10000", "expectedVolumeType": "monthly", "expectedVolumeCurrency": "GBP" } } }, "connect": {}, "metadata": {} } ``` -------------------------------- ### Get Transaction Account Statements Response Example (JSON) Source: https://developer.integrated.finance/docs/transaction-accounts This JSON object represents a successful response from the Get Transaction Account Statements API. It includes details about transaction statements, such as account ID, transaction number, date, amount, and balance, along with pagination metadata. ```json { "workflow": {}, "data": { "transactionAccountStatements": [ { "accountId": "00000000-0000-0000-0000-000000000000", "transactionNumber": "20240909-9JW8W7", "transactionType": "exchange-transaction", "entryType": "principal-sell", "entryDateTime": "2024-09-09T07:46:38.290176", "direction": "debit", "amount": 12.00, "balance": 7805.00, "currency": "GBP", "narrative": "Sold to buy EUR at EUR/GBP:1.182" }, { "accountId": "00000000-0000-0000-0000-000000000000", "transactionNumber": "20240909-9JW8W7", "transactionType": "exchange-transaction", "entryType": "principal-sell", "entryDateTime": "2024-09-09T07:46:39.792114", "direction": "credit", "amount": 12.00, "balance": 7817.00, "currency": "GBP", "narrative": "Reversal of Sold to buy EUR at EUR/GBP:1.182" } ] }, "connect": {}, "metadata": { "page": { "size": 20, "number": 0, "totalElements": 2, "totalPages": 1 } } } ``` -------------------------------- ### List Clients API Response Source: https://developer.integrated.finance/docs/clients Example JSON response for the GET /clients API endpoint. It includes a list of clients with their details, supporting pagination and filtering parameters. ```json { "workflow": {}, "data": { "clients": [ { "id": "00000000-0000-0000-0000-000000000000", "clientNumber": "20663251", "status": "active", "identity": { "type": "corporate", "legalName": "I.F Technology Ltd", "incorporationDate": "2020-01-01", "country": "GB" }, "risk": "severe", "profile": { "identityType": "corporate", "phone": "+441234567890", "email": "abc@integrated.finance" }, "fullName": "I.F Technology Ltd" }, { "id": "00000000-0000-0000-0000-000000000001", "clientNumber": "20663241", "status": "active", "identity": { "type": "individual", "givenName": "Canay", "familyName": "Özel", "birthDate": "1987-01-01", "country": "TR" }, "profile": { "identityType": "individual", "phone": "+441234567890", "email": "abc@integrated.finance" }, "fullName": "Canay Özel" } ] }, "connect": {}, "metadata": { "page": { "size": 20, "totalElements": 2, "totalPages": 1, "number": 0 } } } ``` -------------------------------- ### Connection Instructed Webhook Example (JSON) Source: https://developer.integrated.finance/docs/card-lifecycle This JSON payload signifies a 'connection-creation-instructed' webhook event. It indicates that the card creation process has been initiated and is currently in the 'creation-in-progress' state. ```json { "webhook": { "module": "cards", "type": "connection-creation-instructed" }, "data": { "card": { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "userId": "00000000-0000-0000-0000-000000000000", "type": "virtual", "status": "pending", "suspensionReason": null, "terminationReason": null, "serviceProvider": "thredd", "alias": "Gold Card", "bin": null, "pan": null, "expirationDate": null, "attributes": { "threddCardProduct": "00000" }, "connection": { "id": null, "serviceProvider": "thredd", "reference": null, "state": "creation-in-progress", "status": null, "method": "built-in", "error": null } } }, "connect": {}, "metadata": {} } ``` -------------------------------- ### Exchange Connection Creation Instructed Webhook Example (JSON) Source: https://developer.integrated.finance/docs/exchanges This JSON example shows a webhook for an 'exchange-connection-creation-instructed' event. It signifies that instructions have been given to create a connection for an exchange transaction, and includes relevant transaction details. ```json { "webhook": { "module": "exchange-transactions", "type": "connection-creation-instructed" }, "data": { "exchange": { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "quoteId": "00000000-0000-0000-0000-000000000000", "transactionNumber": "20241211-QMXWJJ", "fixedSide": "sell", "rate": 1.266800000, "serviceProviderRate": 1.266800000, "buyAccountId": "00000000-0000-0000-0000-000000000000", "buyCurrency": "USD", "buyAmount": 44.34, "serviceProviderBuyAmount": 44.34, "sellAccountId": "00000000-0000-0000-0000-000000000000", "sellCurrency": "GBP", "sellAmount": 35.00, "serviceProviderSellAmount": 35.00, "feeAmount": 2.11, "feeCurrency": "USD", "debitAmount": 35.00, "creditAmount": 42.23, "rollCount": 0, "originalExchangeDate": "2024-12-11", "exchangeDate": "2024-12-11", "cutOffDateTime": "2024-12-11T15:30:00", "settlementDate": "2024-12-11", "status": "pending", "cancellationFee": null, "owner": "client", "relatedTransaction": { "nature": null, "id": null } ``` -------------------------------- ### Get Card Transaction Response Example (JSON) Source: https://developer.integrated.finance/docs/card-transactions This JSON object represents the successful response when retrieving a card transaction. It includes detailed information about the transaction, such as amounts, currencies, merchant details, and enrichment data. No specific dependencies are required to interpret this response. ```json { "workflow": {}, "data": { "cardTransaction": { "id": "9fbdfd66-0d1d-47d8-9e29-7c2c38abba8e", "cardId": "491c55ac-21ac-4e8a-bac6-ac9ef2b40c31", "clientId": "aa5e7c73-3bcf-4698-8619-9377915d6a96", "matchingTransactionId": null, "accountId": "28e423eb-04d4-4e07-8e4f-5614ffe5a6ae", "accountCurrency": "EUR", "transactionNumber": "20210301-ABC123", "type": "payment", "status": "settled", "transactionAmount": 100.00, "transactionCurrency": "EUR", "feeAmount": 10.00, "feeCurrency": "EUR", "billingAmount": -1.00, "billingCurrency": "EUR", "settlementAmount": 100.00, "settlementCurrency": "EUR", "effectiveTransactionAmount": 100.00, "effectiveFeeAmount": 10.00, "transactionExchangeRate": null, "feeExchangeRate": null, "merchant": { "name": "TfL Transport Travel Charge tfl.gov.uk/cp", "id": "merchantId", "networkId": "networkId", "taxId": "taxId", "address": { "country": "GB", "postalCode": "N42 0TO", "city": "London", "street": "26 Station Road" }, "phone": "+44 20 7946 0350", "website": "website", "category": { "code": "4111", "description": "Commuter Transport, Ferries" } }, "pos": { "cardholderPresent": null, "cardPresent": null, "cardDataInputMethod": null, "authentication": null, "chipFallback": null, "fraud": null, "securityProtocol": null, "cardAuthentication3DSecureMethod": "oob-biometric" }, "serviceProvider": "THD", "serviceProviderEntityId": "00000000-0000-0000-0000-000000000000", "serviceProviderEntityReference": "reference", "description": "description", "reason": "reason", "direction": "debit", "totalAmount": 110.00, "creationDateTime": "2024-03-01T10:00:00", "enrichment": { "merchant": { "brandName": "Transport for London", "logoUrl": "https://example.com/tfl.png", "latitude": "40.7128", "longitude": "-74.0060", "country": "GB", "city": "London", "zipCode": "SE1 5AA", "street": "London Bridge", "phone": "+448001234567", "email": "support@tfl.com", "website": "https://tfl.gov.uk" }, "recurringPayment": true, "category": { "primary": "Travel", "secondary": "Commute" }, "paymentProcessor": { "name": "Stripe", "logoUrl": "https://example.com/stripe-logo.png" } }, "authorisationCode": "245464", "paymentToken": { "id": "1360507", "creator": "MC-MDES", "expiryDate": "2028-08-31", "type": "SE", "status": "00", "creatorStatus": "A", "wallet": "APPLE", "deviceType": "M", "languageCode": "en", "deviceTelephoneNumber": "4567", "deviceIpAddress": "5610AFB3", "deviceId": "045117CD0E2190024005098121408915035E0670C15980E1", "deviceName": "..", "activationCode": "478972", "activationExpiryDateTime": "2025-07-16 11:18:00.000", "activationMethodData": "+447501234567", "activationMethod": "1" } } }, "connect": {}, "metadata": {} } ``` -------------------------------- ### JSON Connection Creation Example Source: https://developer.integrated.finance/docs/exchanges This JSON object represents the creation of a connection with a service provider, specifically 'currencycloud', in a 'creation-in-progress' state using a 'built-in' method. ```json { "connection": { "serviceProvider": "currencycloud", "state": "creation-in-progress", "method": "built-in" } } ``` -------------------------------- ### Get Account Information (Plug-In Response) Source: https://developer.integrated.finance/docs/client-accounts Retrieves account details using the plug-in provider connection method. This response mirrors the built-in format but specifies 'plug-in' for the connection method, indicating a different integration approach. ```json { "workflow": {}, "data": { "account": { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "status": "active", "country": "GB", "currency": "GBP", "alias": "test 1", "routingCodes": {}, "iban": null, "accountNumber": null, "ledgerNumber": "43611883", "availableBalance": 0.00, "receivableBalance": 0.00, "accountHolderIdentityType": "individual", "accountHolderName": "car keyboard", "mainAccountId": null, "serviceProvider": "service-provider-code", "connection": { "id": "00000000-0000-0000-0000-000000000000", "method": "plug-in", "serviceProvider": "service-provider-code", "reference": "00000000-0000-0000-0000-000000000000", "state": "completed-up-to-date", "status": "active", "error": null } }, "client": { "id": "00000000-0000-0000-0000-000000000000", "clientNumber": "23050065", "fullName": "car keyboard", "status": "active", "identity": { "type": "individual", "country": "GB", "identifications": [ { "type": "identity-card", "identificationNumber": "12345677", "issuingCountry": "GB", "issueDate": "2022-01-01", "expirationDate": "2032-01-01" } ], "givenName": "car", "familyName": "keyboard", "birthDate": "1953-01-06" } } }, "connect": {}, "metadata": { "include": [ "data.account.clientId" ] } } ``` -------------------------------- ### List Provisional Account Credits (JSON Response) Source: https://developer.integrated.finance/docs/incoming-transfers Example JSON response for the GET /provisioned-account-credits endpoint. This structure details the provisioned credits, including sender and receiver account information, amount, and currency. It can be used to understand the data format returned by the API. ```json { "workflow": {}, "data": { "provisionedAccountCredits": [ { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "accountId": "00000000-0000-0000-0000-000000000000", "accountType": "client-account", "amount": 15, "currency": "EUR", "scope": "external", "scheme": "sepa", "senderBankAccount": { "ledgerNumber": "12345678", "alias": "GBP Account", "accountHolderName": "", "accountNumber": "00000000", "iban": "GB99AAAA01234567890124", "country": "GB", "currency": "GBP", "routingCodes": { "bic": "AAAAGB22", "sort-code": "000000" } }, "senderName": "I.F. TECHNOLOGY", "senderAddress": "", "senderToReceiverInformation": "", "receiverAccount": { "ledgerNumber": "12345678", "alias": "GBP Account", "accountHolderName": "", "accountNumber": "00000000", "iban": "GB99AAAA01234567890123", "country": "GB", "currency": "GBP", "routingCodes": { "bic": "AAAAGB21", "sort-code": "000000" } }, "serviceProvider": "service-provider-code", "serviceProviderId": "00000000-0000-0000-0000-000000000000" }, { "id": "00000000-0000-0000-0000-000000000000", "clientId": "00000000-0000-0000-0000-000000000000", "accountId": "00000000-0000-0000-0000-000000000000", "accountType": "client-account", "amount": 15, "currency": "EUR", "scope": "external", "scheme": "sepa", "senderBankAccount": { "ledgerNumber": "12345678", "alias": "GBP Account", "accountHolderName": "", "accountNumber": "00000000", "iban": "GB99AAAA01234567890124", "country": "GB", "currency": "GBP", "routingCodes": { "bic": "AAAAGB22", "sort-code": "000000" } }, "senderName": "I.F. TECHNOLOGY", "senderAddress": "", "senderToReceiverInformation": "", "receiverAccount": { "ledgerNumber": "12345678", "alias": "GBP Account", "accountHolderName": "", "accountNumber": "00000000", "iban": "GB99AAAA01234567890123", "country": "GB", "currency": "GBP", "routingCodes": { "bic": "AAAAGB21", "sort-code": "000000" } }, "serviceProvider": "service-provider-code", "serviceProviderId": "00000000-0000-0000-0000-000000000000" } ] }, "connect": {}, "metadata": {} } ```