openapi: 3.1.0
info:
  title: 'Easytransac API V2'
  version: 2.0.0
servers:
  -
    url: 'https://api.sandbox.easytransac.com/v2'
    description: Sandbox
  -
    url: 'https://api.easytransac.com/v2'
    description: Production
paths:
  /auth:
    post:
      tags:
        - authentication
      summary: 'JWT access token - Generate'
      description: 'Generates a temporary JWT access token with your `apiKey` to be able to authenticate to the Easytransac API V2.'
      operationId: v2_endpoint_auth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - apiKey
              properties:
                apiKey:
                  description: 'Your API key'
                  type: string
                  format: password
                  maxLength: 64
                  minLength: 64
                  pattern: '^et_(live|test)_[a-z0-9]{11}-[a-z0-9]{8}-[a-z0-9]{8}-[a-z0-9]{8}-[a-z0-9]{8}-[a-z0-9]{8}$'
              type: object
            examples:
              _mandatory:
                summary: _mandatory
                value:
                  apiKey: et_test_abcabcabc12-abcabc12-abcabc12-abcabc12-abcabc12-abcabc12
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - success
                  - date
                  - data
                properties:
                  success: { description: 'Whether the action was successful', type: boolean }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  data: { description: 'Additional data', required: [token, expiresIn, expiresDate], properties: { token: { description: 'JWT access token to use for authentication', type: string, minLength: 1 }, expiresIn: { description: 'Expiration time of the JWT access `token` (seconds)', type: integer, minimum: 1 }, expiresDate: { description: 'Expiration date of the JWT access `token` (ATOM)', type: string, format: date-time } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { success: true, date: '2024-12-31T23:59:59+02:00', data: { token: ABCabc123.ABCabc123.ABCabc123, expiresIn: 300, expiresDate: '2024-12-31T23:59:59+02:00' } }
        '400':
          description: 'Bad Request'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 400, title: 'Bad Request', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/auth', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 401, title: Unauthorized, detail: 'Invalid Application', instance: 'https://api.sandbox.easytransac.com/v2/auth', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 3, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '405':
          description: 'Method Not Allowed'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 405, title: 'Method Not Allowed', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/auth', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '500':
          description: 'Internal Server Error'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 500, title: 'Internal Server Error', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/auth', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
  /open-banking/init:
    post:
      tags:
        - open_banking
      summary: 'Open Banking - Initialize'
      description: "Initializes a PayByBank transfer directly from the customer's bank.\n    The payment authorisation is instantaneous but its validation may take several days.\n    The customer is redirected to its bank payment page via the `returnUrl` parameter."
      operationId: v2_endpoint_open_banking_init
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - amount
                - email
                - returnUrl
              properties:
                amount:
                  description: 'Transaction amount (cents)'
                  type: integer
                  minimum: 1
                email:
                  description: "Customer's email address associated with the payment"
                  type: string
                  format: email
                  maxLength: 128
                  minLength: 6
                returnUrl:
                  description: 'URL to redirect the customer once the payment has been made'
                  type: string
                  format: uri
                  maxLength: 255
                  minLength: 12
                clientIp:
                  description: "Customer's IP (v4 or v6)"
                  type: [string, 'null']
                  format: ipv4
                  maxLength: 45
                  minLength: 7
                returnMethod:
                  description: 'HTTP method used for the `returnUrl` parameter'
                  type: [string, 'null']
                  default: POST
                  maxLength: 4
                  minLength: 3
                  enum: [GET, POST]
                orderId:
                  description: 'Your own transaction/order ID'
                  type: [string, 'null']
                  maxLength: 64
                  minLength: 1
                description:
                  description: 'Description of the transaction'
                  type: [string, 'null']
                  maxLength: 2048
                  minLength: 1
                clientId:
                  description: "Customer's Easytransac ID (only available if you have already made a payment for this customer)"
                  type: [string, 'null']
                  maxLength: 7
                  minLength: 7
                  pattern: '^[A-Za-z0-9]{7}$'
                uid:
                  description: 'Your own customer ID'
                  type: [string, 'null']
                  maxLength: 64
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                firstname:
                  description: "Customer's first name"
                  type: [string, 'null']
                  maxLength: 128
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                lastname:
                  description: "Customer's last name"
                  type: [string, 'null']
                  maxLength: 128
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                address:
                  description: "Customer's address"
                  type: [string, 'null']
                  maxLength: 128
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                zipCode:
                  description: "Customer's postal code"
                  type: [string, 'null']
                  maxLength: 16
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                city:
                  description: "Customer's city"
                  type: [string, 'null']
                  maxLength: 64
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                country:
                  description: "Customer's country of residence (ISO 3166-1 Alpha 3)"
                  type: [string, 'null']
                  maxLength: 3
                  minLength: 3
                birthDate:
                  description: "Customer's birth date (ATOM)"
                  type: [string, 'null']
                  format: date
                  maxLength: 10
                  minLength: 10
                nationality:
                  description: "Customer's nationality (ISO 3166-1 Alpha 3)"
                  type: [string, 'null']
                  maxLength: 3
                  minLength: 3
                callingCode:
                  description: "Customer's calling code"
                  type: [string, 'null']
                  maxLength: 3
                  minLength: 1
                  pattern: '^[1-9][0-9]{0,2}$'
                phone:
                  description: "Customer's phone number"
                  type: [string, 'null']
                  maxLength: 15
                  minLength: 4
                  pattern: '^[0-9]{4,15}$'
                payToEmail:
                  description: 'Redirect the collection of this transaction to another Easytransac user account by its email'
                  type: [string, 'null']
                  format: email
                  maxLength: 128
                  minLength: 6
                payToId:
                  description: 'Redirect the collection of this transaction to another Easytransac user account by its ID'
                  type: [integer, 'null']
                  maximum: 99999999999
                  minimum: 1
                userAgent:
                  description: "Customer's browser's user agent"
                  type: [string, 'null']
                  maxLength: 2048
                  minLength: 1
                language:
                  description: 'Preferred language of the payment page (ISO 639)'
                  type: [string, 'null']
                  default: FRE
                  maxLength: 3
                  minLength: 3
                  enum: [DEU, ENG, FRE, ITA, SPA]
              type: object
            examples:
              _mandatory:
                summary: _mandatory
                value:
                  amount: 1000
                  email: abc@abc.com
                  returnUrl: 'https://example.com/'
              optional:
                summary: optional
                value:
                  amount: 1000
                  email: abc@abc.com
                  returnUrl: 'https://example.com/'
                  clientIp: 123.123.123.123
                  returnMethod: POST
                  orderId: ABCabc123
                  description: ABCabc123
                  uid: ABCabc123
                  firstname: ABCabc123
                  lastname: ABCabc123
                  address: ABCabc123
                  zipCode: ABCabc123
                  city: ABCabc123
                  country: FRA
                  birthDate: '2024-12-31'
                  nationality: FRA
                  callingCode: '123'
                  phone: '123123123'
                  userAgent: ABCabc123
                  language: FRE
              all:
                summary: all
                value:
                  amount: 1000
                  email: abc@abc.com
                  returnUrl: 'https://example.com/'
                  clientIp: 123.123.123.123
                  returnMethod: POST
                  orderId: ABCabc123
                  description: ABCabc123
                  clientId: ABCabc1
                  uid: ABCabc123
                  firstname: ABCabc123
                  lastname: ABCabc123
                  address: ABCabc123
                  zipCode: ABCabc123
                  city: ABCabc123
                  country: FRA
                  birthDate: '2024-12-31'
                  nationality: FRA
                  callingCode: '123'
                  phone: '123123123'
                  payToEmail: abc@abc.com
                  payToId: 123
                  userAgent: ABCabc123
                  language: FRE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - success
                  - date
                  - data
                properties:
                  success: { description: 'Whether the action was successful', type: boolean }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time, maxLength: 25, minLength: 25 }
                  data: { description: 'Additional data', required: [tid, status, amount, dateCreated], properties: { tid: { description: 'Transaction ID', type: string, maxLength: 14, minLength: 8, pattern: '^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}|[a-z0-9]{8}$' }, status: { description: 'Transaction status', type: string, maxLength: 10, minLength: 6, enum: [authorized, captured, failed, pending, refunded] }, amount: { description: 'Transaction amount (cents)', type: integer, minimum: 1 }, dateCreated: { description: 'Date of creation of the resource (ATOM)', type: string, format: date-time }, orderId: { description: 'Your own transaction/order ID', type: [string, 'null'], maxLength: 64, minLength: 1 }, redirectUrl: { description: 'URL to redirect the customer to its bank payment page', type: [string, 'null'], maxLength: 255, minLength: 12 } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { success: true, date: '2024-12-31T23:59:59+02:00', data: { tid: ABC1-ABC1-ABC1, status: captured, amount: 1000, dateCreated: '2024-12-31T23:59:59+02:00', orderId: ABCabc123, redirectUrl: 'https://api.sandbox.easytransac.com/v2/public/transaction/ABC1-ABC1-ABC1/redirect' } }
          links:
            /transaction/status:
              operationId: v2_endpoint_transaction_status
              parameters:
                tid: '$response.body#/data.tid'
        '400':
          description: 'Bad Request'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 400, title: 'Bad Request', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/open-banking/init', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 401, title: Unauthorized, detail: 'You have no access to this action | JWT Token not found', instance: 'https://api.sandbox.easytransac.com/v2/open-banking/init', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 403, title: Forbidden, detail: 'You have no access to this action', instance: 'https://api.sandbox.easytransac.com/v2/open-banking/init', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '404':
          description: 'Not Found'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 404, title: 'Not Found', detail: 'Client not found', instance: 'https://api.sandbox.easytransac.com/v2/transaction/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 207, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '405':
          description: 'Method Not Allowed'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 405, title: 'Method Not Allowed', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/open-banking/init', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '500':
          description: 'Internal Server Error'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 500, title: 'Internal Server Error', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/open-banking/init', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '502':
          description: 'Bad Gateway'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 502, title: 'Bad Gateway', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/open-banking/init', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '504':
          description: 'Gateway Timeout'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 504, title: 'Gateway Timeout', detail: 'Service unreachable, please try again', instance: 'https://api.sandbox.easytransac.com/v2/open-banking/init', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 10, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
  /sdd/mandate/create:
    post:
      tags:
        - sdd
      summary: 'SDD - Mandate - Create'
      description: 'Creates a mandate for SDD (SEPA Direct Debit).'
      operationId: v2_endpoint_sdd_mandate_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - email
                - lastname
                - iban
                - address
                - zipCode
                - city
                - country
              properties:
                email:
                  description: "Customer's email address associated with the payment"
                  type: string
                  format: email
                  maxLength: 128
                  minLength: 6
                lastname:
                  description: "Customer's last name"
                  type: string
                  maxLength: 128
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                iban:
                  description: "Account's IBAN (ISO 13616)"
                  type: string
                  maxLength: 34
                  minLength: 14
                  pattern: '^[A-Z]{2}[0-9]{2}[A-Z0-9]{10,30}$'
                address:
                  description: "Customer's address"
                  type: string
                  maxLength: 128
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                zipCode:
                  description: "Customer's postal code"
                  type: string
                  maxLength: 16
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                city:
                  description: "Customer's city"
                  type: string
                  maxLength: 64
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                country:
                  description: "Customer's country of residence (ISO 3166-1 Alpha 3)"
                  type: string
                  maxLength: 3
                  minLength: 3
                uid:
                  description: 'Your own customer ID'
                  type: [string, 'null']
                  maxLength: 64
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                bic:
                  description: "Account's BIC (ISO 9362)"
                  type: [string, 'null']
                  maxLength: 11
                  minLength: 8
                  pattern: '^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$'
                accountOwner:
                  description: "Account's owner (person or company)"
                  type: [string, 'null']
                  maxLength: 64
                  minLength: 1
                clientId:
                  description: "Customer's Easytransac ID (only available if you have already made a payment for this customer)"
                  type: [string, 'null']
                  maxLength: 7
                  minLength: 7
                  pattern: '^[A-Za-z0-9]{7}$'
                firstname:
                  description: "Customer's first name"
                  type: [string, 'null']
                  maxLength: 128
                  minLength: 1
                  pattern: '^[A-Za-z0-9]+$'
                callingCode:
                  description: "Customer's calling code"
                  type: [string, 'null']
                  maxLength: 3
                  minLength: 1
                  pattern: '^[1-9][0-9]{0,2}$'
                phone:
                  description: "Customer's phone number"
                  type: [string, 'null']
                  maxLength: 15
                  minLength: 4
                  pattern: '^[0-9]{4,15}$'
                birthDate:
                  description: "Customer's birth date (ATOM)"
                  type: [string, 'null']
                  format: date
                  maxLength: 10
                  minLength: 10
                nationality:
                  description: "Customer's nationality (ISO 3166-1 Alpha 3)"
                  type: [string, 'null']
                  maxLength: 3
                  minLength: 3
              type: object
            examples:
              _mandatory:
                summary: _mandatory
                value:
                  email: abc@abc.com
                  lastname: ABCabc123
                  iban: FR7630001007941234567890185
                  address: ABCabc123
                  zipCode: ABCabc123
                  city: ABCabc123
                  country: FRA
              optional:
                summary: optional
                value:
                  email: abc@abc.com
                  lastname: ABCabc123
                  iban: FR7630001007941234567890185
                  address: ABCabc123
                  zipCode: ABCabc123
                  city: ABCabc123
                  country: FRA
                  uid: ABCabc123
                  bic: BDFEFRPPCCT
                  accountOwner: ABCabc123
                  firstname: ABCabc123
                  callingCode: '123'
                  phone: '123123123'
                  birthDate: '2024-12-31'
                  nationality: FRA
              all:
                summary: all
                value:
                  email: abc@abc.com
                  lastname: ABCabc123
                  iban: FR7630001007941234567890185
                  address: ABCabc123
                  zipCode: ABCabc123
                  city: ABCabc123
                  country: FRA
                  uid: ABCabc123
                  bic: BDFEFRPPCCT
                  accountOwner: ABCabc123
                  clientId: ABCabc1
                  firstname: ABCabc123
                  callingCode: '123'
                  phone: '123123123'
                  birthDate: '2024-12-31'
                  nationality: FRA
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  success: { description: 'Whether the action was successful', type: boolean }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time, maxLength: 25, minLength: 25 }
                  data: { description: 'Additional data', required: [mandateId, status, dateCreated], properties: { mandateId: { description: 'Easytransac mandate ID', type: string, maxLength: 20, minLength: 20, pattern: '^[a-z0-9]{20}$' }, status: { description: 'Mandate status', type: string, maxLength: 7, minLength: 6, enum: [active, invalid, pending] }, dateCreated: { description: 'Date of creation of the resource (ATOM)', type: string, format: date-time } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { success: true, date: '2024-12-31T23:59:59+02:00', data: { mandateId: abcabcabcabcabcabc12, status: active, dateCreated: '2024-12-31T23:59:59+02:00' } }
          links:
            '/sdd/mandate/{mandateId}/status':
              operationId: v2_endpoint_sdd_mandate_mandateid_status
              parameters:
                mandateId: '$response.body#/data.mandateId'
        '400':
          description: 'Bad Request'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 400, title: 'Bad Request', detail: 'Invalid parameter Iban', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 401, title: Unauthorized, detail: 'You have no access to this action | JWT Token not found', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 403, title: Forbidden, detail: 'You have no access to this action', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '404':
          description: 'Not Found'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 404, title: 'Not Found', detail: 'Client not found', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 207, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '405':
          description: 'Method Not Allowed'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 405, title: 'Method Not Allowed', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '500':
          description: 'Internal Server Error'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 500, title: 'Internal Server Error', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '502':
          description: 'Bad Gateway'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 502, title: 'Bad Gateway', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '504':
          description: 'Gateway Timeout'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 504, title: 'Gateway Timeout', detail: 'Service unreachable, please try again', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/create', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 10, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
  '/sdd/mandate/{mandateId}/debit':
    post:
      tags:
        - sdd
      summary: 'SDD - Mandate - Debit'
      description: 'Initializes a SDD (SEPA Direct Debit) from a `mandateId`.'
      operationId: v2_endpoint_sdd_mandate_debit
      parameters:
        -
          name: mandateId
          in: path
          description: 'Easytransac mandate ID'
          required: true
          style: simple
          explode: false
          allowReserved: false
          schema:
            type: string
            maxLength: 20
            minLength: 20
            pattern: '^[a-z0-9]{20}$'
          examples:
            _variable:
              summary: _variable
              value: '{{mandateId}}'
            default:
              summary: default
              value: abcabcabcabcabcabc12
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - amount
              properties:
                amount:
                  description: 'Transaction amount (cents)'
                  type: integer
                  minimum: 1
                b2b:
                  description: "The collection is a B2B direct debit and concerns payments between companies which aren't self-employed persons. It isn't contestable by the customer."
                  type: [boolean, 'null']
                  default: false
                clientIp:
                  description: "Customer's IP (v4 or v6)"
                  type: [string, 'null']
                  format: ipv4
                  maxLength: 45
                  minLength: 7
                orderId:
                  description: 'Your own transaction/order ID'
                  type: [string, 'null']
                  maxLength: 64
                  minLength: 1
                description:
                  description: 'Description of the transaction'
                  type: [string, 'null']
                  maxLength: 2048
                  minLength: 1
                multiplePayments:
                  description: 'Splits the payment into several transactions'
                  type: [boolean, 'null']
                  default: false
                multiplePaymentsRepeat:
                  description: 'Number of transactions by which the payment is split if `multiplePayments` is enabled'
                  type: [integer, 'null']
                  default: 3
                  maximum: 10
                  minimum: 2
                downPayment:
                  description: 'Amount of the first transaction if `rebill` or `multiplePayments` is enabled (cents)'
                  type: [integer, 'null']
                  minimum: 1
                rebill:
                  description: 'Enables subscription recurring payments'
                  type: [boolean, 'null']
                  default: false
                recurrence:
                  description: 'Recurring payments frequency if `rebill` is enabled'
                  type: [string, 'null']
                  default: monthly
                  maxLength: 10
                  minLength: 5
                  enum: [daily, weekly, monthly, bimonthly, quarterly, biannual, yearly]
                payToEmail:
                  description: 'Redirect the collection of this transaction to another Easytransac user account by its email'
                  type: [string, 'null']
                  format: email
                  maxLength: 128
                  minLength: 6
                payToId:
                  description: 'Redirect the collection of this transaction to another Easytransac user account by its ID'
                  type: [integer, 'null']
                  maximum: 99999999999
                  minimum: 1
                userAgent:
                  description: "Customer's browser's user agent"
                  type: [string, 'null']
                  maxLength: 2048
                  minLength: 1
                language:
                  description: 'Preferred language of the payment page (ISO 639)'
                  type: [string, 'null']
                  default: FRE
                  maxLength: 3
                  minLength: 3
                  enum: [DEU, ENG, FRE, ITA, SPA]
              type: object
            examples:
              _mandatory:
                summary: _mandatory
                value:
                  amount: 1000
              optional:
                summary: optional
                value:
                  amount: 1000
                  b2b: false
                  clientIp: 123.123.123.123
                  orderId: ABCabc123
                  description: ABCabc123
                  downPayment: 1000
                  userAgent: ABCabc123
                  language: FRE
              payment_multiple:
                summary: payment_multiple
                value:
                  amount: 1000
                  multiplePayments: true
                  multiplePaymentsRepeat: 3
              payment_rebill:
                summary: payment_rebill
                value:
                  amount: 1000
                  rebill: true
                  recurrence: monthly
              all:
                summary: all
                value:
                  amount: 1000
                  b2b: false
                  clientIp: 123.123.123.123
                  orderId: ABCabc123
                  description: ABCabc123
                  multiplePayments: false
                  multiplePaymentsRepeat: 3
                  downPayment: 1000
                  rebill: false
                  recurrence: monthly
                  payToEmail: abc@abc.com
                  payToId: 123
                  userAgent: ABCabc123
                  language: FRE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  success: { description: 'Whether the action was successful', type: boolean }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time, maxLength: 25, minLength: 25 }
                  data: { description: 'Additional data', required: [tid, status, amount, dateCreated], properties: { tid: { description: 'Transaction ID', type: string, maxLength: 14, minLength: 8, pattern: '^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}|[a-z0-9]{8}$' }, status: { description: 'Transaction status', type: string, maxLength: 10, minLength: 6, enum: [authorized, captured, failed, pending, refunded] }, amount: { description: 'Transaction amount (cents)', type: integer, minimum: 1 }, dateCreated: { description: 'Date of creation of the resource (ATOM)', type: string, format: date-time }, orderId: { description: 'Your own transaction/order ID', type: [string, 'null'], maxLength: 64, minLength: 1 } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { success: true, date: '2024-12-31T23:59:59+02:00', data: { tid: ABC1-ABC1-ABC1, status: captured, amount: 1000, dateCreated: '2024-12-31T23:59:59+02:00', orderId: ABCabc123 } }
          links:
            /transaction/status:
              operationId: v2_endpoint_transaction_status
              parameters:
                tid: '$response.body#/data.tid'
        '400':
          description: 'Bad Request'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 400, title: 'Bad Request', detail: 'Please choose between Rebill and MultiplePayments', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/debit', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 401, title: Unauthorized, detail: 'You have no access to this action | JWT Token not found', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/debit', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 403, title: Forbidden, detail: 'You have no access to this action', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/debit', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '404':
          description: 'Not Found'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 404, title: 'Not Found', detail: 'No valid IBAN found for this client', instance: 'https://api.sandbox.easytransac.com/v2/transaction/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 121, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '405':
          description: 'Method Not Allowed'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 405, title: 'Method Not Allowed', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/debit', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '500':
          description: 'Internal Server Error'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 500, title: 'Internal Server Error', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/debit', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '502':
          description: 'Bad Gateway'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 502, title: 'Bad Gateway', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/debit', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '504':
          description: 'Gateway Timeout'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 504, title: 'Gateway Timeout', detail: 'Service unreachable, please try again', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/debit', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 10, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
  '/sdd/mandate/{mandateId}/status':
    get:
      tags:
        - sdd
      summary: 'SDD - Mandate - Get status'
      description: 'Gets the status of the requested mandate with your Easytransac `mandateId`.'
      operationId: v2_endpoint_sdd_mandate_mandateid_status
      parameters:
        -
          name: mandateId
          in: path
          description: 'Easytransac mandate ID'
          required: true
          style: simple
          explode: false
          allowReserved: false
          schema:
            type: string
            maxLength: 20
            minLength: 20
            pattern: '^[a-z0-9]{20}$'
          examples:
            _variable:
              summary: _variable
              value: '{{mandateId}}'
            default:
              summary: default
              value: abcabcabcabcabcabc12
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - success
                  - date
                  - data
                properties:
                  success: { description: 'Whether the action was successful', type: boolean }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time, maxLength: 25, minLength: 25 }
                  data: { description: 'Additional data', required: [mandateId, status, dateCreated], properties: { mandateId: { description: 'Easytransac mandate ID', type: string, maxLength: 20, minLength: 20, pattern: '^[a-z0-9]{20}$' }, status: { description: 'Mandate status', type: string, maxLength: 7, minLength: 6, enum: [active, invalid, pending] }, dateCreated: { description: 'Date of creation of the resource (ATOM)', type: string, format: date-time } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { success: true, date: '2024-12-31T23:59:59+02:00', data: { mandateId: abcabcabcabcabcabc12, status: active, dateCreated: '2024-12-31T23:59:59+02:00' } }
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 401, title: Unauthorized, detail: 'You have no access to this action | JWT Token not found', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 403, title: Forbidden, detail: 'You have no access to this action', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '404':
          description: 'Not Found'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 404, title: 'Not Found', detail: 'No valid IBAN found for this client', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 121, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '405':
          description: 'Method Not Allowed'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 405, title: 'Method Not Allowed', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '500':
          description: 'Internal Server Error'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 500, title: 'Internal Server Error', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
  /transaction/status:
    get:
      tags:
        - transaction
      summary: 'Transaction - Get status'
      description: 'Gets the status of the requested payment with your Easytransac transaction ID `tid` or your own transaction/order ID `orderId`.'
      operationId: v2_endpoint_transaction_status
      parameters:
        -
          name: tid
          in: query
          description: 'Transaction ID'
          required: false
          style: form
          explode: false
          allowReserved: false
          schema:
            type:
              - string
              - 'null'
            maxLength: 14
            minLength: 8
            pattern: '^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}|[a-z0-9]{8}$'
          examples:
            _variable:
              summary: _variable
              value: '{{tid}}'
            default:
              summary: default
              value: ABC1-ABC1-ABC1
        -
          name: orderId
          in: query
          description: 'Your own transaction/order ID'
          required: false
          style: form
          explode: false
          allowReserved: false
          schema:
            type:
              - string
              - 'null'
            maxLength: 64
            minLength: 1
          examples:
            _variable:
              summary: _variable
              value: '{{orderId}}'
            default:
              summary: default
              value: ABCabc123
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - success
                  - date
                  - data
                properties:
                  success: { description: 'Whether the action was successful', type: boolean }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time, maxLength: 25, minLength: 25 }
                  data: { description: 'Additional data', required: [tid, status, amount, dateCreated], properties: { tid: { description: 'Transaction ID', type: string, maxLength: 14, minLength: 8, pattern: '^[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}|[a-z0-9]{8}$' }, status: { description: 'Transaction status', type: string, maxLength: 10, minLength: 6, enum: [authorized, captured, failed, pending, refunded] }, amount: { description: 'Transaction amount (cents)', type: integer, minimum: 1 }, dateCreated: { description: 'Date of creation of the resource (ATOM)', type: string, format: date-time }, orderId: { description: 'Your own transaction/order ID', type: [string, 'null'], maxLength: 64, minLength: 1 }, redirectUrl: { description: 'URL to redirect the customer to its bank payment page', type: [string, 'null'], maxLength: 255, minLength: 12 } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { success: true, date: '2024-12-31T23:59:59+02:00', data: { tid: ABC1-ABC1-ABC1, status: captured, amount: 1000, dateCreated: '2024-12-31T23:59:59+02:00', orderId: ABCabc123, redirectUrl: 'https://api.sandbox.easytransac.com/v2/public/transaction/ABC1-ABC1-ABC1/redirect' } }
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 401, title: Unauthorized, detail: 'You have no access to this action | JWT Token not found', instance: 'https://api.sandbox.easytransac.com/v2/transaction/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 707, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 403, title: Forbidden, detail: 'Invalid transaction', instance: 'https://api.sandbox.easytransac.com/v2/sdd/mandate/{mandateId}/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 204, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '404':
          description: 'Not Found'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 404, title: 'Not Found', detail: 'No transaction found', instance: 'https://api.sandbox.easytransac.com/v2/transaction/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 203, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '405':
          description: 'Method Not Allowed'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 405, title: 'Method Not Allowed', detail: 'Invalid request', instance: 'https://api.sandbox.easytransac.com/v2/transaction/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 1, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
        '500':
          description: 'Internal Server Error'
          content:
            application/json:
              schema:
                required:
                  - type
                  - status
                  - title
                  - detail
                  - instance
                  - date
                  - success
                  - apiError
                  - data
                properties:
                  type: { description: 'Link to the `ApiError` page', type: string, format: uri }
                  status: { description: 'HTTP code', type: integer }
                  title: { description: 'Error name', type: string }
                  detail: { description: 'Detailed `ApiError` description', type: string }
                  instance: { description: 'Location of the error', type: string }
                  date: { description: 'Date of response (ATOM)', type: string, format: date-time }
                  success: { description: 'Whether the action was successful', type: boolean }
                  apiError: { description: '`ApiError` code', type: integer, maximum: 10003, minimum: 1 }
                  data: { description: 'Additional data', required: [requestId], properties: { requestId: { description: 'ID to provide to the support if you encounter an error (UUID V7)', type: string, format: uuid } }, type: object }
                type: object
              examples:
                default:
                  summary: default
                  value: { type: 'https://docs.easytransac.com/doc-631313', status: 500, title: 'Internal Server Error', detail: AN_ERROR_OCCURRED, instance: 'https://api.sandbox.easytransac.com/v2/transaction/status', date: '2024-12-31T23:59:59+02:00', success: false, apiError: 200, data: { requestId: 01941882-a753-7b42-bacc-da0594d77a52 } }
components:
  securitySchemes:
    bearer:
      type: http
      bearerFormat: jwt
      scheme: bearer
tags:
  -
    name: authentication
    description: authentication
  -
    name: open_banking
    description: open_banking
  -
    name: sdd
    description: sdd
  -
    name: transaction
    description: transaction
