Initialize Payment

Initializes citizen payment information for processing by a third party payment system that will send and commit final payment information into Automation. Call Initialize Payment to get the transaction ID required to call Commit Payment.

Resource Information


Deprecated scope name:   payments_initialize

App TypeCitizen
Authorization TypeAccess token
URI /V4/payments/initialize?fields={fields}&lang={lang}
Automation Version(s)

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNoComma-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.
entityIds[]stringNoAn array containing the entity ID's to initialize the payment for.
entityTypestringNorecordThe type of entity to initialize the payment for.
merchantAccountIdstringNoThe account ID of the merchant receiving the payment.
paymentMethodstringNoCredit Card | CheckThe method of payment, either Credit Card or Check.
langStringNoIndicates the language applied.

Response Information

FieldTypeDescriptionAutomation Version
result.transactionIdlongThe payment transaction ID to be processed and commited by the Commit Payment API.
statusintegerThe record status.