Ponto Connect

https://documentation.ibanity.com/ponto-connect/
Admin
Ponto Connect is a secure API that enables third-party software developers to help their customers...
Tokens:329,823
Snippets:1,285
Trust Score:6.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Account Resource Example

Source: https://documentation.ibanity.com/ponto-connect/api/curl

This snippet shows an example JSON response for a retrieved account resource. It includes details such as account balance, currency, holder name, and synchronization status. The response structure adheres to the application/vnd.api+json format.

```json
{
  "data": {
    "attributes": {
      "deprecated": false,
      "description": "Natus magnam aliquid.",
      "reference": "FR634651777754ERBI0HJTW2U88",
      "product": "Current account",
      "currency": "EUR",
      "authorizationExpirationExpectedAt": "2025-07-17T14:14:26.569Z",
      "currentBalance": -465.33,
      "subtype": "checking",
      "availableBalance": -465.33,
      "referenceType": "IBAN",
      "holderName": "Spencer Nikolaus",
      "internalReference": "8e49fac4-7eb1-41d2-8c8c-30adc94c56fb",
      "authorizedAt": "2025-04-18T14:14:26.569Z",
      "availableBalanceChangedAt": "2025-04-22T13:32:00.373Z",
      "availableBalanceReferenceDate": "2025-04-22T14:30:32.000Z",
      "availableBalanceVariationObservedAt": "2025-04-22T13:32:00.380Z",
      "currentBalanceChangedAt": "2025-04-22T13:32:00.373Z",
      "currentBalanceReferenceDate": "2025-04-22T14:30:32.000Z",
      "currentBalanceVariationObservedAt": "2025-04-22T13:32:00.380Z"
    },
    "id": "5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b",
    "meta": {
      "latestSynchronization": {
        "attributes": {
          "createdAt": "2025-04-22T13:31:59.969Z",
          "customerOnline": true,
          "errors": [],
          "resourceId": "5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b",
          "resourceType": "account",
          "status": "success",
          "subtype": "accountDetails",
          "updatedAt": "2025-04-22T13:32:00.481Z"
        },
        "id": "68e0e4d4-499b-437a-a058-9bed2c6987b0",
        "type": "synchronization"
      },
      "synchronizedAt": "2025-04-22T13:32:00.481Z",
      "availability": "available"
    },
    "type": "account",
    "relationships": {
      "financialInstitution": {
        "data": {
          "id": "41ed5259-9e07-43a7-b8c2-3854adef2067",
          "type": "financialInstitution"
        },
        "links": {
          "related": "https://api.ibanity.com/ponto-connect/financial-institutions/41ed5259-9e07-43a7-b8c2-3854adef2067"
        }
      },
      "transactions": {
        "links": {
          "meta": {
            "type": "transaction"
          },
          "related": "https://api.ibanity.com/ponto-connect/accounts/5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b/transactions"
        }
      }
    }
  }
}
```

--------------------------------

### Example Response for Get Payment Request

Source: https://documentation.ibanity.com/ponto-connect/api/curl

This is an example JSON response when retrieving a payment request. It includes details such as currency, amount, creditor account reference, and signing URI.

```json
{
  "data": {
    "attributes": {
      "currency": "EUR",
      "amount": 0.5,
      "creditorAccountReference": "FR634651777754ERBI0HJTW2U88",
      "creditorAccountReferenceType": "IBAN",
      "debtorAccountReference": null,
      "debtorAccountReferenceType": null,
      "remittanceInformation": null,
      "remittanceInformationType": null,
      "redirectUri": null,
      "closedAt": null,
      "endToEndId": null,
      "signedAt": null,
      "signingUri": "https://sandbox-pay.acceptance.myponto.net/organizations/3953d4ab-7ec4-4c0b-8b91-4be8626c0946/payment-requests/7f9432f2-4a76-4ab3-9f42-b63efb5a1581"
    },
    "id": "7f9432f2-4a76-4ab3-9f42-b63efb5a1581",
    "type": "paymentRequest"
  }
}
```

--------------------------------

### Example cURL Request for Pending Transactions

Source: https://documentation.ibanity.com/ponto-connect/api

An example cURL command demonstrating how to fetch pending transactions, including necessary headers and authentication.

