/contributions/payments

post

https://api.securevan.com/v4/contributions/payments

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

contact

object

required

The Person who contributed.

designation

object

required

The Designation which will receive funds associated with this Contribution.

gatewayId

int32

required

Defaults to 123456

The payment gateway which will process this Contribution.

amount

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.

directMarketingCode

string

Defaults to Excelsior Consulting

The direct marketing code.

notes

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.

financialBatchId

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

Idempotency-Key

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

201201

400400

401401

403403

409409

500500