### Finalize Magento Setup Source: https://doc.fintecture.com/docs/magento-install-fintecture Run these commands after installing the module to update the database, compile dependency injection, and clear the cache. ```shell php bin/magento setup:upgrade php bin/magento setup:static-content:deploy -f php bin/magento setup:di:compile php bin/magento cache:clean ``` -------------------------------- ### Full Refund Request Example Source: https://doc.fintecture.com/reference/createpisv2refund Use this example to initiate a full refund. Ensure the session_id is valid. ```json { "meta": { "session_id": "ecec9f13407f4c2cb5f1591255e8f815" } } ``` -------------------------------- ### Example HTTP Signature Header Source: https://doc.fintecture.com/reference/createemandate This example shows the format for the 'signature' header, which is used for request security. It includes key ID, algorithm, headers, and the signature itself. ```http keyId="0354d723-d8d3-469a-8926-4f3f18b2c416",algorithm="rsa-sha256",headers="(request-target)date x-request-id",signature="eyvAyh5kuqifP8vkUy5KBWPgtQAurB7xMeC6T/KGJQm2JA==" ``` -------------------------------- ### Example E-Mandate Creation Request Source: https://doc.fintecture.com/reference/createemandate This is an example of a JSON payload for creating an e-mandate. It includes meta-information and debtor details. ```json { "meta": { "authentication_methods": [ "bank_account", "bank_transfer" ] }, "data": { "attributes": { "rum": "FT1129", "creditor_identifier": "XCT 1234f", "currency": "EUR", "debtor": { "email": "jon.doe+0901_03test@fintecture.com", "name": "Jon DOE", "first_name": "Jon", "last_name": "DOE", "company_name": "My Business SARL", "incorporation": { "id": "123", "registry": "SIREN", "country": "FR" }, "phone": "0793397660", "phone_prefix": "+33", "address": { "number": "1A", "street": "rue of france", "country": "FR", "zip": "94001", "city": "Paris" } } } } } ``` -------------------------------- ### Install Fintecture via Composer Source: https://doc.fintecture.com/docs/magento-install-fintecture Use these commands to install and enable the Fintecture module for either default Magento or Hyvä Checkout environments. ```shell composer require fintecture/payment php bin/magento module:enable Fintecture_Payment php bin/magento module:status Fintecture_Payment ``` ```shell composer require fintecture/payment-hyva php bin/magento module:enable Fintecture_HyvaPayment php bin/magento module:status Fintecture_HyvaPayment ``` -------------------------------- ### Authorization Header Example Source: https://doc.fintecture.com/reference/post_v1-organisation-nodes This is an example of the required authorization header for API requests. Replace `{access_token}` with your actual token. ```http Authorization: Bearer {access_token} ``` -------------------------------- ### Finalize Manual Installation Source: https://doc.fintecture.com/docs/magento-install-fintecture Execute these commands after manually uploading the module files to finalize the installation and refresh the Magento cache. ```shell php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento setup:static-content:deploy -f php bin/magento cache:flush php bin/magento cache:clear ``` -------------------------------- ### Define Address Schema Example Source: https://doc.fintecture.com/reference/patchpisv2paymentsession Example values for the address object fields. ```json "street": "rue Marie Stuart" "number": "2" "complement": "A" "city": "PARIS" "zip": "75002" ``` -------------------------------- ### Webhook POST Request Example Source: https://doc.fintecture.com/docs/api-webhooks This is an example of a webhook POST request, including headers and body. Ensure you verify the signature using your private key before processing the payment. ```cURL POST /webhook HTTP/1.1 Host: mywebsite.com Signature: keyId="2dfdcf57-5b2f-4309-846f-913d0b2802cf",algorithm="rsa-sha256",headers="date digest x-request-id",signature="h0V0SUbjRhLEP/MiYo0Mgs1N17EuCEmKyQrDjxysc7iSiFXTjvY6qVEoaiRkzB8ZI0J39gGwOtTXN9CJPVRbhEHhi9Z9rQvM33FkygXvvx8BwM76fSTQ2/BSZWx04CjbPv/XUVusnkKVr3W6p+Vn073hAuJn1nKCvDOyl+QnDtstkzT+UacVzDA9L9nyPbbaPQHJobaZuG8TjhnI+Y0PZxneke6OU6fcdPT0uwkEamDOOExcMryHIX1iH5iiPMvLoVA8acqvvMSDYar0rlEQ2J1M4dcowWT8FxLo6C8uqvJIaBYm7Ze0RNJOwY0UBImCVDIuQLJuBjPwjQT5GjTQlg==" Digest: SHA-256=wOtTXN9CJPVRbhEHhi9Z9rQvM33FkygXvvx8BwM76fS Date: Mon, 08 Jun 2020 23:11:23 GMT X-Request-ID: 88c414df-6895-48db-8ef3-1fd1ce4272c6 Content-Type: application/x-www-form-urlencoded session_id=b2bca2bcd3b64a32a7da0766df59a7d2&status=payment_created&customer_id=1ef74051a77673de120820fb370dc382&provider=bnpafr&state=mystate&event=payment_session.status.payment_created ``` -------------------------------- ### Example Digest Header Source: https://doc.fintecture.com/reference/createemandate This example demonstrates the format for the 'digest' header, which contains a SHA-256 base64 encoded digest of the request body. ```http SHA-256=RBNvo1WzZ4oRRq0W9+hknpT7T8If536DEMBg9hyq/4o= ``` -------------------------------- ### Example HTTP Signature Source: https://doc.fintecture.com/docs/api-http-signature An example of a complete HTTP signature string, including keyId, algorithm, headers, and the base64-encoded signature. ```cURL keyId="0354d723-d8d3-469a-8926-4f3f18b2c416",algorithm="rsa-sha256",headers="(request-target) date digest x-request-id",signature="eyvAyh5kuqifP8vkUy5KBWPgtQAurB7xMeC6T/KGJQm2JA==" ``` -------------------------------- ### Membership Update Response Example Source: https://doc.fintecture.com/reference/patch_v1-memberships-membership-id The structure of a successful membership update response. ```json { "data": { "type": "memberships", "id": "5f1f3a3a-7f9b-4ac1-8b9c-0b2a2b4c6d7e", "attributes": { "role": "developer", "status": "active", "notifications": [ { "type": "manual_transfer", "pay_by_bank": false, "created_by_me": true, "created_by_others": true, "received_not_by_fintecture": false, "partial_payment": true } ] } } } ``` -------------------------------- ### GET /organisation-nodes/{organisationNodeId}/tree Source: https://doc.fintecture.com/reference/get_v1-organisation-nodes-organisation-node-id-tree Retrieves the organisation tree starting from a specific node. The response includes the requested node's children and metadata about the accessible tree structure. ```APIDOC ## GET /organisation-nodes/{organisationNodeId}/tree ### Description Retrieves the organisation tree structure. Returns top-level nodes and any expanded nodes at deeper levels in JSON:API format. ### Method GET ### Endpoint /organisation-nodes/{organisationNodeId}/tree ### Parameters #### Path Parameters - **organisationNodeId** (string) - Required - The unique identifier of the organisation node. ### Response #### Success Response (200) - **data** (array) - Top level nodes (children of top accessible organisation node). - **included** (array) - All expanded nodes at deeper levels. - **meta** (object) - Metadata containing requested_node_id and top_accessible_organisation_node_id. #### Response Example { "data": [ { "type": "organisation_nodes", "id": "uuid-node-a", "attributes": { "name": "Node A", "kind": "GROUP", "depth": 1, "path": "root-uuid/uuid-node-a/", "companies_count": 3 }, "relationships": { "children": { "data": [ { "type": "organisation_nodes", "id": "uuid-node-a1" }, { "type": "organisation_nodes", "id": "uuid-node-a2" } ] } } } ], "included": [ { "type": "organisation_nodes", "id": "uuid-node-a1", "attributes": { "name": "Node A1", "kind": "GROUP", "depth": 2, "path": "root-uuid/uuid-node-a/uuid-node-a1/", "companies_count": 2 } } ] } ``` -------------------------------- ### Initiate Fintecture Client (cURL) Source: https://doc.fintecture.com/recipes/follow-all-payments This snippet shows how to initiate the Fintecture client using cURL. Ensure you have your app identifier, app secret, private key, and the correct base URL. ```bash // Get your app identifier: {app_id} ``` ```bash // Get your app_secret: {app_secret} ``` ```bash // Get your private_key: {app_private_key} ``` ```bash // Check requested environment base url: {base_url} ``` -------------------------------- ### Request Customers Token Source: https://doc.fintecture.com/reference/createaccesstoken Use this example to request an access token for Customers services. Requires client credentials including app_id and scope. ```json { "grant_type": "client_credentials", "app_id": "dc5b0048-2a80-4a22-b2f9-fad7d72f074d", "scope": "customers" } ``` -------------------------------- ### POST /applications Source: https://doc.fintecture.com/reference/post_v1-applications Creates a new application resource with associated bank account details and webhook configurations. ```APIDOC ## POST /applications ### Description Creates a new application in the system. This endpoint supports linking a company and a bank account, as well as configuring webhooks. ### Method POST ### Endpoint /applications ### Request Body - **data** (object) - Required - The application resource data - **relationships** (object) - Required - Links to company and bank_account - **included** (array) - Optional - Included bank account details ### Request Example { "data": { "relationships": { "company": { "data": { "type": "companies", "id": "c0ffee00-1234-5678-9abc-def012345678" } }, "bank_account": { "data": { "type": "bank_accounts", "lid": "temp-bank-account-1" } } } }, "included": [ { "type": "bank_accounts", "lid": "temp-bank-account-1", "attributes": { "iban": "FR7612345987650001112223334", "swift_bic": "FTSBSESSXXX", "commercial_name": "Commercial Name", "description": "Main EUR account for supplier payments" } } ] } ### Response #### Success Response (201) - **data** (object) - The created application resource containing app_name, app_environment, app_type, app_public_key, app_secret, app_urls, and app_webhooks. #### Response Example { "data": { "type": "applications", "id": "a1b2c3d4-1234-5678-9abc-def012345678", "attributes": { "app_name": "My New Application", "app_environment": "sandbox", "app_type": "shop", "app_secret": "s3cr3t-1234-5678-9abc-def012345678", "app_webhooks": [ { "url": "https://my-app.com/webhooks", "events": ["payment_session.status.payment_cancelled", "payment_session.status.payment_created"] } ] } } } ``` -------------------------------- ### POST /applications Source: https://doc.fintecture.com/reference/post_v1-applications Creates a new application resource with the specified attributes and relationships. ```APIDOC ## POST /applications ### Description Creates a new application within the system. Requires company and bank account relationships. ### Method POST ### Endpoint /applications ### Request Body - **data** (object) - Required - The application data object - **type** (string) - Required - Must be 'applications' - **attributes** (object) - Required - Application attributes - **app_name** (string) - Required - Name of the application - **app_public_key** (string) - Optional - Public key for the application - **app_webhooks** (array) - Optional - Webhook configurations - **app_urls** (array) - Optional - URLs associated with the application - **relationships** (object) - Required - Associated entities - **company** (object) - Required - Company relationship - **bank_account** (object) - Required - Bank account relationship ### Request Example { "data": { "type": "applications", "attributes": { "app_name": "My Application" }, "relationships": { "company": { "data": { "id": "..." } }, "bank_account": { "data": { "id": "..." } } } } } ``` -------------------------------- ### POST /pis/v2/connect Source: https://doc.fintecture.com/docs/createpisv2connect This endpoint provides a payment session for a PSU to initiate a payment. It supports Immediate Transfer, Smart Transfer, or Buy Now Pay Later payments. ```APIDOC ## POST /pis/v2/connect ### Description This endpoint aims at providing a payment session for a PSU to initiate a payment. The same endpoint can be used to generate an **Immediate Transfer** , a **Smart Transfer** or a **Buy Now Pay Later** payment. ### Method POST ### Endpoint https://api-sandbox.fintecture.com/pis/v2/connect ### Parameters #### Query Parameters - **state** (string) - required - length ≤ 512 - a state parameter which will be provided back on redirection - **redirect_uri** (string) - required - must correspond to one of the URLs provided when creating an application on the console. Required in Redirect mode. - **origin_uri** (string) - optional - The URL to which he will be returned if he cancels the payment from the Connect webview. By default the user is returned to the previous screen (i.e. your checkout page) - **with_beneficiary** (boolean) - optional - Returns the beneficiary in the response - **with_virtualbeneficiary** (boolean) - optional - Returns the virtual beneficiary in the response. Requires an internal payment account to be enabled. ⚠️ This query param **should only be added for Smart Transfer payments** as the virtual beneficiary is only available for those payments. #### Request Body - **meta** (object) - optional - Description of a Payer - **psu** (object) - optional - Psu object - **data** (object) - required - data object #### Headers - **digest** (string) - required - Sha-256 base64 encoded digest. Related documentation can be found by clicking **here** - **x-request-id** (string) - required - uuid v4. Required in Redirect mode. - **x-psu-type** (string) - optional - enum: `retail`, `corporate`, `all` - Type of PSU - **x-country** (string) - optional - length between 2 and 2 - 2 letter country code - **x-language** (string) - optional - length between 2 and 2 - A 2 letter language code to set the preferred language for PSU notifications. Default value: en - **x-provider** (string) - optional - provider_id - **signature** (string) - required - Signature is used to enforce security by signing request. Related documentation can be found by clicking **here** - **date** (string) - required - RFC2822 formatted date. ### Responses #### Success Response (200) - **successful operation** (object) - Description of a successful operation. #### Error Responses - **400** - bad request - **401** - unauthorized - **403** - forbidden - **500** - internal server error ### Request Example ```json { "meta": { "psu": { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone_number": "+1234567890" } }, "data": { "amount": 100, "currency": "EUR", "reference": "ORDER123", "payment_type": "IMMEDIATE_TRANSFER" } } ``` ### Response Example (200 - Standard Response) ```json { "payment_id": "pay_12345abcde", "status": "PENDING", "redirect_url": "https://connect.fintecture.com/pay?token=..." } ``` ``` -------------------------------- ### Create a Payment Session Source: https://doc.fintecture.com/docs/api-initiate-an-immediate-payment POST request to initiate a payment session and receive a connect URL for the user. ```http POST /pis/v2/connect?redirect_uri=[redirect_uri]&state=[state] HTTP/1.1 Authorization: Bearer [access_token] Signature: [signature] Digest: [digest] Date: [date] x-request-id: [request_id] Accept: application/json Content-Type: application/json { "meta": { "psu_name" : "Julien Lefebre", "psu_company": "My Business SARL" "psu_email" : "julien.lefebre@my-business-sarl.com", "psu_phone" : "09743593535", "psu_incorporation": "123456789", "psu_address": { "street": "rue Marie Stuart", "number": "2", "complement": "2nd floor", "zip": "75002", "city": "PARIS", "country": "FR" } }, "data": { "type" : "payments", "attributes" : { "amount" : "273", "currency": "EUR", "communication" : "B34970692" } } } ``` -------------------------------- ### GET /v1/customers/verifications Source: https://doc.fintecture.com/reference/listallcustomerverifications Retrieves a list of all customer verifications. ```APIDOC ## GET /v1/customers/verifications ### Description List all customer verifications. ### Method GET ### Endpoint /v1/customers/verifications ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number to retrieve. - **pageSize** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **CustomerVerificationV1List** (object) - A list of customer verification objects. ``` -------------------------------- ### Partial Refund Request Example Source: https://doc.fintecture.com/reference/createpisv2refund Initiate a partial refund by specifying the amount. The amount should be a string representing a decimal number. ```json { "meta": { "session_id": "ecec9f13407f4c2cb5f1591255e8f815" }, "data": { "attributes": { "amount": "149.30" } } } ``` -------------------------------- ### GET /customers Source: https://doc.fintecture.com/reference/listallcustomers Retrieves a list of all registered customers. ```APIDOC ## GET /customers ### Description This endpoint provides a comprehensive overview of all registered customers. ### Method GET ### Endpoint /customers ``` -------------------------------- ### GET /applications Source: https://doc.fintecture.com/reference/get_v1-applications Retrieves a list of applications. Supports including related bank account data via query parameters. ```APIDOC ## GET /applications ### Description Retrieves a list of applications associated with the authenticated user. Supports optional inclusion of related bank account data. ### Method GET ### Endpoint /applications ### Parameters #### Query Parameters - **include** (string) - Optional - Use 'bank_accounts' to include related bank account details in the response. ### Response #### Success Response (200) - **data** (array) - List of application objects. - **included** (array) - Included related resources (e.g., bank_accounts). - **meta** (object) - Pagination metadata including total, page, and size. #### Response Example { "data": [ { "type": "applications", "id": "a1b2c3d4-1234-5678-9abc-def012345678", "attributes": { "app_name": "My Application", "app_environment": "production", "app_type": "shop" } } ], "meta": { "total": 1, "page": 1, "size": 25 } } ``` -------------------------------- ### Webhook HTTP Request Example Source: https://doc.fintecture.com/docs/api-initiate-an-immediate-payment This is an example of the HTTP POST request sent by our servers to your webhook endpoint. It includes essential headers for authentication and data integrity, such as Signature, Digest, Date, and X-Request-ID. Ensure your server can parse the x-www-form-urlencoded body and verify the signature. ```http POST /webhook HTTP/1.1 Host: mywebsite.com Signature: keyId="2dfdcf57-5b2f-4309-846f-913d0b2802cf",algorithm="rsa-sha256",headers="date digest x-request-id",signature="h0V0SUbjRhLEP/MiYo0Mgs1N17EuCEmKyQrDjxysc7iSiFXTjvY6qVEoaiRkzB8ZI0J39gGwOtTXN9CJPVRbhEHhi9Z9rQvM33FkygXvvx8BwM76fSTQ2/BSZWx04CjbPv/XUVusnkKVr3W6p+Vn073hAuJn1nKCvDOyl+QnDtstkzT+UacVzDA9L9nyPbbaPQHJobaZuG8TjhnI+Y0PZxneke6OU6fcdPT0uwkEamDOOExcMryHIX1iH5iiPMvLoVA8acqvvMSDYar0rlEQ2J1M4dcowWT8FxLo6C8uqvJIaBYm7Ze0RNJOwY0UBImCVDIuQLJuBjPwjQT5GjTQlg==" Digest: SHA-256=wOtTXN9CJPVRbhEHhi9Z9rQvM33FkygXvvx8BwM76fS Date: Mon, 08 Jun 2020 23:11:23 GMT X-Request-ID: 88c414df-6895-48db-8ef3-1fd1ce4272c6 Content-Type: application/x-www-form-urlencoded session_id=b2bca2bcd3b64a32a7da0766df59a7d2&status=payment_created&customer_id=1ef74051a77673de120820fb370dc382&provider=provider&state=thisisastate ``` -------------------------------- ### Get Specific Payment Details (cURL) Source: https://doc.fintecture.com/docs/getpaymentsession Use this cURL command to make a GET request to the Fintecture API to retrieve details for a specific payment session. Ensure you replace '{session_id}' with the actual session ID and '' with your valid Bearer token. ```shell curl --request GET \ --url https://api-sandbox.fintecture.com/pis/v2/payments/session_id \ --header 'accept: application/json' \ --header 'authorization: Bearer ' ``` -------------------------------- ### GET /v1/e-mandates Source: https://doc.fintecture.com/reference/listallemandates Retrieves a list of e-mandates with filtering options. ```APIDOC ## GET /v1/e-mandates ### Description Retrieves a list of e-mandates with filtering options. ### Method GET ### Endpoint /v1/e-mandates ### Parameters #### Query Parameters - **pageNumber** (integer) - Optional - The page number for pagination. - **filter[emandate_status]** (string) - Optional - Filters e-mandates by their status. - **filter[emandate_rum]** (string) - Optional - Filters e-mandates by their RUM. ### Responses #### Success Response (200) - **EMandateV1List** (object) - A list of e-mandates. #### Error Responses - **401** - Unauthorized - **403** - Forbidden - **500** - Internal Server Error ``` -------------------------------- ### POST /api/v2/connect/payment-sessions Source: https://doc.fintecture.com/reference/createpisv2connect Creates a payment session for a PSU to initiate a payment. This endpoint supports Immediate Transfers, Smart Transfers, and Buy Now Pay Later payments. For mixed payment types, refer to the Fintecture Payment Hub guide. ```APIDOC ## POST /api/v2/connect/payment-sessions ### Description This endpoint aims at providing a payment session for a PSU to initiate a payment. The same endpoint can be used to generate an **Immediate Transfer**, a **Smart Transfer** or a **Buy Now Pay Later** payment. To mix Immediate Transfer, Smart Transfer and Buy Now Pay Later in the same payment session, see the [Fintecture Payment Hub guide](https://doc.fintecture.com/docs/payment-hub)

