HiPay Enterprise - Annexes
1. Format abbreviation
Description
AN
Alphanumeric characters (a-z, A-Z, 0-9)
A
Alphabetic characters only (a-z, A-Z)
N
Numeric characters only
R
Decimal number with explicit decimal point, signed
JSON
JavaScript Object Notation
2. API response fields
Field name
Description
forwardUrl
URL to redirect the customer (for Bancontact or 3DS authentication)
state
Transaction state. The value must be from the following list: - completed - pending - declined - error For further details, please refer to the Transaction workflow section.
reason - code - message
Optional element. Reason why the transaction was declined. - code: Decline reason code - message: Decline reason description Possible decline reasons can be found in the Decline reasons and error codes section.
test
True if the transaction is a test transaction; otherwise false
mid
Your merchant account number (issued to you by HiPay Enterprise)
attempt_id
Attempt ID of the payment
authorization_code
Authorization code (up to 35 characters) generated for each approved or pending transaction by the acquiring provider
transaction_reference
Unique identifier of the transaction
date_created
Date when the transaction was created
date_updated
Date when the transaction was last updated
date_authorized
Date when the transaction was authorized
status
Transaction status. A list of possible statuses can be found in the Transaction statuses section.
message
Transaction message
authorized_amount
Transaction amount
captured_amount
Captured amount
refunded_amount
Refunded amount
decimals
Decimal precision of the transaction amount
currency
Base currency for the transaction. This three-character currency code complies with ISO 4217.
ip_address
IP address of the customer making the purchase
ip_country
Country code associated to the customer’s IP address
device_id
Unique identifier assigned to the device (the customer’s browser) by HiPay
cdata1 - cdata2 - ... - cdata10
Custom data
avs_result
Result of the Address Verification Service (AVS) Possible AVS result codes can be found in the Address Verification Service section.
cvc_result
Result of the CVC (Card Verification Code) check Possible CVC result codes can be found in the Card Verification Code section.
eci
Electronic Commerce Indicator (ECI) Possible ECIs can be found in the Electronic Commerce Indicator section.
payment_product
Payment product used to complete the transaction. Informs about the payment_method section type. Possible payment products can be found in the Payment products section.
payment_method
For further details, please refer to the Response fields specific to the payment product section.
three_d_secure - eci - enrollment_status - enrollment_message - authentication_status - authentication_message - authentication_token - xid
Optional element. Result of the 3-D Secure authentication. - 3-D Secure (3DS) Electronic Commerce Indicator - Enrollment status - Enrollment message - Authentication status - This field is only included if payment authentication was attempted and a value was received. - Authentication message. This field is only included if payment authentication was attempted and a value was received. - Value generated by the card issuer as a token to prove that the cardholder was successfully authenticated. - Unique transaction identifier generated by the payment server on behalf of the merchant to identify the 3-D Secure transaction.
fraud_screening - scoring - result - review
Fraud screening result Total score assigned to the transaction (main risk indicator) Overall result of risk assessment returned by the payment gateway The value must be from the following list: - pending: rules have not been checked - accepted: the transaction has been accepted - blocked: the transaction has been rejected due to reviewing system rules - challenged: the transaction has been flagged for review. Decision made when the overall risk result returns challenged. An empty value means that no review is required. The value must be from the following list: - pending: a decision to release or cancel the transaction is pending - allowed: the transaction has been released for processing - denied: the transaction has been cancelled
order - Id - dateCreated - attempts - amount - shipping - tax - decimals - currency - customer_id - language - email
Information about the customer and their order: - Unique identifier of the order as provided by the merchant - Time when the order was created - Indicates how many payment attempts have been made for this order - Total order amount (e.g.: 150.00). It should be calculated as the sum of purchased items, plus shipping fees (if present) and tax (if present). - Order shipping fees - Order tax amount - Decimal precision of the order amount - Base currency for this order. This three-character currency code complies with ISO 4217. - Unique identifier of the customer as provided by the merchant - Language code of the customer - Email address of the customer
operation - type - id - reference - amount - currency - date
If a maintenance operation was requested and an operation_id value was sent. - Type of last operation - Operation ID sent in maintenance operation - HiPay’s Operation reference - Operation amount - Operation currency - Operation date
