Bancontact

Bancontact Payout Payments API

The payoutPayments API from Bancontact — 1 operation(s) for payoutpayments.

Documentation GitHub OpenAPI

Operations 1

GET /v3/reconciliation/payments get list of payments #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bancontact-payoutpayments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 3.0.1
  title: Merchant Reconciliation Payout Payments API
  description: 'API allows merchant/integrator to reconcile Payments


    ## History


    ### 3.0.1 (2025-10-01)


    * Removed DEV and ACC environment.

    * Added description for PREPROD and PROD environments

    * Added `/v3` prefixes to operation paths.


    ### (2025-07-24)

    * Remove SubmerchantName and SubmerchantID.'
servers:
- url: https://merchant.api.preprod.bancontact.net
  description: PREPROD merchant API
- url: https://merchant.api.bancontact.net
  description: PROD merchant API
tags:
- name: payoutPayments
paths:
  /v3/reconciliation/payments:
    get:
      summary: get list of payments
      description: Endpoint to get list of payments
      operationId: getPayments
      tags:
      - payoutPayments
      parameters:
      - $ref: '#/components/parameters/PayoutId'
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/startDate'
      - $ref: '#/components/parameters/endDate'
      security:
      - JWS-Request-Signature: []
      responses:
        '200':
          description: returns all the payments for this payout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutPaymentsResponse'
          headers:
            Signature:
              $ref: '#/components/headers/Signature'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401UnauthorizedReconciliation'
        '403':
          $ref: '#/components/responses/403ForbiddenReconciliation'
        '404':
          description: 'Error codes:

            * _PAYOUT_NOT_FOUND_ - payout with the id not found'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Signature:
              $ref: '#/components/headers/Signature'
        '500':
          $ref: '#/components/responses/500InternalServerErrorReconciliation'
        '503':
          $ref: '#/components/responses/503ServiceUnavailable'
