Citi Pay is powered in the background by FreedomPay. In order to be troubleshoot errors some important information to note.


  1. Review error logs and Sentry for potential code issues.
  2. Review the order in question, all response requests from FreedomPay are stored on the order's data JSON field for future reference.


For more information on specific errors please consult the attached Error guide but as of writing this most errors are not specific to our Citi Pay integration.


If we still need more assistance we can reach out to FreedomPay for technical support. They may request the following info: StoreID, TerminalID, RequestID, MerchantReferenceCode, as well as any other information that would be relevant. These are found on the retailer's back-end admin, their set up is documented over in the Knowledge Base.


FreedomPay tech support is an escalation path that should be reached out to only after internal tech support has determined the error originates on the gateway’s side.


Here is the point of contact for any issues that arise once:


Development and Testing


Thinkspace credentials for the development/UAT and testing, these were used during certification:


  • Client Authentication Key: D55033CE-0183-4C2F-CA01-66EF063D8EFB
  • Store ID: 1522343977
  • Terminal ID: 2525408973
  • Client ID: Cititest
  • Client Secret: 5bj8pW5GLv18nWmhWct9qFwKYFbDZj8xaDxFNYqlNJusq1OPzAOTC7fxBbQvedWv


The end points for reference and testing:


create_test_url = "https://plpayment.uat.freedompay.com/Checkout/CitiPay/CreateTransaction"
create_live_url = "https://plpayment.freedompay.com/Checkout/CitiPay/CreateTransaction"

status_test_url = "https://plpayment.uat.freedompay.com/CheckoutService/CheckoutService.svc/GetTransactionWithCAK"
status_live_url = "https://plpayment.freedompay.com/CheckoutService/CheckoutService.svc/GetTransactionWithCAK"

login_test_url = "https://ida.uat.freedompay.com/connect/token"
login_live_url = "https://ida.freedompay.com/connect/token"

payment_test_url = "https://ecomm-services.uat.freedompay.com/PaymentEstimator/CitiPay/Calculate"
payment_live_url = "https://ecomm-services.freedompay.com/PaymentEstimator/CitiPay/Calculate"


Example Request and Response


Example POST to create test transaction:


REQUEST

POST 'https://plpayment.uat.freedompay.com/Checkout/CitiPay/CreateTransaction' 

{'transaction': {'TransactionTotal': '3095.00', 'MerchantReferenceCode': '59929c36-146b-4824-9b33-350aa6a927ad', 'StoreId': '1522343977', 'TerminalId': '2525408973', 'ClientAuthenticationKey': 'D55033CE-0183-4C2F-CA01-66EF063D8EFB', 'InvoiceNumber': 14}, 'transactionType': 'citipayinstallments'}

RESPONSE

POST: 'https://plpayment.uat.freedompay.com/CheckoutService/CheckoutService.svc/GetTransactionWithCAK'

