Skip to main content

American Express

AMEX Creditcard

Configure the following parameters for the Connector (see Connector Detail Overview - AmericanExpress Creditcard - Vault Configuration I & II):

  1. Enable the option Test Mode
  2. Fill in the mandatory Origin Header — provided by acquirer enrolling the MID
  3. Fill in the mandatory Country Header — provided by acquirer enrolling the MID
  4. Fill in the mandatory Region Header — provided by acquirer enrolling the MID
  5. Fill in the mandatory Routing Indicator Header for Authorization — provided by acquirer enrolling the MID
  6. Fill in the mandatory Routing Indicator Header for Submissions — provided by acquirer enrolling the MID
  7. Fill in the mandatory Submitter Code — provided by acquirer enrolling the MID
  8. Fill in the mandatory Merchant ID — provided by acquirer enrolling the MID
  9. Fill in the mandatory Merchant Terminal ID
  10. Fill in the mandatory Merchant Location ID
  11. Fill in the mandatory Merchant Contact Information
  12. Enable the option to Send Invoice Number with Captures
  13. Enable the option to Send UUID as invoice number for refunds
  14. Fill in the Acquiring Institution Code
  15. Fill in the Country code of acquiring institution (numeric) *
  16. Select the mandatory Operating Environment Mode * — Unknown (overridable by transaction), Electronic delivery (digital goods), Physical delivery
  17. Fill in the mandatory Merchant Category Code (MCC)
  18. Fill in the Payment Aggregator Seller ID
  19. Fill in the Card acceptor details:
    1. Fill in the Name
    2. Fill in the Street address
    3. Fill in the City name
    4. Fill in the Postal code
    5. Fill in the Region code
    6. Fill in the Country
    7. Fill in the Seller ID (if aggregator is used)
    8. Fill in the EMail
    9. Fill in the Phone number
  20. Fill in the Custom Authorization Endpoint URL
  21. Fill in the Token Service parameters
    1. Select the option to Enable Token Service
    2. Fill in the Client ID
    3. Fill in the Client Secret
    4. Fill in the Encryption Key
    5. Fill in the Encryption Key ID
    6. Fill in the Token Requestor ID

Force System Generated STAN

This setting is found in the Config tab (see screenshot).

Following 2 options are available:

  • Yes - Uppercase characters only
  • Yes - Upper- and lowercase characters

American Express expects a System Trace Audit Number (STAN) which must be a unique 6 character alpha numeric string used for transaction processing. Depending on the Amex account configuration the requirement may be limited to upper case characters only. In that case, the setting Yes - Uppercase characters only should be selected.

The STAN may also be provided manually in the request via the additionalId1 parameter. If done that way, the aforementioned requirements must be considered!

This setting is specifically recommended for scenarios where an additionalId1 is being sent in the request but a system generated STAN should be used for the actual transaction process. I.e. by enabling one of the two options the system will generate a STAN which will be used for the transaction process while retaining the additionalId1 for other uses.

Note: If you currently have live traffic it is highly recommended to not change this setting without testing it carefully beforehand.

Data Fetcher Configuration

You have the option to configure Data Fetchers (see section Enable and Set Up Reconciliation on the Provider Level) either on Provider or on Connector Level, depending on which setup works better for your provider

Provider Settlement

Configure the following Parameters for the Settlements Provider Data Fetcher to fetch Settlement files (txt with filename containing "GRRCN" if not overwritten with filenameRegex configuration) via an SFTP (fsgateway.americanexpress.com) (see Edit Provider Settlement Data Fetcher Provider Level):

  1. Fill in the optional Name
  2. Fill in the expected Interval in which the Provider Settlement File should be fetched - days, hours
  3. Select the Adapter AmericanExpressPci
  4. Enable Testmode - is irrelevant for this adapter
  5. Fill in the mandatory Extra Data: sftpUsername used for authentication
  6. Fill in the mandatory Extra Data: sftpPassword used for authentication
  7. Fill in the optional Extra Data: filenameRegex
  8. Fill in the optional Extra Data: grossSettlementHandling - true, false; Enables Gross Settlement handling (ignoring fees)
  9. Fill in the optional Extra Data: paymentNumberAsBatchNumber - true, false; Enables to save the payment number as batch number instead of the default value.

Reconciliation

Configure the following Parameters for the Reconciliation Data Fetcher to fetch Reconciliation files (txt with filename contains EPPRC) via SFTP (fsgateway.aexp.com) (see Reconciliation Data Fetcher Provider Level):

  1. Fill in the optional Name
  2. Fill in the expected Interval in which the Reconciliation File should be fetched - days, hours
  3. Select the Adapter AmericanExpressPci
  4. Enable Testmode — is irrelevant for this adapter
  5. Fill in the mandatory Extra Data: sftpUsername used for authentication
  6. Fill in the mandatory Extra Data: sftpPassword used for authentication
  7. Fill in the optional Extra Data: merchantId — in order to limit fetching to Merchant IDs (comma-separated)
  8. Fill in the mandatory Extra Data: currency — Currency Code (e.g. USD or EUR)

Settlement fields

Batch Number

The batch number by default is the fileDate_fileTime, it can be modified for Settlements by the configuration setting called Payment Number as Batch Number setting it to TRUE.

Payment Reference

The payment reference is mapped to amexPaymentNumber.

Mapped Fields

We are mapping the following fields from the settlement reports (AMEX →IXOPAY platform):

AMEXIXOPAY platformdefault (if not set by Provider)
amountTransaction amountNone
currencyTransaction currencyNone
arnTransaction arn, Settlement Reconciliation arnNone
referenceNumberTransaction Id, Chargeback Original Tx IdNone
fileDate-fileTimeTransaction dateNone
Date or amexPaymentNumberSettlement Batch NumberNone
cbReasonCode:cbReasonDateChargeback reversal reasonNone
cbNumberChargeback reference idNone
approvalCodeSettlement Reconciliation auth codeNone
feeAmount/discountAmountTransaction fee amountNone
paymentCurrencyTransaction fee currencyNone

Reconciliation fields

AMEXIXOPAY platformdefault (if not set by Provider)
SE_REF_POAReconciliation transaction IdNone
ROC_AMOUNTReconciliation amountNone
TRANSACTION_TIMEReconciliation transaction timeNone
TRANS_DATEReconciliation transaction dateNone
TERMINAL_IDextraData terminalIdNone
APPROVAL_CODEextraData approvalCodeNone