```bash
curl -g  -s -X GET https://api.ibanity.com/ponto-connect/accounts/5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b/pending-transactions/bac0f85d-f1d8-4e15-b46d-fa305ff46848 \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/vnd.api+json" \
-H "Authorization: Bearer i4DYE9kHWirKIBeEQQQI85uEdsH31JGb7M001L3bWyE.e2giF1QCuT07Mf61Yq9rj4_Q6w_ZOqeHqJtbPKBIGaI"
```

--------------------------------

### Get Organization Usage Request Example (cURL)

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Example cURL command to request organization usage data for a specific month. Requires authentication with a client access token and certificate.

```bash
curl -g  -s -X GET https://api.ibanity.com/ponto-connect/organizations/3953d4ab-7ec4-4c0b-8b91-4be8626c0946/usage/2020-07 \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/json" \
-H "Authorization: Bearer a2QAJcPhLegFYw1a6MTxXgMEd9ALhs4s4Fatcbgek5c.KyvPeRt2GMJx_cv7MmI_0ePjXVNWTZr3nqahXOaKMsg"
```

--------------------------------

### Get Accounts with Pagination (cURL)

Source: https://documentation.ibanity.com/ponto-connect/api/curl

This example demonstrates how to retrieve a list of accounts with pagination parameters using cURL. It specifies the number of items per page and an 'after' cursor for fetching subsequent pages. The request requires client certificate authentication and an 'Accept' header for JSON.

```bash
$ curl -X GET https://api.ibanity.com/ponto-connect/accounts?page[limit]=2&page[after]=80cdb338-0da8-4039-863c-b108943c1e22 \
--cert certificate.pem \
--key private_key.pem \
-H "Accept: application/json"
```

--------------------------------

### Synchronization Resource Object Example

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Provides an example of a synchronization resource object, detailing its attributes such as status, creation/update timestamps, subtype, resource ID, and resource type, as well as its relationships.

```json
{
  "attributes": {
    "status": "success",
    "errors": [],
    "createdAt": "2025-04-22T13:32:42.907Z",
    "updatedAt": "2025-04-22T13:32:43.340Z",
    "subtype": "accountTransactionsWithUnsettled",
    "resourceId": "5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b",
    "resourceType": "account"
  },
  "id": "89cfd963-683a-4deb-bdc4-131655b53414",
  "type": "synchronization",
  "relationships": {
    "updatedTransactions": {
      "links": {
        "meta": {
          "type": "transaction"
        },
        "related": "https://api.acceptance.myponto.net/synchronizations/89cfd963-683a-4deb-bdc4-131655b53414/updated-transactions"
      }
    }
  }
}
```

--------------------------------

### Synchronization Relationships Example

Source: https://documentation.ibanity.com/ponto-connect/api

This example shows the relationships object for a synchronization resource. It specifically details the link to updated transactions, including metadata and the related resource URL.

```json
{
  "updatedTransactions": {
    "links": {
      "meta": {
        "type": "transaction"
      },
      "related": "https://api.acceptance.myponto.net/synchronizations/89cfd963-683a-4deb-bdc4-131655b53414/updated-transactions"
    }
  }
}
```

--------------------------------

### List Transactions Request Example (cURL)

Source: https://documentation.ibanity.com/ponto-connect/api/curl

An example cURL request to list transactions for a specific account. It demonstrates the use of headers like 'Accept' and 'Authorization', and query parameters for pagination.

```bash
curl -g  -s -X GET https://api.ibanity.com/ponto-connect/accounts/5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b/transactions?page[limit]=1 \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/vnd.api+json" \
-H "Authorization: Bearer i4DYE9kHWirKIBeEQQQI85uEdsH31JGb7M001L3bWyE.e2giF1QCuT07Mf61Yq9rj4_Q6w_ZOqeHqJtbPKBIGaI"  
```

--------------------------------

### Get Organization Usage Example Response

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Example JSON response for retrieving organization usage data. It includes counts for various payment types and associated accounts.