🚧 Important

Signature, digest, date and x-request-id headers are mandatory when calling the PRODUCTION environment

💡 Note

Request payloads examples for Immediate Transfer, Smart Transfer and Buy Now Pay Later can be found under the "Example" dropdown.

### Method POST ### Endpoint /api/v2/connect/payment-sessions ### Parameters #### Header Parameters - **signature** (string) - Required - SHA-256 base64 encoded digest. Related documentation can be found by clicking [here](https://doc.fintecture.com/docs/api-http-signature) - **date** (string) - Required - **x-request-id** (string) - Required in Redirect mode. - **x-psu-type** (string) - Optional - **x-country** (string) - Optional - 2 letter country code - **x-language** (string) - Optional - A 2 letter language code to set the preferred language for PSU notifications. Default value: en - **x-provider** (string) - Optional - provider_id #### Query Parameters - **origin_uri** (string) - Optional - The URL to which he will be returned if he cancels the payment from the Connect webview. By default the user is returned to the previous screen (i.e. your checkout page) - **redirect_uri** (string) - Optional - Must correspond to one of the URLs provided when creating an application on the console. Required in Redirect mode. - **state** (string) - Required - A state parameter which will be provided back on redirection - **with_beneficiary** (boolean) - Optional - Returns the beneficiary in the response - **with_virtualbeneficiary** (boolean) - Optional ### Request Body *The request body schema is not provided in the input.* ### Request Example *No request example is provided in the input.* ### Response #### Success Response (200) - **description** (string) - successful operation #### Error Responses - **400** - BadRequest - **401** - Unauthorized - **403** - Forbidden - **500** - InternalServerError #### Response Example *No response example is provided in the input.* ``` -------------------------------- ### POST /customers Source: https://doc.fintecture.com/reference/createcustomer Endpoint to register a new customer for payment acceleration. ```APIDOC ## POST /customers ### Description This endpoint allows registering of your customers to accelerate your payments. ### Method POST ### Endpoint /customers ``` -------------------------------- ### GET /v1/transactions Source: https://doc.fintecture.com/reference/listalltransactions Retrieves a list of transactions. Supports pagination. ```APIDOC ## GET /v1/transactions ### Description Retrieves a list of transactions with associated payment session data. This endpoint supports pagination. ### Method GET ### Endpoint /v1/transactions ### Query Parameters - **page[number]** (integer) - Optional - The page number to retrieve. - **page[size]** (integer) - Optional - The number of items per page. ### Response #### Success Response (200) - **meta** (object) - Metadata about the transaction list, including total items and pages. - **total_items** (integer) - The total number of transactions available. - **total_pages** (integer) - The total number of pages available. - **data** (array) - An array of transaction objects. - **id** (string) - The unique identifier for the transaction (UUID v4). - **type** (string) - The type of the resource, always "transactions". - **attributes** (object) - The attributes of the transaction. - **amount** (object) - The transaction amount. (Refer to Amount schema) - **label** (string) - Short communication provided by the payer. - **currency** (string) - The currency code of the transaction. (Refer to CurrencyCode schema) - **booked_date** (string) - The date when the transaction was booked. (Refer to Date schema) - **value_date** (string) - The value date of the transaction. (Refer to Date schema) - **end_to_end_id** (string) - The end-to-end identifier for the transaction. (Refer to IdentifierEndToEnd schema) - **reference** (string) - Additional communication information from the payer. - **relationships** (object) - Relationships to other resources. - **payments** (object) - A list of payment session identifiers related to the transaction. - **data** (array) - An array of payment session identifier objects. - **id** (string) - The identifier for the payment session. (Refer to SessionId schema) - **type** (string) - The type of the resource, always "payments". - **links** (object) - Pagination links. - **self** (string) - URL for the current page. - **next** (string) - URL for the next page. - **last** (string) - URL for the last page. #### Response Example ```json { "meta": { "total_items": 105, "total_pages": 5 }, "data": [ { "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "type": "transactions", "attributes": { "amount": { "value": "100.00", "currency": "EUR" }, "label": "Payment for invoice #123", "currency": "EUR", "booked_date": "2023-10-27", "value_date": "2023-10-27", "end_to_end_id": "E2E123456789", "reference": "Invoice #123" }, "relationships": { "payments": { "data": [ { "id": "pay_session_abc123", "type": "payments" } ] } } } ], "links": { "self": "https://api.fintecture.com/v1/transactions?page[number]=1", "next": "https://api.fintecture.com/v1/transactions?page[number]=2", "last": "https://api.fintecture.com/v1/transactions?page[number]=5" } } ``` ``` -------------------------------- ### Get AIS Connect URL Source: https://doc.fintecture.com/recipes/initiate-an-immediate-payment-b2c Initiates the Fintecture client and requests the AIS Connect URL. Ensure your app_id, app_secret, and private_key are correctly configured. The base_url should point to the requested environment. ```bash // Get your app identifier: {app_id} // Get your app_secret: {app_secret} // Get your private_key: {app_private_key} // Check requested environment base url: {base_url} curl --request GET \ --url https://{base_url}/ais/v2/connect?redirect_uri={redirect_uri}&state={state} \ --header 'accept: application/json' \ --header 'app_id: {app_id}' \ --header 'signature: {signed_request}' \ --header 'date: {date}' \ --header 'x-request-id: {request id}' ``` -------------------------------- ### GET /pis/v2/settlements/{settlement_id} Source: https://doc.fintecture.com/reference/getsettlementbyid Retrieves information about a specific settlement. ```APIDOC ## GET /pis/v2/settlements/{settlement_id} ### Description This endpoint gives information about a specific settlement. ### Method GET ### Endpoint /pis/v2/settlements/{settlement_id} ### Parameters #### Path Parameters - **settlement_id** (string) - Required - The ID of the settlement to retrieve. #### Query Parameters - **include** (string) - Optional - Specifies related resources to include in the response. (e.g., 'transactions') ### Responses #### Success Response (200) - **PisV2Settlement** (object) - Detailed information about the settlement. #### Error Responses - **401** - Unauthorized - **403** - Forbidden - **404** - Not Found - **500** - Internal Server Error ``` -------------------------------- ### POST /applications Source: https://doc.fintecture.com/reference/post_v1-applications Create a new application with Fintecture. This endpoint allows for the creation of applications, with options to link existing bank accounts, use OAC tokens, or create bank accounts inline. ```APIDOC ## POST /applications ### Description Creates a new application within the Fintecture system. This endpoint supports various configurations, including associating with an existing company and bank account, or providing bank account details inline. ### Method POST ### Endpoint /applications ### Parameters #### Request Body - **data** (object) - Required - The main payload for the application creation. - **type** (string) - Required - Must be 'applications'. - **attributes** (object) - Required - Contains the application's specific details. - **app_name** (string) - Required - The name of the application. - **app_public_key** (string) - Optional - The public key for the application. If not provided, it will be automatically preloaded from OAC credentials. - **app_urls** (array) - Required - A list of URLs associated with the application. - **type** (string) - Required - The type of URL, e.g., 'domain'. - **url** (string) - Required - The URL itself. - **app_webhooks** (array) - Optional - A list of webhook configurations. - **url** (string) - Required - The webhook endpoint URL. - **events** (array) - Required - A list of events to subscribe to. - **offset** (integer) - Optional - Offset for webhook events. - **headers** (array) - Optional - Custom headers for the webhook. - **name** (string) - Required - Header name. - **value** (string) - Required - Header value. - **relationships** (object) - Optional - Links to other resources. - **company** (object) - Required - The company associated with the application. - **data** (object) - Required. - **type** (string) - Required - Must be 'companies'. - **id** (string) - Required - The ID of the company. - **bank_account** (object) - Optional - The bank account associated with the application. - **data** (object) - Required. - **type** (string) - Required - Must be 'bank_accounts'. - **id** (string) - Required - The ID of the bank account. ### Request Example #### withExistingBankAccount ```json { "data": { "type": "applications", "attributes": { "app_name": "My New Application", "app_public_key": "-----BEGIN PUBLIC KEY-----\nMIIBI...", "app_urls": [ { "type": "domain", "url": "https://my-app.com" } ], "app_webhooks": [ { "url": "https://my-app.com/webhooks", "events": [ "payment_session.status.payment_cancelled", "payment_session.status.payment_created" ], "offset": 0, "headers": [ { "name": "X-My-Header", "value": "My-Value" } ] } ] }, "relationships": { "company": { "data": { "type": "companies", "id": "c0ffee00-1234-5678-9abc-def012345678" } }, "bank_account": { "data": { "type": "bank_accounts", "id": "b2c3d4e5-2345-6789-abcd-ef0123456789" } } } } } ``` #### withoutPublicKey ```json { "data": { "type": "applications", "attributes": { "app_name": "My OAC Application", "app_urls": [ { "type": "domain", "url": "https://my-oac-app.com" } ], "app_webhooks": [ { "url": "https://my-oac-app.com/webhooks", "events": [ "payment_session.status.payment_created" ], "offset": 0, "headers": [] } ] }, "relationships": { "company": { "data": { "type": "companies", "id": "c0ffee00-1234-5678-9abc-def012345678" } }, "bank_account": { "data": { "type": "bank_accounts", "id": "b2c3d4e5-2345-6789-abcd-ef0123456789" } } } } } ``` #### withInlineBankAccount ```json { "data": { "type": "applications", "attributes": { "app_name": "My New Application", "app_public_key": "-----BEGIN PUBLIC KEY-----\nMIIBI...", "app_urls": [ { "type": "domain", "url": "https://my-app.com" } ], "app_webhooks": [ { "url": "https://my-app.com/webhooks", "events": [ "payment_session.status.payment_cancelled", "payment_session.status.payment_created" ], "offset": 0, "headers": [ { "name": "X-My-Header", "value": "My-Value" } ] } ] }, "relationships": { "company": { "data": { "type": "companies", "id": "c0ffee00-1234-5678-9abc-def012345678" } }, "bank_account": { "data": { "type": "bank_accounts", "id": "b2c3d4e5-2345-6789-abcd-ef0123456789" } } } } } ``` ### Response #### Success Response (201 Created) - **data** (object) - The created application object. - **type** (string) - 'applications'. - **id** (string) - The unique identifier for the created application. - **attributes** (object) - The attributes of the created application. - **relationships** (object) - The relationships of the created application. #### Response Example ```json { "data": { "type": "applications", "id": "a1b2c3d4-5678-90ab-cdef-0123456789ab", "attributes": { "app_name": "My New Application", "app_public_key": "-----BEGIN PUBLIC KEY-----\nMIIBI...", "app_urls": [ { "type": "domain", "url": "https://my-app.com" } ], "app_webhooks": [ { "url": "https://my-app.com/webhooks", "events": [ "payment_session.status.payment_cancelled", "payment_session.status.payment_created" ], "offset": 0, "headers": [ { "name": "X-My-Header", "value": "My-Value" } ] } ] }, "relationships": { "company": { "data": { "type": "companies", "id": "c0ffee00-1234-5678-9abc-def012345678" } }, "bank_account": { "data": { "type": "bank_accounts", "id": "b2c3d4e5-2345-6789-abcd-ef0123456789" } } } } } ``` ``` -------------------------------- ### GET /v1/customers/verifications Source: https://doc.fintecture.com/reference/listallcustomerverifications Retrieves a paginated list of customer verifications. ```APIDOC ## GET /v1/customers/verifications ### Description Retrieves a list of customer verifications with pagination links. ### Method GET ### Endpoint /v1/customers/verifications ### Response #### Success Response (200) - **data** (array) - List of customer verification objects. - **links** (object) - Pagination links including self, next, and last. #### Response Example { "data": [], "links": { "self": "https://api.fintecture.com/v1/customers/verifications?page[number]=2", "next": "https://api.fintecture.com/v1/customers/verifications?page[number]=3", "last": "https://api.fintecture.com/v1/customers/verifications?page[number]=1" } } ``` -------------------------------- ### Project Configuration Structure Source: https://doc.fintecture.com/reference/post_v1-users Represents the nested configuration hierarchy for the project. ```json { } } } } } } } ``` -------------------------------- ### Get an e-mandate Source: https://doc.fintecture.com/reference/getemandatebyid Retrieves a specific customer e-mandate by its ID. ```APIDOC ## GET /v1/e-mandates/{emandate_id} ### Description Get a customer e-mandate ### Method GET ### Endpoint /v1/e-mandates/{emandate_id} ### Parameters #### Path Parameters - **emandate_id** (string) - Required - The ID of the e-mandate to retrieve. #### Header Parameters - **signature** (string) - Required - The signature of the request. - **date** (string) - Required - The date of the request. - **x-RequestId** (string) - Required - The request ID. ### Responses #### Success Response (200) - **EMandateV1** (object) - Successful operation #### Error Responses - **401** - Unauthorized - **403** - Forbidden - **404** - Not Found - **500** - Internal Server Error ``` -------------------------------- ### GET /bank_accounts Source: https://doc.fintecture.com/reference/get_v1-companies Retrieves a paginated list of bank accounts. ```APIDOC ## GET /bank_accounts ### Description Retrieves a list of bank accounts associated with the authenticated user. ### Method GET ### Endpoint /bank_accounts ### Parameters #### Query Parameters - **page[number]** (integer) - Optional - The page number of the response. Default: 1. - **page[size]** (integer) - Optional - The number of results returned on a page. Default: 100. ### Response #### Success Response (200) - **data** (array) - List of bank account objects. - **meta** (object) - Pagination metadata including total, page, and size. #### Response Example { "data": [ { "type": "bank_accounts", "id": "3b6b0d5c-1f2e-4b9c-a3a1-2fb0ec3a4d55", "attributes": { "iban": "FR7612345987650001112223334", "swift_bic": "FTSBSESSXXX", "name": "My bank", "commercial_name": "Commercial name" } } ], "meta": { "total": 2, "page": 1, "size": 25 } } ```