Get Record Payment

Gets information about the specified payment for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   get_record_payment

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/payments/{paymentId}?lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
paymentIdstringYes The unique Id generated for a payment.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.amountdoubleThe amount of a payment transaction or account balance.7.3.2
result.amountNotAllocateddoubleThe payment amount which has not been allocated.7.3.2
result.cashierIdstringThe unique ID associated with the cashier.7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.paymentDatedateTimeThe date a payment was entered into the system.7.3.2
result.paymentMethodstringDescribes the method of payment, for example; credit card, cash, debit card, and so forth.7.3.2
result.paymentStatusstringIndicates whether or not a payment has been made in full.7.3.2
result.receiptIdlongThe unique ID generated for the recipient.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
result.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.recordId.valuestringThe value for the specified parameter.7.3.2
result.transactionCodestringAn industry standard code that identifies the type of transaction.7.3.2
result.transactionIdlongA unique number, assigned by the system, that indentifies the transaction.7.3.2
statusintegerThe record status.7.3.3