```json
{
  "data": {
    "attributes": {
      "accountCount": 0,
      "totalAccounts": 0,
      "bulkPaymentBundleCount": 0,
      "bulkPaymentCount": 0,
      "paymentAccountCount": 0,
      "paymentCount": 0
    },
    "id": "2020-07",
    "type": "usage",
    "relationships": {
      "organization": {
        "data": {
          "id": "3953d4ab-7ec4-4c0b-8b91-4be8626c0946",
          "type": "organization"
        }
      }
    }
  }
}
```

--------------------------------

### List Integration Accounts Request Example (cURL)

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Demonstrates how to list integration accounts using a cURL command. It includes essential headers like Accept, Content-Type, and Authorization, along with query parameters for pagination.

```bash
curl -g  -s -X GET https://api.ibanity.com/ponto-connect/integration-accounts?page[limit]=1 \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/vnd.api+json" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer KEwMRAz-1tdJpb_O63HkLpeETmvduLtJ8nh8UGalaMs.vA0IB0bqYccPqGgQKws3NMV6h4YLL7ZblzW7EVCjnyI"  
```

--------------------------------

### List Integration Accounts Request Example (cURL)

Source: https://documentation.ibanity.com/ponto-connect/api

Demonstrates how to list integration accounts using a cURL command. It includes essential headers like Accept, Content-Type, and Authorization, along with query parameters for pagination and filtering.

```bash
curl -g  -s -X GET https://api.ibanity.com/ponto-connect/integration-accounts?page[limit]=1 \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/vnd.api+json" \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer KEwMRAz-1tdJpb_O63HkLpeETmvduLtJ8nh8UGalaMs.vA0IB0bqYccPqGgQKws3NMV6h4YLL7ZblzW7EVCjnyI"
```

--------------------------------

### Example Request: Get Financial Institution Transaction (cURL)

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Example cURL command to retrieve a specific financial institution transaction. Includes necessary headers like Accept and Authorization, and uses client certificate authentication.

```curl
curl -g  -s -X GET https://api.ibanity.com/ponto-connect/sandbox/financial-institutions/41ed5259-9e07-43a7-b8c2-3854adef2067/financial-institution-accounts/8e49fac4-7eb1-41d2-8c8c-30adc94c56fb/financial-institution-transactions/2468a217-d68d-4a57-8a94-5803ef5eb35e \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/json" \
-H "Authorization: Bearer i4DYE9kHWirKIBeEQQQI85uEdsH31JGb7M001L3bWyE.e2giF1QCuT07Mf61Yq9rj4_Q6w_ZOqeHqJtbPKBIGaI"
```

--------------------------------

### POST /onboarding/details

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Creates a new onboarding details resource. This endpoint is used to initiate the onboarding process by providing necessary user and organization information.

