Authentication

• If not yet authenticated then perform Authentication
  • Obtain access and refresh tokens and store them securely to get access to other API endpoints.

Card onboarding flow

• Use the NPO Onboarding endpoint to create a new non-profit organization entity in our system
  • Please contact [email protected] for assistance with mapping your non-profit organization data to the endpoint parameters if needed.
  • Obtain an organization ID in the response.
• Use the NonProfitCardOnboarding endpoint to enable the card donation method
  • You need to pass required data related to the NPO Merchant payment account there. Please check API Reference for exact fields you need to pass
  • Obtain the following data:
    • Merchant ID - merchant identifier in Shift4 systems
    • Merchant number - merchant additional identifier in Shift4 backend
    • API keys for Shift4 payments API https://dev.shift4.com/
• If you build custom integration: use the Shift4 payments API to perform card payments https://dev.shift4.com/
  • You can use checkout components to build your own donation form

• If you embed TGB donation form follow Embedded donation form instructions to get widget snippet code
• Webhook notification (MERCHANT_STATUS_EVENT) will be sent when onboarding will be completed and organization can start to accept card donations. See details Webhook notifications.