Create Payment

Creates a payment for the cashier.

Resource Information


Deprecated scope name:   create_payments

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo Indicates the language applied.7.3.2
amountDoubleNo The amount of a payment transaction or account balance.7.3.2
checkcheck{}No The payment check.
check.accountNumberstringNo The check account number.
check.bankNamestringNo The name of the bank issued on the check.
check.billingAddresscheck.billingAddress{}No The address on the check.
check.billingAddress.addressLine1stringNo The first line of the address.
check.billingAddress.addressLine2stringNo The second line of the address.
check.billingAddress.addressLine3stringNo Get All Address Unit Types The current status of the address record.
check.billingAddress.citystringNo The name of the city.
check.billingAddress.countryCodestringNo Get All Address Countries The name of the country. Required if billing address is provided.
check.billingAddress.postalCodestringNo The name of the county.
check.billingAddress.statestringNo Get All Address States The state corresponding to the address on record.
check.checkNumberstringNo The check number.
check.driverLicenseNumberstringNo The driver's license of the person or entity issuing the check.
check.emailstringNo The email address of the person or entity issuing the check.
check.firstNamestringNo The first name of the person or entity issuing the check.
check.holderNamestringNo The check holder name.
check.lastNamestringNo The last name of the person or entity issuing the check.
check.middleNamestringNo The middle name of the person or entity issuing the check.
check.phonestringNo The phone number of the person or entity issuing the check.
check.routingNumberstringNo The check routing number.
check.typestringNo The check type.
creditCardcreditCard{}No The credit card information.7.3.2
creditCard.billingAddresscreditCard.billingAddress{}No The credit card address.7.3.2
creditCard.billingAddress.addressLine1stringNo The first line of the address. 7.3.2
creditCard.billingAddress.addressLine2stringNo The second line of the address.7.3.2
creditCard.billingAddress.addressLine3stringNo Get All Address Unit Types The current status of the address record.7.3.2
creditCard.billingAddress.citystringNo The name of the city.7.3.2
creditCard.billingAddress.countryCodestringNo Get All Address Countries The name of the country. Required if billing address is provided.7.3.2
creditCard.billingAddress.postalCodestringNo The name of the county.7.3.2
creditCard.billingAddress.statestringNo Get All Address States The state corresponding to the address on record.7.3.2
creditCard.businessNamestringNo A secondary business name for the applicable individual.7.3.2
creditCard.cardNumberstringNo The credit card number.7.3.2
creditCard.cardTypestringNo The credit card type. For example, Visa, American Express, or Discover.7.3.2
creditCard.emailstringNo The contact's email address.7.3.2
creditCard.expirationMonthstringNo The 2-digit expiration month.7.3.2
creditCard.expirationYearstringNo The 4-digit expiration year.7.3.2
creditCard.holderNamestringNo The check holder's name.7.3.2
creditCard.phonestringNo The credit card holder's phone number.7.3.2
creditCard.securityCodestringNo The 3-digit security code on the back of a credit card.7.3.2
currencystringNo The standard ISO 4217 currency code. For example, "USD" for US Dollars.7.3.2
entityIdstringNo The unique ID of the entity or record.7.3.2
entityTypestringNo The type of entity.7.3.2
paymentMethodstringNoCredit Card | Check | Trust AccountThe method of payment, for example, credit card, check, trust account.7.3.2
trustAccounttrustAccount{}No Get All Trust Accounts The trust account to be used for the payment transaction.
trustAccount.accountstringNo The account ID number for the trust account.
trustAccount.acctStatusstringNoActive | CloseThe status of the trust account.
trustAccount.associationstrustAccount.associations{}No The trust account associations.
trustAccount.associations.textstringNo The localized display text.
trustAccount.associations.valuestringNo The value for the specified parameter.
trustAccount.balancedoubleNo The balance of the trust account in dollars.
trustAccount.descriptionstringNo The description of the trust account.
trustAccount.idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.
trustAccount.isPrimarystringNoY | NIndicates whether or not to designate the trust account as the primary source.
trustAccount.ledgerAccountstringNo The ledger account of the trust account.
trustAccount.overdraftstringNoY | NIndicates whether or not the trust account can use the overdraft option.
trustAccount.overdraft.textstringNo The localized display text.
trustAccount.overdraft.valuestringNo The value for the specified parameter.
trustAccount.overdraftLimitDoubleNo The overdraft limit amount, in dollars, for the trust account.
trustAccount.serviceProviderCodestringNo The unique agency identifier.
trustAccount.statusstringNoActive | ClosedThe status of the trust account.
trustAccount.status.textstringNo The localized display text.
trustAccount.status.valuestringNo The value for the specified parameter.
trustAccount.thresholdAmountDoubleNo The minimum amount required in a trust account.


Sample Request Head


Sample Request Body

  "check": {
    "billingAddress": {
      "addressLine1": "1000 Broad Street",
      "addressLine2": "1000 Broad Street2",
      "addressLine3": "1000 Broad Street3",
      "city": "New Orleans",
      "countryCode": "US",
      "postalCode": "70119",
      "state": "LA"
    "accountType": "Personal",
    "email": "",
    "phone": "(504) 654-3210",
    "checkNumber": "1001",
    "accountNumber": "786435667",
    "holderName": "Sally",
    "firstName": "FirstName",
    "lastName": "lastName",
    "middleName": "MiddleName",
    "routingNumber": "1234",
    "licenseNumber": "56780439085000",
    "bankName": "Bank of America"
  "currency": "USD",
  "amount": "10.00",
  "paymentMethod": "Check",
  "entityId": "14CAP-00000-00380",
  "entityType": "Record"

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.customIdstring 7.3.2
result.entityIdstringThe unique ID of the entity or record.
result.entityTypestringThe type of entity.
result.messagestringA text message related to the operation.7.3.2
result.paymentIdlongThe unique Id generated for a payment.7.3.2
result.transactionIdstringA unique number, assigned by the system, that indentifies the transaction.7.3.2
statusintegerThe record status.7.3.3


Sample Response Body

  "status": 200,
  "result": {
    "entityId": "14CAP-00000-00380",
    "entityType": "Record",
    "message": "Paid Success",
    "status": "Success",
    "transactionId": "322938"