```APIDOC
## POST /onboarding/details

### Description
Initiates the onboarding process by creating an onboarding details resource with the provided user and organization information. This is the first step in guiding a user through the Ponto onboarding flow.

### Method
`POST`

### Endpoint
`/onboarding/details`

### Headers
- **Accept** (string) - Required - Format of the response you expect from the call. If present, it should always be `"application/vnd.api+json"`
- **Content-Type** (string) - Required - Format of payload being sent with the request. Should always be `"application/vnd.api+json"`
- **Authorization** (string) - Required - Client access token, provided in the form `Authorization: Bearer {accessToken}`

### Request Body
#### Attributes
- **email** (string) - Required - Email belonging to the onboarding user
- **firstName** (string, optional) - First name of the onboarding user
- **lastName** (string, optional) - Last name of the onboarding user
- **organizationName** (string, optional) - Name of the onboarding user's organization
- **enterpriseNumber** (string, optional) - Enterprise number corresponding to the onboarding user's organization
- **vatNumber** (string, optional) - VAT number corresponding to the onboarding user's organization
- **addressStreetAddress** (string, optional) - Street address of the onboarding user's organization
- **addressCountry** (string, optional) - Country of the onboarding user's organization
- **addressPostalCode** (string, optional) - Postal code of the onboarding user's organization
- **addressCity** (string, optional) - City of the onboarding user's organization
- **phoneNumber** (string, optional) - Phone number of the onboarding user
- **initialFinancialInstitutionId** (string, format: uuid, optional) - Unique identifier of the financial institution that should be preselected during the Ponto onboarding process

### Request Example
```json
{
  "email": "jsmith@example.com",
  "firstName": "Jo",
  "lastName": "Smith",
  "organizationName": "Smith Ltd",
  "enterpriseNumber": "0999999999",
  "vatNumber": "BE0999999999",
  "addressStreetAddress": "123 Main St",
  "addressCountry": "BE",
  "addressPostalCode": "1000",
  "addressCity": "Brussels",
  "phoneNumber": "+32484000000",
  "initialFinancialInstitutionId": "69f8d721-0c12-4a12-8496-943e2dc5a927"
}
```

### Response
#### Success Response (201 Created)
- **id** (string, uuid) - Unique identifier for the created onboarding details resource.
- **type** (string) - Resource type, always `onboardingDetails`.
- **attributes** (object) - Contains the attributes of the onboarding details, as provided in the request and potentially augmented by the system.

#### Response Example
```json
{
  "id": "f56b519d-14d6-4ce9-adbf-2fce805318c6",
  "type": "onboardingDetails",
  "attributes": {
    "addressCity": "Brussels",
    "addressCountry": "BE",
    "addressPostalCode": "1000",
    "addressStreetAddress": "123 Main St",
    "enterpriseNumber": "0999999999",
    "organizationType": "business",
    "vatNumber": "BE0999999999",
    "phoneNumber": "+32484000000",
    "email": "jsmith@example.com",
    "firstName": "Jo",
    "lastName": "Smith",
    "partnerReference": "partner-reference",
    "automaticSubmissionOnCompletedForms": true,
    "initialFinancialInstitutionId": "69f8d721-0c12-4a12-8496-943e2dc5a927",
    "organizationName": "Smith Ltd",
    "preferredOtpMethod": null,
    "requestedOrganisationId": "69f8d721-0c12-4a12-8496-943e2dc5a927",
    "skipFinancialInstitutionSelection": false
  }
}
```
```

--------------------------------

### POST /ponto-connect/onboarding-details

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Initiates the Ponto onboarding process by providing necessary details for an organization. This endpoint allows partners to pre-fill information and guide the user through the onboarding flow.

