Create and Allocate Payment Transaction

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

Overview

Creates a payment member transaction on a policy and automatically allocates the payment against outstanding invoices. The returned RecordID is the new MemberTransactionID.

Path Params
integer
required

The ID of the policy that the payment will be applied to.

Query Params
double
required

The payment amount.

date-time

The date of the payment. Defaults to today if omitted.

Use ISO 8601 (YYYY-MM-DD) formatted values.

Body Params
json
required
Defaults to {}

The request body is a JSON representation of the MemberTransaction dataDictionary.

See the API reference for api/MetaData/Domains/{domain}/DataDictionary where MemberTransaction is the {domain} value.

If a key is unrecognized, the API throws InvalidOperationException("Unknown field: {key}").

Common fields to include:

FieldTypeDescription
MemostringNotes or memo for the payment
PaymentCheckNumberstringCheck number if paying by check
PaymentReferenceNumberstringExternal payment reference number
PaymentTypestringPayment type code (e.g., check, EFT)
BillingNamestringName on the billing record
BillingAddress1stringBilling address line 1
BillingAddress2stringBilling address line 2
BillingCitystringBilling city
BillingStateIDintBilling state ID
BillingPostalCodestringBilling postal code
BillingEmailstringBilling email address

The following fields are set automatically and should not be included in the request body:

FieldValue
TypeP (Payment)
TransactionDateFrom the paymentDate parameter (or today)
PaidAmountFrom the paymentAmount parameter
MemberIDFrom the policy record
PolicyIDFrom the URL path
Response

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