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
langStringNoIndicates the language applied.7.3.2
amountDoubleNoThe amount of a payment transaction or account balance.7.3.2
checkcheck{}NoThe payment check.
check.accountNumberstringNoThe check account number.
check.bankNamestringNoThe name of the bank issued on the check.
check.billingAddresscheck.billingAddress{}NoThe address on the check.
check.billingAddress.addressLine1stringNoThe first line of the address.
check.billingAddress.addressLine2stringNoThe second line of the address.
check.billingAddress.addressLine3stringNo Get All Address Unit Types The current status of the address record.
check.billingAddress.citystringNoThe name of the city.
check.billingAddress.countryCodestringNo Get All Address Countries The name of the country. Required if billing address is provided.
check.billingAddress.postalCodestringNoThe name of the county.
check.billingAddress.statestringNo Get All Address States The state corresponding to the address on record.
check.checkNumberstringNoThe check number.
check.driverLicenseNumberstringNoThe driver's license of the person or entity issuing the check.
check.emailstringNoThe email address of the person or entity issuing the check.
check.firstNamestringNoThe first name of the person or entity issuing the check.
check.holderNamestringNoThe check holder name.
check.lastNamestringNoThe last name of the person or entity issuing the check.
check.middleNamestringNoThe middle name of the person or entity issuing the check.
check.phonestringNoThe phone number of the person or entity issuing the check.
check.routingNumberstringNoThe check routing number.
check.typestringNoThe check type.
creditCardcreditCard{}NoThe credit card information.7.3.2
creditCard.billingAddresscreditCard.billingAddress{}NoThe credit card address.7.3.2
creditCard.billingAddress.addressLine1stringNoThe first line of the address. 7.3.2
creditCard.billingAddress.addressLine2stringNoThe 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.citystringNoThe 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.postalCodestringNoThe 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.businessNamestringNoA secondary business name for the applicable individual.7.3.2
creditCard.cardNumberstringNoThe credit card number.7.3.2
creditCard.cardTypestringNoThe credit card type. For example, Visa, American Express, or Discover.7.3.2
creditCard.emailstringNoThe contact's email address.7.3.2
creditCard.expirationMonthstringNoThe 2-digit expiration month.7.3.2
creditCard.expirationYearstringNoThe 4-digit expiration year.7.3.2
creditCard.holderNamestringNoThe check holder's name.7.3.2
creditCard.phonestringNoThe credit card holder's phone number.7.3.2
creditCard.securityCodestringNoThe 3-digit security code on the back of a credit card.7.3.2
currencystringNoThe standard ISO 4217 currency code. For example, "USD" for US Dollars.7.3.2
entityIdstringNoThe unique ID of the entity or record.7.3.2
entityTypestringNoThe 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.accountstringNoThe account ID number for the trust account.
trustAccount.acctStatusstringNoActive | CloseThe status of the trust account.
trustAccount.associationstrustAccount.associations{}NoThe trust account associations.
trustAccount.associations.textstringNoThe localized display text.
trustAccount.associations.valuestringNoThe value for the specified parameter.
trustAccount.balancedoubleNoThe balance of the trust account in dollars.
trustAccount.descriptionstringNoThe description of the trust account.
trustAccount.idlongNoThe 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.ledgerAccountstringNoThe ledger account of the trust account.
trustAccount.overdraftstringNoY | NIndicates whether or not the trust account can use the overdraft option.
trustAccount.overdraft.textstringNoThe localized display text.
trustAccount.overdraft.valuestringNoThe value for the specified parameter.
trustAccount.overdraftLimitDoubleNoThe overdraft limit amount, in dollars, for the trust account.
trustAccount.serviceProviderCodestringNoThe unique agency identifier.
trustAccount.statusstringNoActive | ClosedThe status of the trust account.
trustAccount.status.textstringNoThe localized display text.
trustAccount.status.valuestringNoThe value for the specified parameter.
trustAccount.thresholdAmountDoubleNoThe 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
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"