Introduction

Pushpay is more than just a convenient way for you to accept payments or receive gifts and donations using mobile technology — it's a payment platform that can also integrate with your own solutions in many exciting ways.

One key way you can integrate is through our API — an Application Programming Interface that allows you to build software, or use solutions developed by third parties, that integrate with the Pushpay platform.

If you have any questions or would like further assistance, please contact us and we'll be glad to help.

API Key Features

The Pushpay API has a number of beneficial features for you as a Pushpay "merchant." These include the ability for:

Customers/donors to search and find you, using a range of criteria, including country, name, and geolocation.

Customers/donors to find out more about you and the payment features you support, including:

• Name, address & notes
• Geolocation
• The reference fields you require to be completed with payment
• The possible values for those reference fields
• Any limits (minimum/maximum value) you impose on payments
• The currencies you support
• Your logo/brand imagery

You to initiate receiving payments, gifts, or donations (what we call an "anticipated payment") from a customer/donor, track the progress of these payments through to completion, and retrieve specific transaction details, including:

• Amount
• Any values entered into reference fields by the payer
• Details of who paid (email address, mobile number, name)

You to be alerted whenever you've received new payments, and to retrieve details of those payments.

API Solutions

By combining the API features described above, some exciting options can be enabled. You can:

• Use Pushpay as a payment method for an online shopping cart or a variety of other purchase experiences you may wish to offer customers
• Be easily found by potential customers looking for organisations that can be paid using Pushpay — making it possible to combine Pushpay with other experiences such as maps
• Synchronize any payments you receive via Pushpay with other systems, such as your financial software
• Synchronize details of the payer (captured as personal details or reference fields on their payment) with other systems, such as a client relationship management (CRM) tool

Pushpay accommodates both bespoke merchant integrations (built specifically for you as the merchant) and integrations developed by third parties that might be deployed to one or multiple merchants or Pushpay users.

Developer Tools

The Pushpay API is built to be used by software developers of a variety of skill levels. Our offering includes a number of tools to make it simple for developers to get up to speed:

• Detailed documentation of all operations — including, in many cases, multiple examples of requests and responses
• MCP server for AI help reading the API documentation
• A publicly accessible sandbox environment, so developers can build and test integrations without making real transactions

Getting Started

If you plan to integrate with the Pushpay API, your first step is to contact the API Support Team — explain what you're trying to achieve, and how we can help make it a reality.

Once you're in touch, one of our development team will follow up to discuss options and guide you through the process, including:

• Providing access details for the sandbox API environment
• Explaining how to authenticate with the API
• Making suggestions on the API operations you'll need to implement your integration

Releasing Your Integration

Once you let us know you're ready to go live with your solution, you'll be issued access details for the production Pushpay platform, and you can release your integration to the world.

If your integration will be made available to multiple merchants or Pushpay users (for example, integration with a popular shopping cart solution, or a third-party CRM or financial package), contact us to discuss being listed as an Integration on the Pushpay website.

Request API Credentials to the Sandbox

Please email us at [email protected] and we'll be glad to help.