openapi: 3.2.0
info:
title: sales-api Authonlys API
version: '1.0'
servers:
- url: https://sandboxsalesapi.connexpay.com
security:
- sec0: []
tags:
- name: Authonlys
paths:
/api/v1/authonlys:
post:
summary: Auth Only
description: The Auth Only Endpoint is applicable to acquiring clients. Call Auth Only when you want to process an Authorization only, which will not settle until it's Captured. We do not allow you to Capture an Authorization after 5 business days have passed.Calling this endpoint will authorize the card, however, it will not be settled until the [Capture endpoint](https://docs.connexpay.com/reference/capture) is called. Authorizations expire after 5 days.
operationId: auth-only
parameters:
- name: Content-Type
in: header
description: Content-Type Header
schema:
type: string
default: '"application/json"'
- name: Authorization
in: header
description: 'Token. Eg: "Bearer eHSN5rTBzqDozgAAlN1UlTMVuIT1zSiAZWCo6E..."'
schema:
type: string
default: Bearer Token
requestBody:
content:
application/json:
schema:
type: object
required:
- DeviceGuid
- Amount
- RiskData
properties:
DeviceGuid:
type: string
description: Device's Guid provided by ConnexPay.
Amount:
type: number
description: 'Amount of the transaction that will be processed. Note: this value is submitted multiple times (in different formats) within the integration to support different purposes i.e. risk analysis, merchant processing, etc. The minimum amount is: $0.50.'
format: float
SequenceNumber:
type: string
description: 'Transaction sequence number within client environment. Provide a unique SequenceNumber for each new request. If the same value is sent within 30 minutes it will be considered a duplicate request. Note: value is not searchable or reportable in ConnexPay portal. The maximum length is 100 alpha-numeric characters.'
OrderNumber:
type: string
description: 'A value that is commonly used for reporting on and reconciling your PayIns and PayOuts. The Order Number is searchable in the ConnexPay Bridge and referenced in Analytics and reporting, and can be any identifier within your environment to associate with the sale or payment, such as a Record Locator, PNR, or transaction ID. The maximum length is 50 alpha-numeric characters and allows the following special characters: [._ /- ].'
SendReceipt:
type: boolean
description: Value determines whether or not a customer shall be emailed a receipt from the ConnexPay platform if the email address is provided in the API customer block. The default value is TRUE. Set to FALSE so that an email receipt is not sent to the customer. Set to TRUE or leave empty if you want e-mail to be sent. If TRUE, customer's email must be included in the "Card.Customer.email" parameter.
StatementDescription:
type: string
description: 'US, CA, and EU clients only: The statement description allows you to customize the merchant name that appears on the cardholder''s statement for the transaction. We recommend including your DBA name along with identifying details such as a travel PNR (e.g., "ABC Travel ABC123") to help cardholders recognize the charge. Maximum length is 25 alpha-numeric characters for US clients; for CA clients, 18 alpha-numeric characters is the maximum and ConnexPay will automatically prefix the result with "CXP*"; for EU clients, 22 alpha-numeric characters is the maximum however up to 13 numeric characters may be added for phone number after the DBA name if an asterisk is used in-between the values. No spaces are allowed and the only allowed special characters are [.-*]. This functionality is not available for American Express programs.'
CustomerID:
type: string
description: 'Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the ConnexPay portal. This value may be sent in multiple times within the integration for multiple purposes. The maximum length is 100 characters and is alpha-numeric and the following special characters: [._/-].'
RiskData:
type: object
description: Mandatory if TenderType is Credit or not set. This will be ignored if TenderType is Cash or ACH.
properties:
SessionId:
type: string
description: If you are using Equifax's Device Data Collector, this would be the SessionId from that particular session. Do not include this property if not using the Device Data Collector.
Name:
type: string
description: 'This is the name of the individual making the purchase i.e. cardholder who may or may not also be the customer. This value is submitted in multiple integration points for different purposes. This value/object is specific to fraud mitigation. Note: for airline ticket purchases this value may or may not be the same as the passenger. Max = 64 characters.'
Gender:
type: string
description: Cardholder gender. "M" or "F".
DateOfBirth:
type: string
description: Cardholder date of birth
BillingPhoneNumber:
type: string
description: Phone number associated with cardholder making purchase. This could be used for risk analysis, decisioning, and rule creation. Max = 15 characters. Numbers and plus sign (+) allowed.
BillingAddress1:
type: string
description: Cardholder billing address 1. This could be used for risk analysis, decisioning, and rule creation.
BillingAddress2:
type: string
description: Cardholder billing address 2. This could be used for risk analysis, decisioning, and rule creation.
BillingCity:
type: string
description: Cardholder billing city. This could be used for risk analysis, decisioning, and rule creation.
BillingState:
type: string
description: Cardholder billing state. This could be used for risk analysis, decisioning, and rule creation.
BillingPostalCode:
type: string
description: Cardholder billing postal code. This could be used for risk analysis, decisioning, and rule creation. Max = 15 characters. Alphanumerics and "-" allowed.
BillingCountryCode:
type: string
description: Cardholder billing country code. This could be used for risk analysis, decisioning, and rule creation. Max = 2 characters.
Email:
type: string
description: Cardholder's valid email address. This could be used for risk analysis, decisioning, and rule creation.
ProductType:
type: string
description: Generalized description of the item added passed as plain text. This could be flight, tour, hotel, etc.. Each transaction submitted for risk analysis and decisioning must be submitted with one shopping cart item.
ProductDescription:
type: string
description: Attribute for a specific description of the item being purchased i.e. airline ticket. This information is general shopping cart information that describes the type of item being purchased. ConnexPay suggests clients submitted a high level description such as Flight, Hotel, Car Rental, etc... and leverage custom parameters to submit more detailed information that can be used for rule creation and transaction decisioning.
ProductItem:
type: string
description: Typically the SKU for an item passed as plain text. This information is general shopping cart information to provide secondary detail to the ProductDesc above. ConnexPay suggests clients submit a high level description such as One Way, Round Trip, Seven Nights, etc...and several customer parameters to submit more detailed information that can be used for rule creation and transaction decisioning. Alphanumeric.
ProductQuantity:
type: integer
description: Quantity of the item being purchased in the shopping cart. This is just a general quantity field.
format: int32
ProductPrice:
type: integer
description: 'Price per unit item, displayed in lowest currency factor - expressed in cents. Example: 42400 (which is $424.00).'
format: int32
OrderNumber:
type: string
description: Transaction ID within client environment associated with the order. The value is searchable and reportable in the Kount 360 portal. This value may be sent in multiple instances of the integration for multiple purposes. Customers in the travel space often send the Record Locator/PNR in this field. Max = 32 characters. Alpha-numeric characters and dashes ( - ) allowed.
SellerId:
type: string
description: Transaction ID within client environment associated with the customer. This value acts as a secondary identifier in conjunction with OrderNumber. The value is searchable and reportable in the Kount 360 portal. This value may be sent in multiple times within the integration for multiple purposes. Max = 32 characters.
FlightData:
type: object
description: Flight Data
properties:
Airline:
type: string
description: Name of airline; likely carrier code
default: AA
DepartureAirport:
type: string
description: Departure airport code
default: NY
DepartureDate:
type: string
description: 'Departure date of flight. Format: mm/dd/yyyy'
default: 06/20/1993
DestinationAirport:
type: string
description: Destination airport code
default: CA
HoursToDeparture:
type: string
description: Time in hours to flight departure
default: '5'
JourneyType:
type: string
description: Type of journey i.e. Day/Night journey
default: Day
Route:
type: string
description: The route type i.e. Direct/Indirect
default: Direct
RouteByCountry:
type: string
description: Complete flight route by country
default: NY, CA
FlightPassengers:
type: array
items:
properties:
Country:
type: string
description: Country of origin of passenger
default: USA
DateOfBirth:
type: string
description: DOB of first passenger
default: '2020-06-20'
format: date
Id:
type: string
description: Passport, drivers license or id# associated with passenger
default: JXY123
Name:
type: string
description: Passenger information. Each passenger should be sent in it's own object.
default: John Doe
type: object
CustomParameters:
type: object
description: Custom Parameters. Array.
properties: {}
Card:
type: object
description: Mandatory if TenderType is Credit or not set. Card Data. This will be ignored if TenderType is Cash and should be set to NULL or not supplied when TenderType is ACH
properties:
CardNumber:
type: string
description: 'Mandatory if Guid field is not provided. Card number. Must be 16 characters. (example: 4532538795426624) or token (example: FfL7exC7Xe2y6624)'
CardHolderName:
type: string
description: Cardholder's name. Providing information in this field allows a user of the ConnexPay portal to search for a transaction using the cardholder name
Cvv2:
type: string
description: The three or four digit CVV code at the back side of the credit and debit card. This value is required for all card-not-present processing environments
ExpirationDate:
type: string
description: Optional with Token. Card's expiry date in the YYMM format
format: date
Guid:
type: string
description: Guid is the unique identifier for a card info generated by Connexpay upon previous Sale creation. Create Sale API will accept either card info or Guid, but not both
IsRecurring:
type: boolean
description: 'Flagging a transaction as "IsRecurring": true allows a recurring sale to be submitted without a valid CVV code, which is only intended for scenarios where you might be storing card data to perform repeated payments on the same card, such as a monthly subscriptions. Typically IsRecurring can be defaulted to False.'
default: false
Customer:
type: object
description: Customer data
properties:
FirstName:
type: string
description: Mandatory for ACH Sales. Min Length = 2 Max Length = 30
LastName:
type: string
description: Mandatory for ACH Sales. Min Length = 2 Max Length = 30
Phone:
type: string
description: Customer's phone number. Phone number up to 15 characters. Numbers and plus sign (+) allowed only. 3D Secure Authentication requires a valid customer email address or phone number is included.
City:
type: string
description: Customer's City
State:
type: string
description: Customer's short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2.
Country:
type: string
description: Customer's country. The ISO country code of a customer’s country. Length = 2
Email:
type: string
description: Customer's valid email address which is available in various reports. It is critical that SendReceipt is set to FALSE so that ConnexPay does not send a receipt to the cardholder when the transaction is processed. 3D Secure Authentication requires a valid customer email address or phone number is included.
Address1:
type: string
description: 'Customer billing address 1. It is strongly recommended to send this value in a card-not-present environment such that enhanced Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction. Note: only the street number value portion of address is used for enhanced AVS check'
Address2:
type: string
description: Customer billing address 2. It is strongly recommended to send this value in a card-not-present environment such that Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction
Zip:
type: string
description: Customer billing postal code. It is strongly recommended to send this value in a card-not-present environment such that basic Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction. Only the a standard U.S. 5 digit zip code is eligible for basic AVS check. Min Length = 2 Max Length = 15. Alphanumerics and "-" allowed.
DateOfBirth:
type: string
description: 'Customer''s date of birth. Allowed format: YYYY-MM-DD. For example: 2002-05-30'
format: date
DriversLicenseNumber:
type: integer
description: Customer's driver license number. Only letters, numbers and a hyphen is allowed
format: int32
DriversLicenseState:
type: string
description: Mandatory when DriverLicenseNumber is provided. Customer's driver license short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2
SSN4:
type: integer
description: Last 4 of Customer's Social Security Number
format: int32
ThreeDS:
type: object
description: 'ThreeDS object is required when 3DS authentication parameters are being passed in the Sale or Auth. For US clients: the parameters are identified using the 3DS Authentication endpoint. For EU clients: the parameters are identified when a cardholder challenge and/or fingerprint authentication is required after calling the Create Sale or Auth Only endpoint with the BrowserData object details.'
properties:
SecureCode:
type: string
Cavv:
type: string
description: Cardholder authentication verification value
Version:
type: string
description: Version of 3DS being used
DirectoryServerTransactionID:
type: string
description: Unique identifier provided by the card scheme as part of 3D Secure authentication.
AcsTransactionId:
type: string
description: Unique Identifier provided by the Access Control Server of the Card Issuer.
ECI:
type: string
description: Displays the Electronic Commerce Indicator (ECI). The ECI indicates the security level of the payment information provided to the merchant. A value of 0, 1 or 2 is a Mastercard transaction. A value of 5, 6 or 7 is a Visa, American Express, Diners or Discover card.
BankAccount:
type: object
description: Mandatory if TenderType is ACH. Bank Account. This will be ignored if TenderType is Cash or Credit
required:
- AccountType
- RoutingNumber
- AccountNumber
- NameOnAccount
properties:
AccountType:
type: string
description: 'Accepted account types are: Saving or Checking'
RoutingNumber:
type: string
description: 9 Digit routing number
AccountNumber:
type: string
description: Account number up to 20 characters
NameOnAccount:
type: string
description: Name on the account for ACH transfer (upto 50 characters)
AccountAndRoutingNumberToken:
type: string
description: Encrypted Token previously assigned to Bank Account. Either AccountAndRoutingNumberToken or both AccountNumber and RoutingNumber should be provided.
Customer:
type: object
properties:
FirstName:
type: string
description: Mandatory for ACH Sales. Min Length = 2 Max Length = 30
LastName:
type: string
description: Mandatory for ACH Sales. Min Length = 2 Max Length = 30
Phone:
type: string
description: Customer's phone number. Phone number up to 15 characters. Numbers and plus sign (+) allowed only. 3D Secure Authentication requires a valid customer email address or phone number is included.
City:
type: string
description: Customer's City
State:
type: string
description: Customer's short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2.
Country:
type: string
description: Customer's country. The ISO country code of a customer’s country. Length = 2
Email:
type: string
description: Customer's valid email address which is available in various reports. It is critical that SendReceipt is set to FALSE so that ConnexPay does not send a receipt to the cardholder when the transaction is processed. 3D Secure Authentication requires a valid customer email address or phone number is included.
Address1:
type: string
description: 'Customer billing address 1. It is strongly recommended to send this value in a card-not-present environment such that enhanced Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction. Note: only the street number value portion of address is used for enhanced AVS check'
Address2:
type: string
description: Customer billing address 2. It is strongly recommended to send this value in a card-not-present environment such that Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction
Zip:
type: string
description: Customer billing postal code. It is strongly recommended to send this value in a card-not-present environment such that basic Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction. Only the a standard U.S. 5 digit zip code is eligible for basic AVS check. Min Length = 2 Max Length = 15. Alphanumerics and "-" allowed.
DateOfBirth:
type: string
description: 'Customer''s date of birth. Allowed format: YYYY-MM-DD. For example: 2002-05-30'
format: date
DriversLicenseNumber:
type: integer
description: Customer's driver license number. Only letters, numbers and a hyphen is allowed
format: int32
DriversLicenseState:
type: string
description: Mandatory when DriverLicenseNumber is provided. Customer's driver license short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2
SSN4:
type: integer
description: Last 4 of Customer's Social Security Number
format: int32
Customer:
type: object
description: Customer Data. This will only be used if TenderType is not Credit
properties:
FirstName:
type: string
description: Mandatory for ACH Sales. Min Length = 2 Max Length = 30
LastName:
type: string
description: Mandatory for ACH Sales. Min Length = 2 Max Length = 30
Phone:
type: string
description: Customer's phone number. Phone number up to 15 characters. Numbers and plus sign (+) allowed only. 3D Secure Authentication requires a valid customer email address or phone number is included.
City:
type: string
description: Customer's City
State:
type: string
description: Customer's short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2.
Country:
type: string
description: Customer's country. The ISO country code of a customer’s country. Length = 2
Email:
type: string
description: Customer's valid email address which is available in various reports. It is critical that SendReceipt is set to FALSE so that ConnexPay does not send a receipt to the cardholder when the transaction is processed. 3D Secure Authentication requires a valid customer email address or phone number is included.
Address1:
type: string
description: 'Customer billing address 1. It is strongly recommended to send this value in a card-not-present environment such that enhanced Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction. Note: only the street number value portion of address is used for enhanced AVS check'
Address2:
type: string
description: Customer billing address 2. It is strongly recommended to send this value in a card-not-present environment such that Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction
Zip:
type: string
description: Customer billing postal code. It is strongly recommended to send this value in a card-not-present environment such that basic Address Validation (AVS) can be performed on transaction and the lowest possible interchange is received on transaction. Only the a standard U.S. 5 digit zip code is eligible for basic AVS check. Min Length = 2 Max Length = 15. Alphanumerics and "-" allowed.
DateOfBirth:
type: string
description: 'Customer''s date of birth. Allowed format: YYYY-MM-DD. For example: 2002-05-30'
format: date
DriversLicenseNumber:
type: integer
description: Customer's driver license number. Only letters, numbers and a hyphen is allowed
format: int32
DriversLicenseState:
type: string
description: Mandatory when DriverLicenseNumber is provided. Customer's driver license short name state. The ISO 3166-2 CA and US state or province code of a customer. Length = 2
SSN4:
type: integer
description: Last 4 of Customer's Social Security Number
format: int32
EnhancedData:
type: object
description: Enhanced Level 2 and Level 3 card data is a set of additional information for business, commercial, corporate, purchasing, and government cardholders.
properties:
SaleTax:
type: string
description: Sales Tax amount
AssociationID:
type: string
description: 'Utilize the Association ID field to tie a virtual card to a sale or sales. For example, if you have several sales and one virtual card payment to a supplier, you can add association ID to the sales and the virtual card for downstream reporting. The maximum length is 100 characters and is alpha-numeric and the following special characters: [._/-].'
BrowserData:
type: object
description: 3D secure parameters required to be submitted with Auth Only request to initiate 3D secure authentication via ConnexPay's interface. A signed contract for 3D Secure is required in order to use this feature.
required:
- AcceptanceHeader
- ColorDepth
- JavaEnabled
- ScreenHeight
- ScreenWidth
- TimeZoneOffset
- Language
- RedirectURL
- UserAgentHeader
properties:
AcceptanceHeader:
type: string
description: Required. Exact content of the http accept header.
ColorDepth:
type: integer
description: Required. Value representing the bit depth of the color palette for displaying images, in bits per pixel.
format: int32
JavaEnabled:
type: boolean
description: True or False response that represents ability of cardholder browser to execute Java
ScreenHeight:
type: integer
description: Total height of the Cardholder's screen in pixels
format: int32
ScreenWidth:
type: integer
description: Total width of the Cardholder's screen in pixels
format: int32
TimeZoneOffset:
type: integer
description: Time Zone difference between browser time zone and UTC time, in hours. Can be positive or negative.
format: int32
Language:
type: string
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/connexpay/refs/heads/main/openapi/connexpay-authonlys-api-openapi.yml