For the complete documentation index, see llms.txt. This page is also available as Markdown.

Setting up API Keys

API Fields

This article provides additional details on the various fields that must be completed when creating a new API key.

Gateway Nickname

The purpose of choosing a gateway nickname: For some gateways, this can be any value used for the user’s reference. For others, it is a required part of the API key setup and must contain the gateway account number.


Credit card Gateway

This field specifies the processing company responsible for handling the funds.


API Type

This field specifies whether you are going to process by credit cards or charity cards.

Refer to the API Type by Gateway table below for compatibility details.

Credit Cards

Includes all standard credit cards such as Visa, MasterCard, American Express etc.

Charity Cards

Charity cards are often referred to as "DAF Cards" (Donor advised fund cards).

Companies that issue these cards enable donors to contribute to charities while receiving tax deductions.

Examples of providers offering charity cards include Matbia, OJC, Donors Fund, Pledger, and OneGiv.

Before you can connect your Donary account to your charity card accounts, you must set up accounts with each charity card.


Processing Integration Key

This is a unique API key that connects your platform to a payment processor, allowing secure processing of payments or donations.

You will receive this key from your processing company. Copy and paste it into this field.


Currency

Choose the correct currency to be used for these transactions.


Country

Choose the country where the API will be used. This usually corresponds to the country selected in the Currency field.


API Type by Gateway

Each credit card gateway supports a specific set of API types. Some gateways are compatible only with credit cards, others only with charity cards, and some support both or a partial combination.

The table below clearly outlines the available API types for each credit card gateway:

Gateway
Credit Card
Charity Card

CardKnox

OJC**, Pledger, DonorsFund cards only

USAePay

OJC

OJC card

SequelPay

Stripe

Pledger

Pledger card*

Matbia

Matbia card*

DonorsFund

DonorsFund Card

PeleCard

CardCom

ACHQ

See more info here.

Banquest

Blink

Interconnect

PayArc

OneGiv

OneGiv card

NMI

*Pledger and Matbia API keys: If an API key is not set up for these charity cards, Donary can still send the payment information to the corresponding service (Pledger or Matbia) using the Tax ID to associate the payment with the correct account.

However, Donary strongly recommends using an API key whenever possible, as a Tax ID may be linked to multiple accounts, which can lead to complications.

**CardKnox - OJC API Keys: When processing charges through OJC and only a CardKnox-Credit Card API key is configured, the system automatically transmits the required OJC information to CardKnox — even without a dedicated CardKnox-OJC API key.


Credit Card Gateway Requirements

The table below clearly outlines the requirements and terminology for each gateway company:

Credit Card Gateway
Nickname
API Key
PIN

CardKnox

USAePay

OJC

**

SequelPay

Stripe

Pledger

**

Matbia

DonorsFund

*

* (Account no.)

PeleCard (IL Gateway)

CardCom (IL Gateway)

ACHQ

See more info here.

Banquest

Blink (UK Gateway)

(Signature Key)

(Gateway ID)

Interconnect

PayArc

OneGiv

NMI

*DonorsFund PIN: There is one default API key used for all DonorsFunds accounts. Please contact us with your PIN number so we can add or edit the API key.

**OJC & Pledger API Key: Donary can obtain the API key directly from these providers on your behalf— no back-and-forth required. There’s no need for you to request the key yourself or forward it to Donary. We handle the entire process for you.

Last updated

Was this helpful?