Sign in

v1

latestOpenAPI 3.0.12026-07-14146.5 KB
PayNow Service

Initiate IVR Payment Transaction

Use this method to initiate a new payment order for downstream processing with our payment processor. Creates an order (payment transaction) with the provided itemKey, transactionAmount, itemSku, and any additional identifying data. Returns an orderId that uniquely identifies the initiated payment.

post/payment/createOrder

Request body

itemKeystring required

This is a unique identifier for the partner who is facilitating the payment and the product for which the payment is being made. This is generated by Civitek.

transactionAmountnumber required

This is the payment amount.

itemSkustring required

This is used to pass in any identifying data for the product for which the payment is being made e.g. Citation Number for a Traffic Fine payment.

emailstring

Email of the customer making the payment. Optional.

phonestring

Phone number of the customer making the payment. Optional.

firstNamestring

First Name of the customer making the payment. Optional.

lastNamestring

Last Name of the customer making the payment. Optional.

middleNamestring

Middle Name of the customer making the payment. Optional.

companystring

Name of the company if the customer making the payment is a business. Optional

Example request

{
  "customerIdentities": [
    {
      "identityTypeId": 1,
      "countryCode": "US",
      "region": "CA"
    }
  ]
}

Response

OK

All 1 operations