{'ChildTransactionDetails': [{'ChildTransactionDetails': None, 'TokenInformation': {'CardExpirationMonth': '12', 'CardExpirationYear': '2049', 'Token': '6035450A001IBSQFKKFSY43C9745', 'TokenExpiration': None}, 'FormattedDynExpMonth': '00', 'DateOfBirth': None, 'FreewayResponseCode': None, 'ResponseMessage': None, 'ThreeDSecureActionCode': None, 'LastPromoDescription': None, 'NameOnCard': None, 'ShippingAddress': None, 'FailedResponses': [], 'ProcessorResponseCode': None, 'StoreName': 'Goff Jewelers Inc', 'CreditApplicationInformation': None, 'DynExpMonth': None, 'OriginalRequest': {'AdditionalData': None, 'ShowAddress': False, 'DCCenabled': False, 'DynExpYear': None, 'DateOfBirth': None, 'ShippingInfoRequired': False, 'ConsumerAuthentication': None, 'DealerCustomerNumberRequired': False, 'CallbackUri': None, 'CSSID': None, 'Recurring': {'TotalInstallments': 0, 'Enabled': False, 'IndustryType': None}, 'AllowInternationalAddresses': False, 'TimeoutMinutes': 20, 'TerminalId': '2525408973', 'DynExpMonth': None, 'CustomerCode': None, 'DateOfBirthRequired': False, 'ClientMetadata': None, 'ClientAuthenticationKey': 'd55033ce-0183-4c2f-ca01-66ef063d8efb', 'AddressRequired': False, 'ShipToAddress': None, 'TransactionTotal': 3095.0, 'Fields': None, 'CurrencyCode': 'USD', 'Validations': False, 'CommerceTypeOverride': None, 'ShowEmail': None, 'CaptureMode': False, 'ParentId': 1416953, 'DynExp': None, 'LevelThreeItems': [], 'InvoiceItems': [], 'CustomerPODate': None, 'RequestToken': False, 'TaxTotal': None, 'CustomerPONumber': None, 'TokenValue': '6035450A001IBSQFKKFSY43C9745', 'TokenType': None, 'ShowPhone': None, 'InStore': False, 'MerchantReferenceCode': None, 'StoreId': '1522343977', 'DealerCustomerNumber': None, 'CultureCode': 'en-US', 'ClerkId': None, 'FraudCheckData': None, 'PurchaseItems': [], 'BillingAddress': {'City': 'HOUSTON', 'Name': 'MARIA CASTILLO', 'CountryCode': None, 'Street1': '14555 ELLA BLVD', 'Street2': 'APT 1', 'State': 'TX', 'PostalCode': '77014'}, 'InvoiceNumber': None, 'ShipFromAddress': None}, 'CheckoutTransactionId': 'f43f5775-15b5-4530-97af-46789ce48c8e', 'CardIssuer': None, 'LastPromoCode': None, 'FormattedDynExpYear': '0', 'DynExpYear': None, 'DateOfBirthRequired': False, 'AuthResponse': {'WasAuthorized': True, 'FreewayResponse': {'AuthorizationCode': '029595', 'CvvResponse': 'M', 'AvsResponse': 'Y', 'TokenInfo': None, 'AccountBalance': None, 'Amount': '3095.00', 'FreewayRequestId': '01Z6LCEB2U97U6DL27BR7333ITN10HGI', 'AccountApr': '12.99', 'AccountAprType': 'F', 'Decision': 'ACCEPT', 'ProcessorTransactionID': '029595'}, 'WasCaptured': False, 'WasVoided': False, 'DCCOptIn': False, 'DCCInfo': None, 'PayPalResponse': None, 'ResponseMessage': None, 'AuthorizationDecision': 'ACCEPT', 'BillingAddress': {'City': 'HOUSTON', 'Name': 'MARIA CASTILLO', 'CountryCode': None, 'Street1': '14555 ELLA BLVD', 'Street2': 'APT 1', 'State': 'TX', 'PostalCode': '77014'}}, 'MerchantReferenceCode': None, 'DealerCustomerNumber': None, 'CustomerEmail': None, 'MaskedCardNumber': '603545xxxxxx9745', 'PaymentType': 'Card', 'CaptureResponse': None, 'InvoiceNumber': None}], 'TokenInformation': None, 'FormattedDynExpMonth': '00', 'DateOfBirth': None, 'FreewayResponseCode': '', 'ResponseMessage': None, 'ThreeDSecureActionCode': None, 'LastPromoDescription': '', 'NameOnCard': None, 'ShippingAddress': None, 'FailedResponses': [], 'ProcessorResponseCode': '', 'StoreName': 'Goff Jewelers Inc', 'CreditApplicationInformation': {'EncPendingNbr': 'o9hRxO6j2XP4PgSRkWjcXA==', 'StatusFlag': 'A', 'TokenInformation': {'CardExpirationMonth': None, 'CardExpirationYear': None, 'Token': '6035450A001IBSQFKKFSY43C9745', 'TokenExpiration': '2027-09-28T20:00:00.0000000'}}, 'DynExpMonth': None, 'OriginalRequest': {'AdditionalData': None, 'ShowAddress': False, 'DCCenabled': False, 'DynExpYear': None, 'DateOfBirth': None, 'ShippingInfoRequired': False, 'ConsumerAuthentication': None, 'DealerCustomerNumberRequired': False, 'CallbackUri': None, 'CSSID': None, 'Recurring': {'TotalInstallments': 0, 'Enabled': False, 'IndustryType': None}, 'AllowInternationalAddresses': False, 'TimeoutMinutes': 70, 'TerminalId': '2525408973', 'DynExpMonth': None, 'CustomerCode': None, 'DateOfBirthRequired': False, 'ClientMetadata': None, 'ClientAuthenticationKey': 'd55033ce-0183-4c2f-ca01-66ef063d8efb', 'AddressRequired': False, 'ShipToAddress': None, 'TransactionTotal': 3095.0, 'Fields': None, 'CurrencyCode': 'USD', 'Validations': True, 'CommerceTypeOverride': None, 'ShowEmail': False, 'CaptureMode': False, 'ParentId': None, 'DynExp': None, 'LevelThreeItems': [], 'InvoiceItems': [], 'CustomerPODate': None, 'RequestToken': False, 'TaxTotal': None, 'CustomerPONumber': None, 'TokenValue': None, 'TokenType': None, 'ShowPhone': False, 'InStore': False, 'MerchantReferenceCode': None, 'StoreId': '1522343977', 'DealerCustomerNumber': None, 'CultureCode': 'en-US', 'ClerkId': None, 'FraudCheckData': None, 'PurchaseItems': [], 'BillingAddress': None, 'InvoiceNumber': None, 'ShipFromAddress': None}, 'CheckoutTransactionId': '61a9f3b1-d1e7-4b34-b74a-7ccc78ed3ccc', 'CardIssuer': '', 'LastPromoCode': '', 'FormattedDynExpYear': '0', 'DynExpYear': None, 'DateOfBirthRequired': False, 'AuthResponse': None, 'MerchantReferenceCode': None, 'DealerCustomerNumber': None, 'CustomerEmail': None, 'MaskedCardNumber': None, 'PaymentType': None, 'CaptureResponse': None, 'InvoiceNumber': None}


Flow Diagram