HiPay settlement API
Everything you need to get all settlement details
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hipay-settlement-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 1.0.0
title: HiPay Enterprise Finance Settlement API
description: '
When using HiPay Enterprise, all your sales are consolidated and settled (transferred to your bank account).
The Finance API allows you to get all the details about settlements executed for your merchant account.
# Integration
The `settlement` endpoint allows you to either consult the whole list of settlements or search for particular settlements by amount or date.
You can get the total amount which has been transferred to your bank account as well as the total sales amount, refunds, fees and chargebacks for each settlement by using the `/settlement/{id}` endpoint.
You may also download settlement files in spreadsheet formats (xls, csv) or plain text by leveraging the `/settlement/{id}/raw{ext}` endpoint.
Note: this documentation describes the Finance API parameters and response fields and allows you to test the platform in real time.
# Web service information
## Finance API base URLs
| Environment | Base URL |
| --- | --- |
| Stage | https://stage-api.hipay-tpp.com/v1 |
| Production | https://api.hipay-tpp.com/v1 |
## Authentication
All requests to HiPay Enterprise API require you to authenticate using the HTTP *Basic Authentication* to convey your identity. Your API credentials can be found in your HiPay Enterprise back office in the Integration section. Most HTTP clients (including web-browsers) have built-in support for HTTP Basic Authentication. If not, the following header must be included in all HTTP requests.
`Authorization: Basic base64("<API login>:<API password>")`
'
servers:
- url: https://stage-api.hipay-tpp.com/v1
tags:
- name: settlement
description: Everything you need to get all settlement details
paths:
/settlement:
get:
description: 'This endpoint allows you to get the whole list of settlements for the merchant account you''re authenticated with.
The results are paginated, which means that not all the settlements are returned in one API call. Check the `page` and `per_page` parameters for more information about pagination.
You may need to search for particular settlements. To this end, this endpoint also offers filtering parameters which allow you to get settlements for a specific amount and currency or in a specific date range.
Check out the `amount`, `currency`, `date_from` and `date_to` parameters for more information about filtering capabilities.
'
summary: Lists settlements for your merchant account
tags:
- settlement
operationId: getSettlements
parameters:
- in: query
schema:
example: 19.99
required: false
name: amount
description: Parameter which filters settlements equal to this amount.
- in: query
required: false
name: currency
description: Parameter which filters settlements in this currency. This three-character currency code complies with ISO 4217.
schema:
example: EUR
default: EUR
- in: query
required: false
name: date_from
schema:
example: '2016-11-22'
description: Parameter which filters settlements after this date (format YYYY-MM-DD).
- in: query
required: false
name: date_to
schema:
example: '2017-01-05'
description: Parameter which filters settlements before this date (format YYYY-MM-DD).
- in: query
required: false
schema:
example: settlementid
default: settlementid
name: sort
description: Parameter which sorts settlements by this parameter.
- in: query
required: false
schema:
example: 1
name: page
description: Range of settlements to return.
- in: query
required: false
schema:
example: 10
name: per_page
description: Number of settlements to be returned.
responses:
'200':
description: The settlements were properly returned.
content:
application/json:
schema:
type: object
required:
- settlements
description: List of settlements
properties:
settlements:
type: array
items:
type: object
description: Settlement item information
required:
- settlementid
- amount
- currency
- date_value
properties:
recipient_name:
type: string
description: Recipient name
recipient_iban:
type: string
description: Recipient IBAN
recipient_bic:
type: string
description: Recipient BIC
recipient_bank_country:
type: string
description: Recipient bank country
amount:
type: number
description: Settlement amount
currency:
type: string
description: Settlement currency
date_value:
type: string
description: Settlement date
merchant_name:
type: string
description: Merchant name
merchant_id:
type: integer
description: Merchant id
format: int32
settlementid:
type: integer
description: Setllement ID
sales:
type: number
description: Sales amount
refunds:
type: number
description: Refunds amount
fees:
type: number
description: Fees amount
chargeback:
type: number
description: Chargebacks amount
deferred:
type: number
description: Deferred amount
rolling:
type: number
description: Rollings amount
other:
type: number
description: Other amount
description: ''
'400':
description: The request was rejected due to a validation error.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'401':
description: An authentication error occurred/invalid credentials.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'403':
description: Access to this resource is fordidden.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
security:
- basicAuth: []
/settlement/{id}:
get:
summary: Retrieves details on a specific settlement
description: 'This endpoint allows you to get all details for a specific settlement based on its settlement ID. Details include:
- Bank transfer info (bank name, recipient IBAN, etc.)
- Total amount transferred to the bank account
- Detailed amounts (sales, refunds, chargebacks, fees, etc.)
'
tags:
- settlement
operationId: getSettlementItem
parameters:
- in: path
name: id
required: true
schema:
example: 123456
description: The settlement ID.
responses:
'200':
description: The settlement item was properly returned.
content:
application/json:
schema:
type: object
description: Settlement item information
required:
- settlementid
- amount
- currency
- date_value
properties:
recipient_name:
type: string
description: Recipient name
recipient_iban:
type: string
description: Recipient IBAN
recipient_bic:
type: string
description: Recipient BIC
recipient_bank_country:
type: string
description: Recipient bank country
amount:
type: number
description: Settlement amount
currency:
type: string
description: Settlement currency
date_value:
type: string
description: Settlement date
merchant_name:
type: string
description: Merchant name
merchant_id:
type: integer
description: Merchant id
format: int32
settlementid:
type: integer
description: Setllement ID
sales:
type: number
description: Sales amount
refunds:
type: number
description: Refunds amount
fees:
type: number
description: Fees amount
chargeback:
type: number
description: Chargebacks amount
deferred:
type: number
description: Deferred amount
rolling:
type: number
description: Rollings amount
other:
type: number
description: Other amount
'400':
description: The request was rejected due to a validation error.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'401':
description: An authentication error occurred/invalid credentials.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'403':
description: Access to this resource is fordidden.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'404':
description: Settlement item was not found.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
security:
- basicAuth: []
/settlement/{id}/raw{ext}:
get:
summary: Returns the content of a settlement file in a given format
description: 'This endpoint allows you to download a settlement file in raw format given a specific settlement ID.
Available formats for download are: `.txt`, `.xls` and `.csv`.
'
tags:
- settlement
operationId: getSettlementRaw
parameters:
- in: path
name: id
schema:
example: 123456
required: true
description: The settlement ID.
- in: path
name: ext
required: true
description: The format of the settlement raw file you want to download.
schema:
example: .csv
default: .csv
responses:
'200':
description: The settlement item was properly returned.
'400':
description: The request was rejected due to a validation error.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'401':
description: An authentication error occurred/invalid credentials.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'403':
description: Access to this resource is fordidden.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
'404':
description: Settlement item was not found.
content:
application/json:
schema:
type: object
properties:
error:
type: object
required:
- code
- message
- description
properties:
code:
type: integer
description: Error code
message:
type: string
description: Error message
description:
type: string
description: Error description
security:
- basicAuth: []
components:
securitySchemes:
basicAuth:
type: http
scheme: basic