HiPay Transaction API
The Transaction API from HiPay — 6 operation(s) for transaction.
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-transaction-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:
title: Hipay Transaction API
version: '1.0'
description: 'Operations tagged Transaction across 4 of this provider''s published API definitions: api-gateway.yml, gateway.yaml, marketplace.yaml, omnichannel.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://stage-api-gateway.hipay.com
description: Stage
- url: https://api-gateway.hipay.com
description: Production
- url: https://stage-secure-gateway.hipay-tpp.com/rest
description: Stage
- url: https://secure-gateway.hipay-tpp.com/rest
description: Production
- url: https://test-professional.hipay.com/api
- url: https://stage-secure-gateway.hipay-tpp.com/rest/
tags:
- name: Transaction
paths:
/v3/transaction/{transaction_reference}:
get:
tags:
- Transaction
operationId: get_api_transaction_consultation_public
parameters:
- name: transaction_reference
in: path
description: The unique identifier of the transaction.
required: true
schema:
type: string
pattern: \d+
example: '800000420435'
responses:
'200':
description: Transaction retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
'401':
description: An authentication error occurred/invalid credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: This transaction is not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- ApiKeyAuth: []
- BasicAuth: []
servers:
- url: https://stage-api-gateway.hipay.com
description: Stage
- url: https://api-gateway.hipay.com
description: Production
/v3/transactions/{type}/{value}:
get:
tags:
- Transaction
operationId: get_api_transaction_consultations_by_type_public
parameters:
- name: type
in: path
required: true
schema:
type: string
pattern: arn|opid|acquirerid
enum:
- arn
- opid
- acquirerid
- name: value
in: path
required: true
schema:
type: string
responses:
'200':
description: Transactions retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionCollection'
'400':
description: The request was rejected due to a validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: An authentication error occurred/invalid credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: No transaction found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- ApiKeyAuth: []
- BasicAuth: []
servers:
- url: https://stage-api-gateway.hipay.com
description: Stage
- url: https://api-gateway.hipay.com
description: Production
/v1/transaction/{transaction_reference}:
get:
tags:
- Transaction
summary: Gets details of existing transactions based on a transaction ID
description: Gets details of existing transactions based on a transaction ID.
operationId: getTransactionByReference
parameters:
- name: transaction_reference
in: path
description: The unique identifier of the transaction.
required: true
schema:
type: string
example: '800000420435'
x-sort: 1
responses:
'200':
description: Transaction retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionDetail'
'400':
description: The request was rejected due to a validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error_2'
'401':
description: An authentication error occurred/invalid credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error_2'
'403':
description: Access to this resource is fordidden.
content:
application/json:
schema:
$ref: '#/components/schemas/Error_2'
deprecated: true
security:
- basicAuth: []
servers:
- url: https://stage-secure-gateway.hipay-tpp.com/rest
description: Stage
- url: https://secure-gateway.hipay-tpp.com/rest
description: Production
/v1/transaction:
get:
tags:
- Transaction
summary: Gets details of existing transactions related to a given order
description: Gets details of existing transactions related to a given order. Deprecated, you can refer to [this page](https://developer.hipay.com/api-explorer/api-gateway#/transaction/get_api_consultation_transaction) for new endpoint
operationId: getTransactionsByReference
parameters:
- name: orderid
in: query
description: Merchant unique order id. Return all the transactions related to an order id.
required: true
schema:
type: string
example: ORDER_1487239265080
x-sort: 1
responses:
'200':
description: Transactions retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionDetail'
'400':
description: The request was rejected due to a validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error_2'
'401':
description: An authentication error occurred/invalid credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/Error_2'
'403':
description: Access to this resource is fordidden.
content:
application/json:
schema:
$ref: '#/components/schemas/Error_2'
deprecated: true
security:
- basicAuth: []
servers:
- url: https://stage-secure-gateway.hipay-tpp.com/rest
description: Stage
- url: https://secure-gateway.hipay-tpp.com/rest
description: Production
/transaction.{_format}:
get:
summary: Get transactions list
description: '
### Information
Get transactions list.'
parameters:
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
- in: query
description: 'Start of transaction date range. Accepted formats : yyyy-MM-dd HH:MM:ss and yyyy-MM-dd. Default date : 7 days ago. Default time : 00:00:00.'
name: start-date
schema:
type: string
default: '2018-01-31'
- in: query
description: 'End of transaction date range. Accepted formats : yyyy-MM-dd HH:MM:ss and yyyy-MM-dd. Default date : today. Default time : 23:59:59.
Interval between start-date and end-date cannot be greater than 3 months (92 days).
'
name: end-date
schema:
type: string
default: '2018-04-07'
- in: query
description: 'Number of results to display on each page. Cannot exceed 1000. Default : 20'
name: nb-result-per-page
schema:
type: integer
format: int32
default: 20
- in: query
description: 'Page number. First page has number 1. Default : 1'
name: page
schema:
type: integer
format: int32
default: 1
- in: query
description: 'Properties sorting configuration. Ex: sort-props[email]=asc&sort-props[status]=desc. Default : sort-props[captured]=desc'
name: sort-props
schema:
type: string
- description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-id
schema:
type: integer
- description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-login
schema:
type: string
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
nb_result:
type: integer
format: int32
description: Total number of results matching search criterias
transactions_list:
type: array
items:
type: string
description: List of transactions
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- Transaction
security:
- basicAuth: []
servers:
- url: https://test-professional.hipay.com/api
/transaction/{id}.{_format}:
get:
summary: Get transaction details
description: '
### Information
This request will send you the details of a requested transaction.'
parameters:
- in: path
name: id
description: HiPay transaction ID or Merchant reference of transaction ID to verify.
required: true
schema:
type: string
default: 5a71d61c6778932713
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
- description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-id
schema:
type: integer
- description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-login
schema:
type: string
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
transaction_id:
type: string
description: HiPay transaction ID.
amount:
type: number
format: float
description: Transaction amount.
currency:
type: string
description: Transaction currency.
creation_date:
type: string
description: Transaction creation date.
collect_date:
type: string
description: Transaction collect date.
transaction_status:
type: string
description: "### Actual status of the transaction\nTransaction type\n\n - `1`: feeding\n - `2`: external transfer\n - `3`: simple payment\n - `4`: direct payment\n - `5`: european withdrawal\n - `6`: other\n - `7`: international transfer\n - `8`: international withdrawal\n - `10`: affiliation transfer\n - `11`: tax transfer\n - `12`: identification transfer\n - `13`: direct donation\n - `14`: simple donation\n - `15`: payable reference payment\n - `16`: business contributor transfer\n - `17`: injection payment"
transaction_label:
type: string
description: Transaction label.
type:
type: string
description: Transaction type.
capture_date:
type: string
description: Transaction capture date.
issuer_email:
type: string
description: Issuer email.
recipient_email:
type: string
description: Recipient email.
subscription_id:
type: string
description: If a subscription is linked to the transaction, subscription ID.
merchant_reference:
type: string
description: Merchant reference sent to the transaction.
site_url:
type: string
description: Site URL linked to the transaction.
merchant_email:
type: string
description: Merchant Email.
site_name:
type: string
description: Website name.
fees:
type: string
description: Transaction fees.
currency_fees:
type: string
description: Currency linked to fees.
refusal_reason:
type: string
description: Refusal reason.
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- Transaction
security:
- basicAuth: []
servers:
- url: https://test-professional.hipay.com/api
components:
schemas:
CardEntryMode3:
type: string
enum:
- Not specified
- Magstripe
- Contactless chip transaction using EMV chip data
- Contactless chip transaction using magstripe data
- ICC
- Manual entry
- Magstripe, after attempt to read chip
- Provided by a server
- Card-on-File
FraudResult:
required:
- result
- review
- score
properties:
result:
$ref: '#/components/schemas/Result'
review:
$ref: '#/components/schemas/Review'
score:
type: integer
example: 200
type: object
Device3:
required:
- ip_address
properties:
id:
type:
- string
- 'null'
ip_address:
description: The IP address of the Device
type: string
example: 127.0.0.1
type: object
AcquirerTraContext:
type: object
CardEntryMode2:
type: string
enum:
- Not specified
- Magstripe
- Contactless chip transaction using EMV chip data
- Contactless chip transaction using magstripe data
- ICC
- Manual entry
- Magstripe, after attempt to read chip
- Provided by a server
- Card-on-File
Card:
properties:
pan:
type:
- string
- 'null'
last_digits:
type:
- string
- 'null'
scheme:
type:
- string
- 'null'
category:
type:
- string
- 'null'
type:
type:
- string
- 'null'
bin:
type:
- integer
- 'null'
token:
type:
- string
- 'null'
type: object
Address2:
properties:
house_number:
description: House number.
type:
- string
- 'null'
example: '101'
house_extension:
description: House extension.
type:
- string
- 'null'
example: B
street:
description: Street address.
type:
- string
- 'null'
example: Rue de Rivoli
street_additional:
description: Additional address information of the customer (e.g., building, floor, flat, etc.).
type:
- string
- 'null'
example: Immeuble B
locality:
description: City.
type:
- string
- 'null'
example: Paris
locality_additional:
description: The USA state or the Canada state of the customer making the purchase. Send this information only if the address country of the customer is US (USA) or CA (Canada)
type:
- string
- 'null'
example: ''
postal_code:
description: The zip or postal code of the customer.
type:
- string
- 'null'
example: '75001'
country:
description: Country code to which the order is being shipped. This two-letter country code complies with ISO 3166-1 (alpha 2).
type:
- string
- 'null'
example: FR
type: object
Operation:
required:
- type
- status
- amount
- arn
- date_created
- id
- currency
- decimals
properties:
type:
$ref: '#/components/schemas/OperationType'
status:
$ref: '#/components/schemas/OperationStatus'
amount:
description: Operation Amount.
type: string
example: '10.00'
arn:
description: Acquirer Reference Number.
type: string
example: '75064953264000221624949'
merchant_reference:
type:
- string
- 'null'
date_created:
type: string
format: date-time
date_updated:
type:
- string
- 'null'
format: date-time
date_remitted:
type:
- string
- 'null'
format: date-time
date_processed:
type:
- string
- 'null'
format: date-time
date_reconciled:
type:
- string
- 'null'
format: date-time
id:
type: integer
currency:
$ref: '#/components/schemas/Currency2'
decimals:
type: integer
example: '2'
caseid:
type:
- string
- 'null'
type: object
DebitAgreement:
required:
- id
- status
properties:
id:
type: integer
scheme_reference_data:
type:
- string
- 'null'
status:
$ref: '#/components/schemas/Status3'
recurring_payment_end_date:
type:
- string
- 'null'
type: object
Authentication3:
type: string
enum:
- Authentication Successful
- Authentication Attempt Performed
- Authentication Failed
- Authentication Could Not Be Performed
- Error
- Not applicable
- Cardholder challenge required
- Not authenticated because the issuer is rejecting authentication
- Challenge required; decoupled authentication confirmed
- Informational only; 3DS Requestor challenge preference acknowledged
- Mastercard Delegated Authentication
Operation3:
required:
- type
- status
- amount
- arn
- date_created
- id
- currency
- decimals
properties:
type:
$ref: '#/components/schemas/OperationType3'
status:
$ref: '#/components/schemas/OperationStatus3'
amount:
description: Operation Amount.
type: string
example: '10.00'
arn:
description: Acquirer Reference Number.
type: string
example: '75064953264000221624949'
merchant_reference:
type:
- string
- 'null'
date_created:
type: string
format: date-time
date_updated:
type:
- string
- 'null'
format: date-time
date_remitted:
type:
- string
- 'null'
format: date-time
date_processed:
type:
- string
- 'null'
format: date-time
date_reconciled:
type:
- string
- 'null'
format: date-time
id:
type: integer
currency:
$ref: '#/components/schemas/Currency3'
decimals:
type: integer
example: '2'
caseid:
type:
- string
- 'null'
type: object
Status6:
type: string
enum:
- available
- created
- error
- incomplete
- pending
- suspended
- terminated
OperationStatus:
type: string
enum:
- CANCELLED
- COMPLETED
- CREATED
- FAILURE
- NOT_PROCESSED
- PENDING
- RECONCILED
- REMITTED
- REQUESTED
- RETRIED
- SPLIT
- CHGBCK
- CHGBCK_REFUND
Status4:
type: integer
enum:
- 1
- 2
- 3
- 4
- 52
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 42
- 43
- 75
- 16
- 55
- 17
- 18
- 54
- 19
- 20
- 21
- 22
- 23
- 24
- 65
- 25
- 26
- 27
- 28
- 29
- 34
- 30
- 31
- 32
- 40
- 41
- 80
- 81
- 82
- 83
- 50
- 51
- 53
- 57
- 69
- 66
- 72
- 74
- 77
- 78
TransactionState3:
type: string
enum:
- completed
- waiting
- pending
- declined
- forwarding
- error
Address3:
properties:
house_number:
description: House number.
type:
- string
- 'null'
example: '101'
house_extension:
description: House extension.
type:
- string
- 'null'
example: B
street:
description: Street address.
type:
- string
- 'null'
example: Rue de Rivoli
street_additional:
description: Additional address information of the customer (e.g., building, floor, flat, etc.).
type:
- string
- 'null'
example: Immeuble B
locality:
description: City.
type:
- string
- 'null'
example: Paris
locality_additional:
description: The USA state or the Canada state of the customer making the purchase. Send this information only if the address country of the customer is US (USA) or CA (Canada)
type:
- string
- 'null'
example: ''
postal_code:
description: The zip or postal code of the customer.
type:
- string
- 'null'
example: '75001'
country:
description: Country code to which the order is being shipped. This two-letter country code complies with ISO 3166-1 (alpha 2).
type:
- string
- 'null'
example: FR
type: object
Device:
required:
- ip_address
properties:
id:
type:
- string
- 'null'
ip_address:
description: The IP address of the Device
type: string
example: 127.0.0.1
type: object
Acquirer:
properties:
transaction_reference:
description: Unique Transaction Identifier.
type:
- string
- 'null'
example: '800000790677'
type: object
FraudResult3:
required:
- result
- review
- score
properties:
result:
$ref: '#/components/schemas/Result3'
review:
$ref: '#/components/schemas/Review3'
score:
type: integer
example: 200
type: object
TerminalInformation3:
properties:
payment_context:
description: Payment context
type:
- string
- 'null'
example: online
input_mode:
description: Input mode
type:
- string
- 'null'
example: contact
aid:
description: Aid
type:
- string
- 'null'
example: A0000000422010
payment_gateway:
description: Payment gateway
type:
- string
- 'null'
example: nepting
authorization_code:
description: Authorization code
type:
- string
- 'null'
example: '00'
authorization_number:
description: Authorization number
type:
- string
- 'null'
example: '963379'
customer_receipt:
description: Customer receipt
type:
- string
- 'null'
payment_source:
description: Payment source
type:
- string
- 'null'
example: IPN Nepting
payment_terminal_serial_number:
description: Payment terminal serial number
type:
- string
- 'null'
idsa:
description: Acceptance system identifier assigned by an acquirer
type:
- string
- 'null'
rts:
description: Transaction ID generated by the issuer auth system
type:
- string
- 'null'
card_entry_mode:
description: Card entry mode
example: magstripe
oneOf:
- $ref: '#/components/schemas/CardEntryMode3'
file_number:
description: File number
type:
- string
- 'null'
type: object
PaymentMethod:
required:
- name
- description
properties:
name:
type: string
description:
type: string
type: object
ThreeDSAuthenticationMethod:
type: string
enum:
- challenge
- frictionless
- ''
Result3:
type: string
enum:
- NOT_LAUNCHED
- PENDING
- ACCEPTED
- REQUEST EXEMPTION
- BLOCKED
- CHALLENGED
- AUTHENTICATE
- FORCE_AUTHENTICATE
- OVERRIDE
- ACCEPT WITH NO PREFERENCE
- DENIED
- ALLOWED
ShippingAddress2:
properties:
house_number:
description: House number.
type:
- string
- 'null'
example: '101'
house_extension:
description: House extension.
type:
- string
- 'null'
example: B
street:
description: Street address.
type:
- string
- 'null'
example: Rue de Rivoli
street_additional:
description: Additional address information of the customer (e.g., building, floor, flat, etc.).
type:
- string
- 'null'
example: Immeuble B
locality:
description: City.
type:
- string
- 'null'
example: Paris
locality_additional:
description: The USA state or the Canada state of the customer making the purchase. Send this information only if the address country of the customer is US (USA) or CA (Canada)
type:
- string
- 'null'
example: ''
postal_code:
description: The zip or postal code of the customer.
type:
- string
- 'null'
example: '75001'
country:
description: Country code to which the order is being shipped. This two-letter country code complies with ISO 3166-1 (alpha 2).
type:
- string
- 'null'
example: FR
type: object
TransactionCollection:
properties:
transactions:
type: array
items:
$ref: '#/components/schemas/Transaction3'
default: []
type: object
AcquirerTraContext3:
type: object
Cvc:
type: string
enum:
- Match
- No Match
- Not Processed
- Missing
- Not Supported
StatusHistoryCollection:
type: object
ThreeDSAuthenticationLiability3:
type: string
enum:
- issuer
- merchant
- not applicable
Issuer3:
properties:
fullname:
type:
- string
- 'null'
institution:
type:
- string
- 'null'
country:
type:
- string
- 'null'
type: object
Acquirer3:
properties:
transaction_reference:
description: Unique Transaction Identifier.
type:
- string
- 'null'
example: '800000790677'
type: object
Authentication:
required:
- eci
properties:
enrollment_status:
description: ''
type:
- string
- 'null'
example: N
enrollment_message:
description: ''
type:
- string
- 'null'
example: Cardholder Not Enrolled
authentication_status:
oneOf:
- $ref: '#/components/schemas/Authentication3'
authentication_message:
type:
- string
- 'null'
eci:
description: 'Electronic Commerce Indicator (ECI).
The Electronic Commerce Indicator (ECI) is used by acquirers/issuers
to determine the type of transaction being processed. The ECI value
should represent the source of the transaction request. That is, the
environment that the cardholder used to provide the payment card details
to the merchant. It is important that merchants set the correct ECI
value during transaction processing to ensure that appropriate merchant
service rates are received.'
type: integer
example: 5
sca_preference:
description: "To indicate the preference for a frictionless flow during the authentication request, the merchant may send the sca_preference parameter.\n\nDepending on the merchant's assessment of the risk of fraud, specific values may be sent.\n\nThis parameter can only be used by merchants who have a fraud risk assessment mechanism of their own and who have subscribed to the SCA Preference merchant option.\n\nPlease contact your account manager to request it.\n\n`1` : No Preference.\n\n If you are not sure about the transaction's risk of fraud, use this value. Using this value for all your transactions may result in a high strong customer authentication rate.\n\n`2` : No Challenge\n\n If you think this transaction is safe. This will tell the acquirer a frictionless flow is preferred.\n\n`3` : Challenge Requested\n\n If you think this transaction may be at risk, use this value. This will tell the acquirer that a strong customer authentication may be required, depending on the PSD2 specific information you sent along with the transaction."
example: 1
oneOf:
- $ref: '#/compo
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hipay/refs/heads/main/openapi/hipay-transaction-api-openapi.yml