Sign in

v1

latestOpenAPI 3.1.02026-07-2432063.2 KB

/contributions/payments

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

post/contributions/payments

Headers

Idempotency-Keystring required

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.

Request body

gatewayIdinteger required

The payment gateway which will process this Contribution.

amountnumber double required

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.

directMarketingCodestring

The direct marketing code.

notesstring

A note describing the Contribution.

financialBatchIdinteger

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.

Response

201

integer required

Example response

12345