/contributions/payments

Records and processes a Contribution with the payment information provided in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint should only be used in circumstances when the client or vendor has the ability to ensure PCI-compliant handling of payment data for any users of these APIs. NGP VAN will ingest payment data in a manner that is PCI-compliant for NGP VAN, but will not be responsible for integrating these APIs with any client systems or external vendors.

Only requests to POST payments-api.securevan.com/contributions/payments will accept payment data in the request body, and all other domains will reject requests which appear to contain payment information.

In order to process a contribution, the paymentMethod object must include all parameters associated with the specified paymentType and the paymentType may be either CreditCard or ElectronicFundsTransfer. An amount must be between $0.01 and $999,999.99.

If a transaction is processed successfully, the endpoint responds with HTTP Status Code 201 Created and the integer ID of the created Contribution in the response body.

The Idempotency-Key header is required. This header prevents the server from processing duplicate requests. If a request's Idempotency-Key matches the Idempotency-Key of an existing completed request, the server will not process a contribution and will respond with the status code and response body of the original request, with the header Idempotent-Replayed: true. If a request's Idempotency-Key matches the Idempotency-Key of an in-progress request, the server will not process a contribution and will respond with a 409 error. Idempotency Keys are temporary, but will be remembered by the system for at least 48 hours.

Body Params
contact
object
required

The Person who contributed.

designation
object
required

The Designation which will receive funds associated with this Contribution.

int32
required
Defaults to 123456

The payment gateway which will process this Contribution.

double
required
Defaults to 12.34

Monetary amount of the Contribution. Non-positive values, and values that have more than 2 digits after the decimal point, will not be accepted. Must be between $0.01 and $999,999.99, inclusive.

paymentMethod
object
required

Payment information that will be used to process the Contribution.

codes
array of objects

An array of zero or one Codes to apply to the contribution. Contributions may not have more than one Code applied, and if a Code is applied, it must be a Source Code.

codes
generalLedgerFund
object

The associated GeneralLedgerFund object.

costCenter
object

The associated CostCenter object.

string
Defaults to Excelsior Consulting

The direct marketing code.

string
Defaults to Donated in-person at Annual Gala

A note describing the Contribution.

extendedSourceCode
object

The Extended Source Code object to apply to the Contribution. Only the extendedSoureCodeId property is required. If this is provided and no codes are provided, we’ll look for and apply a matching Source Code to the contribution from a Direct Response Plan segment that the contact is in with a contact history record that has the extended source code. If no matching source code is found, then the POST will fail.

int32
Defaults to 825

The ID of the associated Financial Batch. Required if Financial Batch Manager is enabled in the committee context; not allowed if Financial Batch Manager is disabled in the committee context. If specified, the Designation of the Financial Batch must match the Designation of the contribution.

Headers
string
required
Defaults to 00000000-0000-0000-0000-000000000123

An unique value generated by the client which the server uses to recognize subsequent retries of the same request. Can be any string at most 50 characters long - we recommend a V4 UUID. Keys are temporary and may be removed from the system after 48 hours.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json