```APIDOC
## POST /ponto-connect/onboarding-details

### Description
Initiates the Ponto onboarding process by providing necessary details for an organization. This endpoint allows partners to pre-fill information and guide the user through the onboarding flow.

### Method
POST

### Endpoint
https://api.ibanity.com/ponto-connect/onboarding-details

### Parameters
#### Request Body
- **data** (object) - Required - The main data object for the request.
  - **type** (string) - Required - Must be "onboardingDetails".
  - **attributes** (object) - Required - Contains the details for onboarding.
    - **email** (string) - Required - The email address of the user.
    - **firstName** (string) - Required - The first name of the user.
    - **lastName** (string) - Required - The last name of the user.
    - **organizationName** (string) - Required - The name of the organization.
    - **enterpriseNumber** (string) - Optional - The enterprise number of the organization.
    - **vatNumber** (string) - Optional - The VAT number of the organization.
    - **addressStreetAddress** (string) - Optional - The street address of the organization.
    - **addressCountry** (string) - Optional - The country of the organization (e.g., 'BE').
    - **addressPostalCode** (string) - Optional - The postal code of the organization.
    - **addressCity** (string) - Optional - The city of the organization.
    - **phoneNumber** (string) - Optional - The phone number of the organization.
    - **initialFinancialInstitutionId** (string) - Optional - The ID of the initial financial institution to select.
    - **partnerReference** (string) - Optional - Unique identifier for the partner's record.
    - **automaticSubmissionOnCompletedForms** (boolean) - Optional - Automatically submit the form when completed. Defaults to `false`.
    - **requestedOrganisationId** (string) - Optional - The ID of the organization to preselect during onboarding.
    - **organizationType** (string) - Optional - The type of the user's organization ('business' or 'personal').
    - **skipFinancialInstitutionSelection** (boolean) - Optional - Skip the financial institution selection step. Defaults to `false`.

### Request Example
```json
{
  "data": {
    "type": "onboardingDetails",
    "attributes": {
      "email": "jsmith@example.com",
      "firstName": "Jo",
      "lastName": "Smith",
      "organizationName": "Smith Ltd",
      "enterpriseNumber": "0999999999",
      "vatNumber": "BE0999999999",
      "addressStreetAddress": "123 Main St",
      "addressCountry": "BE",
      "addressPostalCode": "1000",
      "addressCity": "Brussels",
      "phoneNumber": "+32484000000",
      "initialFinancialInstitutionId": "69f8d721-0c12-4a12-8496-943e2dc5a927",
      "partnerReference": "partner-reference",
      "automaticSubmissionOnCompletedForms": true,
      "requestedOrganisationId": "69f8d721-0c12-4a12-8496-943e2dc5a927",
      "organizationType": "business",
      "skipFinancialInstitutionSelection": false
    }
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - The created onboarding details resource.
  - **id** (string) - The unique identifier of the onboarding details resource.
  - **type** (string) - The type of the resource, "onboardingDetails".
  - **attributes** (object) - Contains the details of the onboarding.
    - **addressCity** (string) - The city of the organization.
    - **addressCountry** (string) - The country of the organization.
    - **addressPostalCode** (string) - The postal code of the organization.
    - **addressStreetAddress** (string) - The street address of the organization.
    - **enterpriseNumber** (string) - The enterprise number of the organization.
    - **organizationType** (string) - The type of the organization.
    - **vatNumber** (string) - The VAT number of the organization.
    - **phoneNumber** (string) - The phone number of the organization.
    - **email** (string) - The email address of the user.
    - **firstName** (string) - The first name of the user.
    - **lastName** (string) - The last name of the user.
    - **partnerReference** (string) - Unique identifier for the partner's record.
    - **automaticSubmissionOnCompletedForms** (boolean) - Indicates if the form should be automatically submitted when all fields are completed.
    - **initialFinancialInstitutionId** (string) - The ID of the initial financial institution selected.
    - **organizationName** (string) - The name of the organization.
    - **preferredOtpMethod** (string or null) - The preferred OTP method.
    - **requestedOrganisationId** (string) - The ID of the organization that was preselected.
    - **skipFinancialInstitutionSelection** (boolean) - Indicates if the financial institution selection step was skipped.

#### Response Example
```json
{
  "data": {
    "attributes": {
      "addressCity": "Brussels",
      "addressCountry": "BE",
      "addressPostalCode": "1000",
      "addressStreetAddress": "123 Main St",
      "enterpriseNumber": "0999999999",
      "organizationType": "business",
      "vatNumber": "BE0999999999",
      "phoneNumber": "+32484000000",
      "email": "jsmith@example.com",
      "firstName": "Jo",
      "lastName": "Smith",
      "partnerReference": "partner-reference",
      "automaticSubmissionOnCompletedForms": true,
      "initialFinancialInstitutionId": "69f8d721-0c12-4a12-8496-943e2dc5a927",
      "organizationName": "Smith Ltd",
      "preferredOtpMethod": null,
      "requestedOrganisationId": "69f8d721-0c12-4a12-8496-943e2dc5a927",
      "skipFinancialInstitutionSelection": false
    },
    "id": "f56b519d-14d6-4ce9-adbf-2fce805318c6",
    "type": "onboardingDetails"
  }
}
```
```

--------------------------------

### Payment Initiation API

Source: https://documentation.ibanity.com/ponto-connect/2/products

This section details the process of creating single or bulk payments. It covers options for handling customer signatures with or without redirection URIs and explains how to monitor payment statuses.

```APIDOC
## POST /payments

### Description
Initiates a single or bulk payment. This endpoint can be used with or without a redirection URI. If a `redirectUri` is provided, the user will be redirected to Ponto's authorization portal to sign the payment. The payment status can be monitored using the returned payment object identifier.

### Method
POST

### Endpoint
/payments

### Parameters
#### Query Parameters
- **redirectUri** (string) - Optional - The URI to redirect the user to after the payment is signed in Ponto.

#### Request Body
- **paymentDetails** (object) - Required - Contains the details of the payment to be initiated.
  - **type** (string) - Required - Type of payment (e.g., 'single', 'bulk').
  - **creditorAccount** (object) - Required - Details of the creditor account.
  - **debitedAccount** (object) - Required - Details of the debited account.
  - **instructedAmount** (object) - Required - The amount and currency of the payment.
  - **remittanceInformation** (string) - Optional - Information about the payment.

### Request Example
```json
{
  "paymentDetails": {
    "type": "single",
    "creditorAccount": {
      "iban": "NL91ABNA0411244041",
      "currency": "EUR"
    },
    "debitedAccount": {
      "iban": "NL91ABNA0411244042",
      "currency": "EUR"
    },
    "instructedAmount": {
      "amount": "100.00",
      "currency": "EUR"
    },
    "remittanceInformation": "Payment for invoice #12345"
  }
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier for the initiated payment.
- **status** (string) - The initial status of the payment (e.g., 'unsigned').
- **redirectLink** (string) - The link to Ponto's authorization portal if `redirectUri` was provided.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "unsigned",
  "redirectLink": "https://ponto.example.com/authorize?paymentId=a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

## GET /payments/{paymentId}/status

### Description
Polls Ponto Connect to monitor the status of a previously initiated single or bulk payment using its identifier.

### Method
GET

### Endpoint
/payments/{paymentId}/status

### Parameters
#### Path Parameters
- **paymentId** (string) - Required - The unique identifier of the payment to check the status for.

### Response
#### Success Response (200 OK)
- **status** (string) - The current status of the payment (e.g., 'unsigned', 'accepted-settlement-completed', 'rejected').

#### Response Example
```json
{
  "status": "accepted-settlement-completed"
}
```
```

--------------------------------

### Get Transaction Response (Ponto Connect API)

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Example response for retrieving a specific transaction resource. It includes the transaction's attributes, ID, type, and relationships to its associated account. This structure is returned upon a successful GET request for a transaction.

```json
{
  "data": {
    "attributes": {
      "description": "Big Cotton JACKET",
      "currency": "EUR",
      "digest": "fa026f630b82f305a66d170245be6069dd8c846ee610a7b842ca3ef81d3c6165",
      "mandateId": "234",
      "amount": -85,
      "createdAt": "2025-04-22T13:32:21.513Z",
      "remittanceInformation": "BIGGER NEW JACKET",
      "remittanceInformationType": "unstructured",
      "endToEndId": "76061f262404431bac46c344482f0fea",
      "updatedAt": "2025-04-22T13:32:43.158Z",
      "fee": null,
      "additionalInformation": "Online payment on bestmarket.com",
      "bankTransactionCode": "PMNT-IRCT-ESCT",
      "cardReference": null,
      "cardReferenceType": null,
      "counterpartName": null,
      "counterpartReference": "BE36732915527881",
      "creditorId": "123498765421",
      "executionDate": "2025-04-19T13:32:00.000Z",
      "proprietaryBankTransactionCode": "12345",
      "purposeCode": "CASH",
      "valueDate": "2025-04-19T13:32:00.000Z",
      "internalReference": "d8415e8d-87a8-4b34-80e1-0c4fbf687e36"
    },
    "id": "0365739f-9238-40ba-839b-f39f1f11890a",
    "type": "transaction",
    "relationships": {
      "account": {
        "data": {
          "id": "5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b",
          "type": "account"
        },
        "links": {
          "related": "https://api.ibanity.com/ponto-connect/accounts/5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b"
        }
      }
    }
  }
}
```

--------------------------------

### Get User Info - cURL Example

Source: https://documentation.ibanity.com/ponto-connect/api/curl

Retrieves user information associated with an access token. Requires 'Accept' and 'Authorization' headers. The response contains organization details and scope attributes.

```curl
curl -g  -s -X GET https://api.ibanity.com/ponto-connect/userinfo \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/vnd.api+json" \
-H "Authorization: Bearer i4DYE9kHWirKIBeEQQQI85uEdsH31JGb7M001L3bWyE.e2giF1QCuT07Mf61Yq9rj4_Q6w_ZOqeHqJtbPKBIGaI"
```

--------------------------------

### Create Ponto Connect Onboarding Details (POST)

Source: https://documentation.ibanity.com/ponto-connect/api/curl

This snippet demonstrates how to create onboarding details for the Ponto Connect service using a cURL request. It includes the endpoint, required headers, and an example JSON payload. The request requires authentication via a certificate and private key, and an Authorization header.

```bash
curl -g  -s -X POST https://api.ibanity.com/ponto-connect/onboarding-details \
--cert certificate.pem:azertyuiop \
--key private_key.pem  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer to4xvDQgkG2kRP8xd2w8IV6pK3Gn-HuHdVzdXsO0HHM.Qw0eTznR9KIwFXtlH-_RVndcdAz15mo-siJmfqd3fUQ"  \
-d "@payload.json"
```

--------------------------------

### Create Onboarding Details

Source: https://documentation.ibanity.com/ponto-connect/2/api/go-live

Initiates the onboarding process by creating a new onboarding details resource.

```APIDOC
## POST /onboardingDetails

### Description
Creates a new onboarding details resource to initiate the Ponto onboarding process.

### Method
POST

### Endpoint
/onboardingDetails

### Parameters
#### Headers
- **Accept** (string) - Required - Format of the response you expect from the call. If present, it should always be `"application/vnd.api+json"`.
- **Content-Type** (string) - Required - Format of payload being sent with the request. Should always be `"application/vnd.api+json"`.
- **Authorization** (string) - Required - Client access token, provided in the form `Authorization: Bearer {accessToken}`.

#### Request Body
- **data** (object) - Required - The onboarding details object.
  - **type** (string) - Required - Resource type. Always `onboardingDetails` for this type of object.
  - **attributes** (object) - Required - Contains the details for the onboarding process.
    - **email** (string) - Required - Email belonging to the onboarding user.
    - **firstName** (string, optional) - First name of the onboarding user.
    - **lastName** (string, optional) - Last name of the onboarding user.
    - **organizationName** (string, optional) - Name of the onboarding user's organization.
    - **enterpriseNumber** (string, optional) - Enterprise number corresponding to the onboarding user's organization.
    - **vatNumber** (string, optional) - VAT number corresponding to the onboarding user's organization.
    - **addressStreetAddress** (string, optional) - Street address of the onboarding user's organization.
    - **addressCountry** (string, optional) - Country of the onboarding user's organization.
    - **addressPostalCode** (string, optional) - Postal code of the onboarding user's organization.
    - **addressCity** (string, optional) - City of the onboarding user's organization.
    - **phoneNumber** (string, optional) - Phone number of the onboarding user.
    - **initialFinancialInstitutionId** (string, format: uuid, optional) - Unique identifier of the financial institution that should be preselected during the Ponto onboarding process.

### Request Example
```json
{
  "data": {
    "type": "onboardingDetails",
    "attributes": {
      "email": "jsmith@example.com",
      "firstName": "Jo",
      "lastName": "Smith",
      "organizationName": "Smith Ltd",
      "enterpriseNumber": "0999999999",
      "vatNumber": "BE0999999999",
      "addressStreetAddress": "123 Main St",
      "addressCountry": "BE",
      "addressPostalCode": "1000",
      "addressCity": "Brussels",
      "phoneNumber": "+32484000000",
      "initialFinancialInstitutionId": "69f8d721-0c12-4a12-8496-943e2dc5a927"
    }
  }
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the newly created onboarding details resource.
- **type** (string) - The resource type, always `onboardingDetails`.
- **attributes** (object) - Contains the details of the onboarding process.
  - **email** (string) - Email belonging to the onboarding user.
  - **firstName** (string, optional) - First name of the onboarding user.
  - **lastName** (string, optional) - Last name of the onboarding user.
  - **organizationName** (string, optional) - Name of the onboarding user's organization.
  - **enterpriseNumber** (string, optional) - Enterprise number corresponding to the onboarding user's organization.
  - **vatNumber** (string, optional) - VAT number corresponding to the onboarding user's organization.
  - **addressStreetAddress** (string, optional) - Street address of the onboarding user's organization.
  - **addressCountry** (string, optional) - Country of the onboarding user's organization.
  - **addressPostalCode** (string, optional) - Postal code of the onboarding user's organization.
  - **addressCity** (string, optional) - City of the onboarding user's organization.
  - **phoneNumber** (string, optional) - Phone number of the onboarding user.
  - **initialFinancialInstitutionId** (string, format: uuid, optional) - Unique identifier of the financial institution that should be preselected during the Ponto onboarding process.

#### Response Example
```json
{
  "attributes": {
    "email": "jsmith@example.com",
    "firstName": "Jo",
    "lastName": "Smith",
    "organizationName": "Smith Ltd",
    "enterpriseNumber": "0999999999",
    "vatNumber": "BE0999999999",
    "addressStreetAddress": "123 Main St",
    "addressCountry": "BE",
    "addressPostalCode": "1000",
    "addressCity": "Brussels",
    "phoneNumber": "+32484000000",
    "initialFinancialInstitutionId": "69f8d721-0c12-4a12-8496-943e2dc5a927"
  },
  "id": "f56b519d-14d6-4ce9-adbf-2fce805318c6",
  "type": "onboardingDetails"
}
```
```

--------------------------------

### Create Bulk Payment

Source: https://documentation.ibanity.com/ponto-connect/2/api/go-live

Initiates a bulk payment by creating a new bulk payment object. This starts the authorization flow for the user. A redirect URI can be provided to guide the user through the authorization process.

```APIDOC
## POST /bulk-payments

### Description
Initiates a bulk payment by creating a new bulk payment object. This starts the authorization flow for the user. A redirect URI can be provided to guide the user through the authorization process.

### Method
POST

### Endpoint
/bulk-payments

### Parameters
#### Headers
- **Accept** (string) - Required - Format of the response you expect from the call. If present, it should always be `"application/vnd.api+json"`
- **Content-Type** (string) - Required - Format of payload being sent with the request. Should always be `"application/vnd.api+json"`
- **Authorization** (string) - Required - Access token corresponding to the relevant customer, provided in the form `Authorization: Bearer {accessToken}`

#### Request Body
- **data** (object) - Required - The data object containing the bulk payment details.
  - **attributes** (object) - Required - Attributes of the bulk payment.
    - **reference** (string) - Required - Your identifier for the bulk payment, displayed to the user in the Ponto dashboard.
    - **redirectUri** (string) - Optional - URI that your user will be redirected to at the end of the authorization flow.
    - **requestedExecutionDate** (string) - Optional (format: date) - A date in the future when the payment is requested to be executed. The availability of this feature depends on each financial institution.
    - **batchBookingPreferred** (boolean) - Optional - Indicates whether the bulk payment transactions should be grouped into one booking entry by the financial institution instead of individual transactions. Defaults to `false`.
  - **type** (string) - Required - Resource type. Always `bulkPayment` for this type of object.

### Request Example
```json
{
  "data": {
    "attributes": {
      "reference": "Invoice Payments",
      "redirectUri": "https://example.com/callback",
      "requestedExecutionDate": "2025-05-05",
      "batchBookingPreferred": true
    },
    "type": "bulkPayment"
  }
}
```

### Response
#### Success Response (201 Created)
- **data** (object) - The created bulk payment object.
  - **attributes** (object) - Attributes of the bulk payment.
    - **status** (string) - Current status of the bulk payment.
    - **reference** (string) - Your identifier for the bulk payment.
    - **requestedExecutionDate** (string) - Date of requested execution.
    - **batchBookingPreferred** (boolean) - Indicates batch booking preference.
  - **id** (string) - Unique identifier for the bulk payment (format: uuid).
  - **links** (object) - Current resource links.
    - **redirect** (string) - URI to redirect to for authorization flow.
  - **type** (string) - Resource type. Always `bulkPayment`.

#### Response Example
```json
{
  "data": {
    "attributes": {
      "status": "unsigned",
      "reference": "Invoice Payments",
      "requestedExecutionDate": "2025-05-05",
      "batchBookingPreferred": true
    },
    "id": "b4bc4ed0-810a-440d-8a2d-22b5ab26d15c",
    "links": {
      "redirect": "https://authorize.acceptance.myponto.net/organizations/3953d4ab-7ec4-4c0b-8b91-4be8626c0946/sandbox/integrations/e1848b9c-9c72-431e-b0c0-410b0e579166/accounts/5a8820b5-87c5-4d8d-b0f1-32e710b0bd9b/bulk-payments/b4bc4ed0-810a-440d-8a2d-22b5ab26d15c"
    },
    "type": "bulkPayment"
  }
}
```
```
Tokens:
Raw