API Reference

Getting Started

Information needed for portal setup

To get started, we'll need to configure your white-labeled Payment Portal.

The Payment Portal is a secure dashboard merchants can access to view or edit account details, review recent transactions, and more. Internally you'll also use it to create and manage merchant accounts, edit rates, add branding, enable/disable feature flags, and simulate transactions using our API Tester.

More information on how to use the payment portal can be found here:
https://notion.so/quilt-payfac/Payment-Portal-Administrator-View-46362a9dbb7443cc833ae668f76d09f0

To configure your white labeled payment portal, email or slack the following items to Ty Clement at [email protected]:

  • Your company name.
  • URL for your payment portal. This will be something like payment.<your_company_domain>.com. Keep in mind, this will be used by your merchants and should following your branding guidelines.
  • CNAME DNS entry for SSL validation (we will provide details, when your portal is about ready)
  • TXT DNS entry for SPF so we can send emails for things like forgot password, etc. (we will provide details, when your portal is about ready)

Note: You can create additional users for your Development and Product team by going to the Payment Portal and navigating to Administrative > Manage Team.

Receive test terminals & cards

Depending on your configuration requirements, we support two different terminals with our PayFac. To receive test units and test cards please contact Ty Clement at [email protected]: for more information.

Glossary

The documentation below references terms such as CP, CNP, tokenization, and more. If you're not familiar with this terminology or need a refresher, you can reference the guide below:
https://www.notion.so/quilt-payfac/Glossary-d6b69e83a1b842b1abafeaff2edc78da

API access and testing

Once the payment portal is setup, your payment portal URL will be your URL for API requests. We will provide you with an API key and and company Id. These well be required for making API requests. JWT used to validate requests and you can read more about that next.