Bancontact Payout List API

openapi: 3.2.0
info:
  version: 3.0.1
  title: Merchant Reconciliation Payout List 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: payoutList
paths:
  /v3/reconciliation/payouts:
    get:
      summary: Get a list of all payouts for the merchant
      description: 'This API is used to indicate if there are payouts available after a payout run.

        If there are no payouts for any reason, API will indicate it in the response by returning an empty list..'
      operationId: getPayoutList
      tags:
      - payoutList
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/date'
      security:
      - JWS-Request-Signature: []
      responses:
        '200':
          description: Payouts List Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutListResponse'
          headers:
            Signature:
              $ref: '#/components/headers/Signature'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401UnauthorizedReconciliation'
        '403':
          $ref: '#/components/responses/403ForbiddenReconciliation'
        '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
  schemas:
    PayoutListResponse:
      description: contains a paginated list of payouts associated with a merchant
      allOf:
      - $ref: '#/components/schemas/AbstractListResponse'
      - type: object
        required:
        - payouts
        properties:
          payouts:
            type: array
            description: a list of payouts. If the list is empty, then there were no payouts made.
            items:
              $ref: '#/components/schemas/PayoutListItem'
    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
    PayoutStatus:
      type: string
      enum:
      - SUCCEEDED
      - FAILED
      description: '* _SUCCEEDED_ - Payout was successfully processed

        * _FAILED_ - Payout failed.'
    Currency:
      type: string
      enum:
      - EUR
      default: EUR
      description: currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)
    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
    PayoutListItem:
      type: object
      description: 'an individual object returned in the List response that contains the details of a payout

        associated to a merchant'
      required:
      - payoutId
      - merchantId
      - bulkId
      - iban
      - payoutStatus
      - payoutDate
      - payoutCurrency
      - totalPayments
      - totalRefunds
      - totalPaymentAmount
      - totalRefundAmount
      - payoutAmount
      properties:
        payoutId:
          type: string
          description: The unique identifier associated with the payout if a pay-out was successfully created
          minLength: 24
          maxLength: 24
        merchantId:
          type: string
          description: The merchant id used during aggregation of the payout run
          minLength: 24
          maxLength: 24
        bulkId:
          type: string
          description: 'The bulk id used during aggregation of the of the payout run if available,

            if not `NONE` would be sent as default'
          minLength: 1
        iban:
          type: string
          description: 'The IBAN in (ISO 13616) format used during aggregation of the payout run and

            this will be used to payout to the merchant'
          pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
          examples:
          - BE68539007547034
          minLength: 1
        payoutStatus:
          $ref: '#/components/schemas/PayoutStatus'
        payoutDate:
          type: string
          format: date-time
          description: timestamp, when payout was created in UTC
        payoutCurrency:
          $ref: '#/components/schemas/Currency'
        totalPayments:
          type: integer
          description: The total number of payments included in the payout
        totalRefunds:
          type: integer
          description: The total number of refunds included in the payout
        totalPaymentAmount:
          description: The total payment amount in cents contained in the payout.
          type: integer
          format: int64
          minimum: 1
          exclusiveMinimum: 1
        totalRefundAmount:
          description: The total refund amount in cents contained in the payout.
          type: integer
          format: int64
          minimum: 0
          exclusiveMinimum: 0
        payoutAmount:
          type: integer
          description: Total amount in cents paid out the to merchant
          format: int64
          minimum: 1
          exclusiveMinimum: 1
  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
  parameters:
    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
    date:
      name: date
      in: query
      description: The date in yyyy-MM-dd format for which the list of payouts should be returned. If not provided, current date in UTC will be used.
      required: false
      schema:
        type: string
        format: date
        examples:
        - '2020-06-18'
  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."