NGngpvan

/contributions

Changed on

Use this endpoint to create a new contribution with the properties provided in the request body. If successful, the endpoint responds with HTTP Status Code 201 Created and the integer ID of the created Contribution in the response body. If any of the specified ids (vanId, pledgeId, codeId, or extendedSourceCodeId) are not accessible in the current context (e.g., the associated api user does not have access to the contact), the request will be considered invalid.

post/contributions

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/contributions
  • Auth
    HTTP basic

Request body

dateReceivedstring date-time required

The date and time of this contribution; must occur before the time of the API call.

amountnumber double required

The amount of the contribution. Must be between $0.01 and $999,999.99 inclusive, unless disclosure fields are enabled, in which case all positive or negative values are allowed. May not have more than 2 digits after the decimal point.

status'Pending' | 'Declined' | 'Settled' | 'Deposited' | 'InKind' required

The current status of the contribution

paymentType'Check' | 'MoneyOrder' | 'Cash' | 'CreditCard' | 'InKind' | 'Unknown' | 'ElectronicFundsTransfer' | 'ElectronicPaySystem' | 'Stock' | 'ApplyPay' | 'PaycheckDeduction' | 'WireTransfer' required

A string representing the method of payment.

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

1232123

Changes