Payen
Payment Reports
This section describes the Payments reports available from Payen.
Payment Report Variants
There are 3 variations of the report, that all share the same format:
| Report | Description |
|---|---|
| Payment Report | All transactional data by operation. |
| Credit Report | The Payment report filtered to only include Credits. |
| Refund Report | The Payment report filtered to only include Refunds. |
Payment Report File Format
The following table describes the format of the Payen payment files.
| Field | Description | Data Type |
|---|---|---|
| Transaction Id | An ID representing the transaction. | Numeric - max 19 digits. |
| Entry Date | A timestamp for when the request was made. | Alphanumeric - ISO 8601 date/time format (YYYY-MM-DD hh:mm:ss). |
| Processed Date | A timestamp for when the request was processed. | Alphanumeric - ISO 8601 date/time format (YYYY-MM-DD hh:mm:ss). |
| Merchant | The assigned merchant identifer used to process the request. | Alphanumeric - max 50 chars. |
| Account | The assigned account identifier used to process the request. | Alphanumeric - max 50 chars. |
| Merchant Reference | The unique value provided by the merchant for the request. | Alphanumeric - max 29 chars. |
| Type | The type of action which has been undertaken. | Alphanumeric - Operation Type - e.g. Auth, Capture, Refund |
| Transaction Type | A value to indicate the type of transaction. | Alphanumeric - Possible values: E-Commerce (Customer Not Present), Mail Order (Customer Not Present), Telephone Order (Customer Not Present). |
| Processed Amount | Transaction value. | Numeric Decimal - max 12 digits. |
| Currency | The currency of the processed amount. | Alphanumeric - ISO 4217 3 char currency code - e.g. CAD. |
| Result | The result code of the request. | Alphanumeric - Status Code - e.g. Success, Rejected, Pending. |
| Result Message | Contains the textual representation of the result code | Alphanumeric - max 1024 chars. |
| Payment Method Type | An enumerated list of possible payment method type values | Alphanumeric - e.g. Card. |
| Auth Code | The authorisation code provided by the acquirer. | Alphanumeric - max 20chars. |
| Card Bin | The card bin used for the payment attempt. | Numeric - max 6 chars. |
| Card Last Four | The card last four used for the payment attempt. | Numeric - max 4 chars. |
| Card Type | The Card Type. | Alphanumeric - e.g. Visa Credit, Mastercard Debit. |
| Card Issuing Country | The card issuer country. | Alphanumeric - ISO 4217 3 char currency code - e.g. CAD. |
| Card Issuing Bank | The card issuer bank. | Alphanumeric - max 255 chars. |
| Card Start | Valid or start Date on the card. | Alphanumeric - format MMYYYY. |
| Card Expiry | Expiry Date on the card. | Alphanumeric - format MMYYYY. |
| Customer Id | A merchant supplied customer identifier. | Alphanumeric - max 255 chars. |
| Email Address | The email of the customer. | Alphanumeric - match to regex ^[a-zA-Z0-9._+-]{1,99}@[a-zA-Z0-9._-]{1,99}\.[\w]{2,11}$. |
| Source | The source of the request. | Alphanumeric - e.g. IP.Frame. |
| Origin | The endpoint called to make the request. | Alphanumeric - e.g. IP.Frame Capture. |
| ISO-8583 Response Code | A normalised code representing the processor response. | Alphanumeric - ISO-8583 response code. |
| AVS Address Result | Result of the AVS address check. | Alphanumeric - Possible values: Matched, Not Matched, Not Checked, Not Required. |
| AVS Post Code Result | Result of the AVS post code check. | Alphanumeric - Possible values: Matched, Not Matched, Not Checked, Not Required. |
| CVV2 Result | The result of the CVV check. | Alphanumeric - Possible values: Matched, Not Matched, Not Checked, Not Required. |
| 3D Secure Status | The overall 3-D Secure status of the transaction. | Alphanumeric - ThreeDSSecureStatus - e.g. Authentication Successful. |
| Gateway Reference | A unique value provided by the payment gateway | Alphanumeric - max 32 chars. |
| Processor Ref | The processor reference (when available). | Alphanumeric - max 32 chars. |
| External Card Token | A reusable token uniquely representing the payment instrument. | Alphanumeric - max 255 chars. |
| Caller IP | The request caller IP address | Alphanumeric - IPv4 or IPv6 format. |
| Name on Card | The card holder name, as entered by the user, and used for the payment | Alphanumeric - max 255 chars. |
| First Name | The customer's first name (permissioned) | Alphanumeric - max 255 chars. This field is only populated for merchants with extended customer information enabled. |
| Surname | The customer's last name (permissioned) | Alphanumeric - max 255 chars. This field is only populated for merchants with extended customer information enabled. |
| D.O.B. | The customer's date of Birth (permissioned) | Alphanumeric - ISO 8601 date format (YYYY-MM-DD). This field is only populated for merchants with Extended customer information enabled. |
| Mobile | The customer's mobile number (permissioned) | Alphanumeric - max 255 chars. This field is only populated for merchants with extended customer information enabled. |
| Operation Reference | Unique reference for the operation performed in response to the payment request. | Alphanumeric - max 25 chars. |
Operation Types
Transactions are composed of many types of operation. These are defined here:
| Operation Type | Description |
|---|---|
| Auth | An authorization |
| Auth Capture | A combined authorization and capture of funds |
| Bank Transfer | A bank transfer |
| Capture | A capture of funds against a prior authorization |
| Confirm | A payment confirmation |
| Payment | An alternative payment |
| Reversal | A payment reversal |
| Void | A payment void |
| Credit | A credit |
| Refund | A refund |
Result Codes
The following result codes may be generated for a transaction:
| Result Code | Description |
|---|---|
| Success | The transaction was sucessful |
| Declined | The transaction was declined |
| Rejected | The request was rejected |
| Error | An internal or external error occured |
| Timeout | A downstream service communication timeout occured |
| Cancelled | The transaction was cancelled part way through |
| CVV2 Check Failed | The CVV2 check failed |
| AVS Address Check Failed | The AVS address check failed |
| AVS Post Code Check Failed | The AVS postcode check failed |
| Informer Exception | An exception occured communicating with a downstream service |
| Pending | The operation is pending with a downstream service |
ThreeDSSecure Status
The following outcomes are possible for the ThreeDSSecure Status:
| Status Code | Description |
|---|---|
| Pending | |
| Authentication Successful | Successful authentication |
| Authentication Failed | Failed authentication |
| Not Enrolled | Card not participating / card holder not enrolled in the scheme / Issuer is not registered for VbV or SecureCode / customer not signed up, but Issuer allows customer to continue without signing up |
| Authentication Unavailable | Directory Server or ACS may return 'unavailable' status / data communication problems / unknown scheme |
| Authentication Attempted | ACS implementations may produce signed 'attempt' messages even in cases where the issuer or cardholder is not participating. |
| ACS Error | Merchant authentication in Directory Server failed / Error message received from Directory Server or ACS |
| Internal Error | An internal error occured |