---
title: "Initiate IVR Payment Transaction"
method: POST
path: "/payment/ivr"
tags: ["Payment Service"]
---

# Initiate IVR Payment Transaction

`POST /payment/ivr`

This method is used to initiate child support payments via our payment processing service. It will accept a payment request that contains the type of payment, payment amount and any other identifying data. A new payment transaction will be initiated in the system with a unique Order Id. The method will return the Order Id.

## Request body

- IVRRequest
  - `stateCode` string, required — State code is required (e.g., FL).
  - `ssn` string, required — SSN is requried.
  - `caseNumber` string, required — Case or Account Number is required.
  - `firstName` string, required — First name of the non-custodial parent is required.
  - `lastName` string, required — Last name of the non-custodial parent is required.
  - `amount` number, required — Child Support Payment Amount. Rquired.
  - `customer` IVRCustomer, required
    - `firstName` string, required — First Name of the customer making the payment. Optional.
    - `lastName` string, required — Last Name of the customer making the payment. Optional.
    - `middleName` string — Middle Name of the customer making the payment. Optional.
    - `phone` string, required — Phone number of the customer making the payment. Optional.
    - `email` string — Email of the customer making the payment. Optional.
    - `identities` CustomerIdentity[] — For payments greater than or equal to $3000.00 additional information is required. Submit two types with pertinent details.
      - `identityTypeId` integer — Valid values: 1=SSN, 2=Passport, 4=Alien Registration Number for Identity One; 0=Other, 3=Driver’s License for Identity Two
      - `value` string
      - `countryCode` string — Country code
      - `region` string — Region/state code

## Response `200`

OK

---

[API](https://skmtc.net/civikestpayment/apis/paykidz-child-support-api-specifications.md) · [All operations](https://skmtc.net/civikestpayment/apis/paykidz-child-support-api-specifications/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/civikestpayment/paykidz-child-support-api-specifications/revisions/8b0cae7c1584/schema)