Configure Aptean Pay Setup

Aptean Pay  •  Article  •  3/3/2025  •  5 min

You can configure the connection between Business Central and the Aptean Pay API on the Aptean Pay Setup page for secure payment processing. Additionally, you can configure payment requests, receipt handling, and error notifications to ensure smooth transactions.

To configure Aptean Pay Setup

  1. Select the Search icon , enter Aptean pay setup, and then choose the related link.
    The Aptean Pay Setup page opens.
  2. On the General FastTab, turn off the Enabled toggle to edit the setup data.
  3. In the URL, Shared Service URL, IFrame URL, APIM Key, and Product Id fields, enter the required values. These field values vary depending on whether the current company interacts with the production environment of Aptean Pay or a staging environment for testing and training.

    The variables for these fields are provided by the Aptean support team during the setup of Aptean Pay.

  4. In the Tenant ID and Secret Key fields, enter the provided ID and key values.

    The variables for these fields are provided by the Aptean support team during the setup of Aptean Pay.

  5. In the Admin Email field, enter the email address that will receive notifications about failed API connection attempts.

    Business Central must be set up to allow outgoing emails. For more information, see Set up email.

  6. On the Payment Receipts FastTab, in the Payment Receipt Template and Payment Receipt Batch fields, select the template and batch of the cash receipt journal that will be used to accept payment receipts from Aptean Pay and post the payments to close outstanding invoices in Business Central.
    The Bal. Account Type and Bal. Account No. field values are automatically updated based on the selected cash receipt journal batch. To modify these values, update the related general journal batch.
  7. In the Refund Suffix field, enter the characters to append to the invoice number for refunds processed through Aptean Pay. For example, if you enter RF as the suffix and invoice 100056 was charged to a customer credit card, the refund would be processed with the document number 100056RF.
  8. In the Conv. Fees Bal. Account No. field (optional), specify the G/L account number or bank account number where the extra convenience fee amount will be posted based on the selection in the Bal. Account Type field.
  9. In the Convenience Fee Suffix field (optional), enter the characters to append to the invoice number to create a new document number for the convenience fee charge.
    The inclusion of convenience fees to payments depends on the Aptean Pay system configuration.
  10. On the Payment Requests and Authorizations FastTab, in the Unit of Measure field, enter a generic unit type such as Each or Box, to represent the unit sold for all payment requests.
  11. In the Product Description field, enter a generic description of the sold item.

These fields are required to provide additional transaction details for achieving lower interchange rates in credit card processing.

  1. Turn on the Immediate Capture toggle to automatically capture the payment when an Aptean Pay payment method is assigned to the sales document and the invoice is posted. Turning on the Immediate Capture toggle automatically sets the Delay in Capture field to 0D. If the Immediate Capture toggle is turned off, you can enter a value in the Delay in Capture field to control the time delay between when Aptean Pay receives the invoice and when the payment method is charged. For more details, see Pre-Authorized Payment Processing.
    The Delay in Capture field value must be between 0D and 4D.
  2. In the Currency Code field, enter USD or CAD, depending on whether you are operating in US or Canadian currency.
    Only these two options are available, and the characters must be entered exactly as stated.
    If you are setting up the environment for testing or training and are interacting with the Aptean Pay staging environment, you must configure records in the Aptean Pay Staging Data FastTab. You can enter different values in the Email and Aptean Pay Mobile No. fields to test email and SMS messages related to Aptean Pay payment requests and receipts. This helps to prevent accidental requests from being sent to real customer emails.
    The Email and Aptean Pay Mobile No. field values are checked independently and do not need to match.
  3. After configuring all the setup fields, on the General FastTab, turn on the Enabled toggle to activate Aptean Pay functionality in Business Central.
  4. (Optional) To test the Aptean Pay Setup:
  • To test the API connection between your Business Central solution and Aptean Pay, on the action bar, select Test API Connection.
    A dialog displays and indicates the result of the test.

See Also
Setup