components:
  responses:
    403ForbiddenReconciliation:
      description: 'Error codes:

        * _ACCESS_DENIED_ - operation not allowed, caller doesn''t have required authorities'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      headers:
        Signature:
          $ref: '#/components/headers/Signature'
    500InternalServerErrorReconciliation:
      description: 'Error codes:

        * _TECHNICAL_ERROR_ - technical error'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      headers:
        Signature:
          $ref: '#/components/headers/Signature'
    400BadRequest:
      description: 'Error codes:

        * _BAD_REQUEST_ - some field in the request was not formatted correctly'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      headers:
        Signature:
          $ref: '#/components/headers/Signature'
    401UnauthorizedReconciliation:
      description: 'If JWS signature is not valid. Error codes:

        * _UNAUTHORIZED_ - caller doesn''t have valid authentication credentials'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      headers:
        Signature:
          $ref: '#/components/headers/Signature'
    503ServiceUnavailable:
      description: Service is unavailable
  parameters:
    endDate:
      name: end-date
      in: query
      description: The end date (inclusive) in yyyy-MM-dd format for which the list of payments/refunds should be returned. The maximum difference between the start date and end date can be 30 days. When the end date is filled the start date needs to be filled as well.
      schema:
        type: string
        format: date
        examples:
        - '2020-06-18'
      required: false
    PayoutId:
      in: query
      name: payout-id
      description: Payout Id
      schema:
        type: string
        minLength: 24
        maxLength: 24
      required: false
    size:
      name: size
      in: query
      description: the size of the page to be returned in list requests.
      schema:
        type: integer
        minimum: 10000
        maximum: 10000
        default: 10000
      required: false
    page:
      name: page
      in: query
      description: zero-based page index in list requests.
      schema:
        type: integer
        minimum: 0
        default: 0
      required: false
    startDate:
      name: start-date
      in: query
      description: The start date (inclusive) in yyyy-MM-dd format for which the list of payments/refunds should be returned. The maximum difference between the start date and end date can be 30 days When the start date is filled the end date needs to be filled as well.
      schema:
        type: string
        format: date
        examples:
        - '2020-06-18'
      required: false
  headers:
    Signature:
      description: "[Detached JWS signature of response payload](https://tools.ietf.org/html/rfc7797).\nBancontact Payconiq Company hosts the Public Key in [JWK format](https://tools.ietf.org/html/rfc7517) as [JWKS](https://tools.ietf.org/html/rfc7517#section-3) at:\n- https://jwks.bancontact.net/\n- https://jwks.preprod.bancontact.net/\nfor PROD and PREPROD environments respectively.\nMerchants should use the Public key downloaded from this url identified by kid claim in JOSE header.\nBancontact Payconiq Company will use the same algorithm to sign the response as the one used for request signature\nThe signature must be computed as per following instructions:\n\n    jws = base64URLEncode(JOSE Header)..alg(base64URLEncode(JOSE Header).base64URLEncode(Response Body))\n\n    [JOSE Header](https://tools.ietf.org/html/rfc7515#section-4) =\n\n    {\n      \"typ\": \"jose+json\",\n      \"kid\": \"JWK kid\",\n      \"alg\": \"[ES256(ECDSA using P-256 and SHA-256. Minimum keysize 256 bit)](https://tools.ietf.org/html/rfc7518#section-3.1)\",\n      \"https://payconiq.com/sub\" : \"{merchantProfileId}\",\n      \"https://payconiq.com/iss\" : \"Payconiq\",\n      \"https://payconiq.com/iat\" : \"{Current creation date time in [ISODateTime format](https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/datatypes/_YW1tKtp-Ed-ak6NoX_4Aeg_-1624336183), expressed in UTC time format(YYYY-MM-DDThh:mm:ss.sssZ)},\n      \"https://payconiq.com/jti\" : \"{X-Request-ID}\",\n      \"https://payconiq.com/path\": \"request path eg. /bag/v1/payments/{payment-id}/authorization/{authorization-id}/confirm\"\n      \"crit\": [\"https://payconiq.com/sub\", \"https://payconiq.com/iss\", \"https://payconiq.com/iat\", \"https://payconiq.com/jti\", \"https://payconiq.com/path\"]\n    }\n\nJWS Payload MUST be same as the response body as base64url encoded JSON data."
      schema:
        type: string
  schemas:
    PayoutPaymentsResponse:
      description: list of payments associated with a payout
      allOf:
      - $ref: '#/components/schemas/AbstractListResponse'
      - type: object
        required:
        - payments
        properties:
          payments:
            type: array
            description: a list of payments included in the payout.
            items:
              $ref: '#/components/schemas/PaymentDetails'
    PaymentDetails:
      description: Details of a payment
      allOf:
      - $ref: '#/components/schemas/TransactionDetails'
    AbstractListResponse:
      type: object
      description: Base paginated list response
      required:
      - size
      - totalPages
      - totalElements
      - number
      properties:
        size:
          type: integer
          description: the total number of elements in the current page of this response
          minimum: 0
        totalPages:
          type: integer
          description: the total number of pages in the response
        totalElements:
          type: integer
          description: the total number of elements in the response
        number:
          type: integer
          description: the current page number
    PaymentChannel:
      type: string
      enum:
      - ONLINE
      - INSTORE
      - INVOICE
      description: '"The  channel of the payment"'
    ErrorResponse:
      type: object
      title: Error response
      description: The standard response model returned in case of an error
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Error message
      required:
      - code
      - message
    TransactionDetails:
      type: object
      description: The details of a transaction
      required:
      - paymentId
      - paymentProfileId
      - merchantName
      - paymentChannel
      - currency
      - amount
      - transactionDate
      properties:
        paymentId:
          type: string
          description: The id of the payment
          minLength: 24
          maxLength: 24
        payoutId:
          type: string
          description: The id of the payout
          minLength: 24
          maxLength: 24
        paymentProfileId:
          type: string
          description: The profile id of the merchant used in the transaction
          minLength: 24
          maxLength: 24
        merchantName:
          type: string
          description: The name of the merchant
          minLength: 1
        paymentChannel:
          $ref: '#/components/schemas/PaymentChannel'
        currency:
          $ref: '#/components/schemas/Currency'
        amount:
          type: integer
          description: Total amount in cents of the transaction
          format: int64
          minimum: 1
        reference:
          description: The reference provided by the merchant/partner during a payment/refund
          type: string
          minLength: 1
        description:
          description: The description provided by the merchant/partner during a payment/refund
          type: string
          minLength: 1
        transactionDate:
          type: string
          format: date-time
          description: timestamp, when transaction was created in UTC
    Currency:
      type: string
      enum:
      - EUR
      default: EUR
      description: currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)
  securitySchemes:
    JWS-Request-Signature:
      name: Signature
      type: apiKey
      in: header
      description: "[Detached JWS signature of request payload](https://tools.ietf.org/html/rfc7797).\n\nMerchant/Partner MUST host the public key in [JWK format](https://tools.ietf.org/html/rfc7517) as [JWKS](https://tools.ietf.org/html/rfc7517#section-3)\nand share the URL with Bancontact Payconiq Company during integration.\n\nThe signature must be computed as per following instructions:\n\n    jws = base64URLEncode(JOSE Header)..alg(base64URLEncode(JOSE Header).base64URLEncode(Request Body))\n\n    [JOSE Header](https://tools.ietf.org/html/rfc7515#section-4) =\n\n    {\n      \"typ\": \"jose+json\",\n      \"kid\": \"JWK kid\",\n      \"alg\": \"ES256\",\n      \"https://payconiq.com/sub\" : \"{merchantProfileId}\",\n      \"https://payconiq.com/iss\" : \"{Merchant Id}\",\n      \"https://payconiq.com/iat\" : \"{Current creation date time in [ISODateTime format](https://www.iso20022.org/standardsrepository/public/wqt/Description/mx/dico/datatypes/_YW1tKtp-Ed-ak6NoX_4Aeg_-1624336183), expressed in UTC time format(YYYY-MM-DDThh:mm:ss.sssZ)},\n      \"https://payconiq.com/jti\" : \"{Unique-request-identifier}\",\n      \"https://payconiq.com/path\": \"request path ex. /v3/payments/{payment-id}/confirm\"\n      \"crit\": [\"https://payconiq.com/sub\", \"https://payconiq.com/iss\", \"https://payconiq.com/iat\", \"https://payconiq.com/jti\", \"https://payconiq.com/path\"]\n    }\n\nJWS Payload MUST be the same as request body as base64url encoded JSON data."