# Claim PaymentBatch

This data model facilitates transactions between providers and payers. We support submitting claims and sending payment notifications in batches.

Typically, the claims workflow kicks off with providers grouping (i.e., batching) and sending claims to payers with details about services rendered to a patient and a request for payment. After processing the claims, payers send batched payment notifications to the provider with a status of whether the payment request was accepted or denied. In some cases, the status may indicate that a third party transferred funds to the provider.

This data model has event types that allow you to:

- submit a batch of claims; or
- sent a batch of payment notifications.

> **Claim vs. Financial data model**
>
> `Claim` is generally a summary of patient care that’s sent or received after an inpatient admission or outpatient encounter is concluded. 
>
> `Financial` is for handling financial charges on the fly during a patient’s care.

Send a batch of payment notifications or statuses to a provider. 

A status may confirm whether funds were transferred from a third party to the provider or if a payment request was denied.

A batch message contains multiple payment notifications for multiple claims.

Status: Developer preview

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Claim |
| `Meta.EventType` | string | Yes | PaymentBatch |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional. *UUID* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination. *Required when sending data to Redox.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference. *UUID* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | Code for the facility related to the message. *Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.* |
| `Transactions` | Array of object | No |  |
| `Transactions[].ID` | string or null | No | ID used by submitter to reference this Claims |
| `Transactions[].IDType` | string or null | No | Type of ID |
| `Transactions[].Type` | string or null | No | The type of Claims, Institutional or Professional. Value set 91c5ff8a-778a-431e-981a-7a0dc10c5248: Institutional, Professional |
| `Transactions[].TotalPaymentAmount` | string or null | No | The total amount of all of the payments listed in the Payments array. *Redox recommends sending it as an additional layer of validation.* |
| `Transactions[].CreditOrDebit` | string or null | No | A flag indicating whether the monetary amount in Transaction.TotalPaymentAmount is a credit or debit. Value set 18d8863d-6ede-4014-a2bf-14a7f130796e: Credit, Debt |
| `Transactions[].PaymentMethod` | string or null | No | How the payment was/will be transferred. Value set 576c604f-4b58-48e4-926e-940bc3d6384f: Check, ACH, Non-Payment |
| `Transactions[].PaymentDateTime` | string or null | No | When the transaction should be processed by the destination. *For example, if the "Check" is used in Transaction.PaymentMethod this would be the date on the check.  [ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].TrackingNumber` | string or null | No | A number used to by the Payer to trace the payment. *For example, if the "Check" is used in Transaction.PaymentMethod this would be the check number.* |
| `Transactions[].Submitter` | object | No | Submitter of a Claims |
| `Transactions[].Submitter.Identifiers` | Array of object | No | List of IDs and ID Types that identify the concept |
| `Transactions[].Submitter.Identifiers[].ID` | string or null | No | ID for the submitter |
| `Transactions[].Submitter.Identifiers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Submitter.Name` | string or null | No |  |
| `Transactions[].Submitter.Address` | object | No | Address of the Submitter |
| `Transactions[].Submitter.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Submitter.Address.City` | string or null | No | City |
| `Transactions[].Submitter.Address.State` | string or null | No | State |
| `Transactions[].Submitter.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Submitter.Address.County` | string or null | No | County |
| `Transactions[].Submitter.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Transactions[].Submitter.EmailAddress` | string or null | No |  |
| `Transactions[].Submitter.PhoneNumber` | object | No |  |
| `Transactions[].Submitter.PhoneNumber.Office` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Submitter.PhoneNumber.Fax` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Receiver` | object | No | Receiver of a Claims |
| `Transactions[].Receiver.Identifiers` | Array of object | No | List of IDs and ID Types that identify the concept |
| `Transactions[].Receiver.Identifiers[].ID` | string or null | No | ID for the receiver |
| `Transactions[].Receiver.Identifiers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Receiver.Name` | string or null | No |  |
| `Transactions[].Receiver.Address` | object | No | Address of the Receiver |
| `Transactions[].Receiver.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Receiver.Address.City` | string or null | No | City |
| `Transactions[].Receiver.Address.State` | string or null | No | State |
| `Transactions[].Receiver.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Receiver.Address.County` | string or null | No | County |
| `Transactions[].Receiver.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Transactions[].Receiver.EmailAddress` | string or null | No |  |
| `Transactions[].Receiver.PhoneNumber` | object | No |  |
| `Transactions[].Receiver.PhoneNumber.Office` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Receiver.PhoneNumber.Fax` | string or null | No | *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Payments` | Array of object | No |  |
| `Transactions[].Payments[].DateTime` | string or null | No | The DateTime this payment was processed. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Patient` | object | No |  |
| `Transactions[].Payments[].Patient.Identifiers` | Array of object | No | List of IDs and ID types that identify the patient |
| `Transactions[].Payments[].Patient.Identifiers[].ID` | string or null | No | ID for the patient |
| `Transactions[].Payments[].Patient.Identifiers[].IDType` | string or null | No | Type of ID. *E.g. MRN, EPI* |
| `Transactions[].Payments[].Patient.Demographics` | object | No |  |
| `Transactions[].Payments[].Patient.Demographics.FirstName` | string or null | No | Patient's first name |
| `Transactions[].Payments[].Patient.Demographics.MiddleName` | string or null | No | Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field. |
| `Transactions[].Payments[].Patient.Demographics.LastName` | string or null | No | Patient's last name |
| `Transactions[].Payments[].Patient.Demographics.DOB` | string or null | No | Patient's date of birth. *In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Patient.Demographics.SSN` | string or null | No | Patient's social security number |
| `Transactions[].Payments[].Patient.Demographics.Sex` | string or null | No | Patient's sex. Value set ca03256a-4fd3-4b3d-8e37-912cd22b5cda: Female, Male, Unknown, Other, Nonbinary, Prefer not to answer |
| `Transactions[].Payments[].Patient.Demographics.Race` | string or null | No | Patient's race. Value set 2d9b5abe-e939-4c55-b8e5-a2816ecb08eb: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, Other Race, White, Unknown, Prefer not to answer |
| `Transactions[].Payments[].Patient.Demographics.IsHispanic` | boolean or null | No | Indicates if the patient is of hispanic origin. Value set 731a7062-165a-434c-bef7-b02b824dfc7b: true, false, null |
| `Transactions[].Payments[].Patient.Demographics.Religion` | string or null | No | Patient's religious affiliation. Value set 11a5dd99-3549-484c-ba0a-1b22723e9a45: Latter Day Saints, Lutheran, Mahayana, Meditation, Messianic Judaism, Mitraism, New Age, non-Roman Catholic, Occult, Adventist, African Religions, Afro-Caribbean Religions, Agnosticism, Anglican, Animism, Atheism, Babi & Baha'I faiths, Baptist, Bon, Cao Dai, Celticism, Christian, Confucianism, Cyberculture Religions, Divination, Fourth Way, Free Daism, Gnosis, Hinduism, Humanism, Independent, Islam, Jainism, Jehovah's Witnesses, Judaism, Orthodox, Paganism, Pentecostal, Reformed/Presbyterian, Roman Catholic Church, Satanism, Scientology, Shamanism, Shiite (Islam), Shinto, Sikism, Spiritualism, Sunni (Islam), Taoism, Theravada, Unitarian-Universalism, Universal Life Church, Vajrayana (Tibetan), Veda, Voodoo, Wicca, Yaohushua, Zen Buddhism, Zoroastrianism, Assembly of God, Brethren, Christian Scientist, Church of Christ, Church of God, Congregational, Disciples of Christ, Eastern Orthodox, Episcopalian, Evangelical Covenant, Friends, Full Gospel, Methodist, Native American, Nazarene, Presbyterian, Protestant, Reformed, Salvation Army, Unitarian Universalist, United Church of Christ, Protestant - No Denomination, The Process, None, Other, Unknown |
| `Transactions[].Payments[].Patient.Demographics.MaritalStatus` | string or null | No | Patient's marital status. Value set f3f48779-ee0c-4477-b458-d8cba9303039: Separated, Unmarried, Common law, Divorced, Legally Separated, Living together, Interlocutory, Married, Annulled, Other, Domestic partner, Registered domestic partner, Single, Unreported, Unknown, Widowed, Polygamous, Never Married |
| `Transactions[].Payments[].Patient.Demographics.IsDeceased` | boolean or null | No | Indicates if the patient is deceased |
| `Transactions[].Payments[].Patient.Demographics.DeathDateTime` | string or null | No | Date and Time the patient was proclaimed deceased. *[ISO 8601 Format](https://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Patient.Demographics.PhoneNumber` | object | No |  |
| `Transactions[].Payments[].Patient.Demographics.PhoneNumber.Home` | string or null | No | Patient's home phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Payments[].Patient.Demographics.PhoneNumber.Office` | string or null | No | Patient's office phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Payments[].Patient.Demographics.PhoneNumber.Mobile` | string or null | No | Patient's mobile phone number. *In E. 164 Format. (e.g. +16085551234)* |
| `Transactions[].Payments[].Patient.Demographics.EmailAddresses` | Array of string | No | Patient's email address(es) |
| `Transactions[].Payments[].Patient.Demographics.Language` | string or null | No | Patient's primary spoken language. *In ISO 639-1 alpha values (e.g. 'en'). [Supported Values](http://www.loc.gov/standards/iso639-2/php/code_list.php)* Value set 7eeaad13-6761-41f0-ab43-5be92809afc2: af, ae, ak, bg, bh, ca, ce, ch, co, cr, cs, cu, cv, da, dz, ee, en, eo, et, eu, ff, gl, ha, hr, ii, is, lu, kk, kn, ku, kv, kw, mk, ms, nb, nd, pi, sk, om, qu, sn, sq, su, ta, ti, tk, uk, wo, yo, id, ig, jv, kj, km, ln, lo, mr, mt, na, ng, no, oj, pt, rm, rw, sg, st, sw, th, tr, tt, ur, vo, zh, aa, de, fi, ht, hy, ie, ik, ki, kl, ko, kr, ks, ky, lv, mg, mi, ml, my, ne, nl, ny, oc, os, pa, pl, ps, rn, sc, sd, si, sl, so, sr, sv, tg, tl, tn, to, tw, ty, ug, ve, vi, wa, za, es, fa, gn, hu, hz, ia, la, lt, mh, mn, nn, nr, nv, or, ro, sa, se, ss, te, ts, uz, xh, yi, zu, Other, Unknown, ab, av, ba, sgn, am, an, ay, ar, as, az, be, bi, bm, bn, bo, br, bs, cy, dv, el, fj, fo, fr, fy, ga, gd, gu, gv, he, hi, ho, io, it, iu, ja, ka, kg, lb, lg, li, ru, sm |
| `Transactions[].Payments[].Patient.Demographics.Citizenship` | Array of string | No | Patient's nation(s) of citizenship. *In ISO 3166 alpha 2 format (e.g. 'US').* Value set 232b1e77-fd16-4f4c-838f-0d288c119806: American Samoa, Anguilla, Austria, Bahamas, Barbados, Bhutan, Bosnia and Herzegovina, Afghanistan, Åland Islands, Albania, Angola, Andorra, Argentina, Armenia, Bangladesh, Belgium, Benin, Bonaire Sint Eustatius and Saba, Botswana, Bouvet Island, British Indian Ocean Territory, Brunei Darussalam, Burkina Faso, Bulgaria, Algeria, Antarctica, Antigua and Barbuda, Aruba, Australia, Azerbaijan, Bahrain, Belarus, Belize, Bermuda, Bolivia (Plurinational State of), Brazil, Burundi, Cayman Islands, China, Colombia, Cook Islands, Curaçao, El Salvador, Cambodia, Christmas Island, Congo (the Democratic Republic of the), Croatia, Czechia, Dominica, Cabo Verde, Chad, Cocos (Keeling) Islands, Costa Rica, Denmark, Dominican Republic, Cameroon, Chile, Congo, Cyprus, Ecuador, Canada, Central African Republic, Comoros, Cuba, Djibouti, Egypt, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands[Malvinas], Faroe Islands, Fiji, Finland, France, French Guiana, French Polynesia, French Southern Territories, Gabon, Gambia, Georgia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guernsey, Guinea, Guinea-Bissau, Guyana, Haiti, Heard Island and McDonald Islands, Holy See, Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran (Islamic Republic of), Iraq, Ireland, Isle of Man, Israel, Italy, Jamaica, Japan, Jersey, Jordan, Kazakhstan, Kenya, Kiribati, Korea (the Republic of), Kuwait, Kyrgyzstan, Liechtenstein, Madagascar, Mali, Mauritius, Monaco, Mozambique, Netherlands, Niger, Lao Peoples Democratic Republic, Latvia, Lesotho, Macao, Malta, Mayotte, Moldova (the Republic of), Myanmar, Nigeria, Oman, Lebanon, Lithuania, Malawi, Maldives, Mauritania, Mongolia, Morocco, Nepal, Nicaragua, Northern Mariana Islands, Liberia, Luxembourg, Malaysia, Martinique, Micronesia (Federated States of), Montserrat, Nauru, New Zealand, Norfolk Island, Libya, Macedonia (the former Yugoslav Republic of), Marshall Islands, Mexico, Montenegro, Namibia, New Caledonia, Niue, Norway, Pakistan, Palau, Palestine State of, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn, Poland, Portugal, Qatar, Puerto Rico, Réunion, Romania, Russian Federation, Rwanda, Saint Barthélemy, Saint Helena Ascension and Tristan da Cunha, Saint Kitts and Nevis, Saint Lucia, Saint Martin (French part), Saint Pierre and Miquelon, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Sint Maarten (Dutch part), Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Georgia and the South Sandwich Islands, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Svalbard and Jan Mayen, Swaziland, Sweden, Switzerland, Syrian Arab Republic, Tajikistan, Taiwan (Province of China), Timor-Leste, Trinidad and Tobago, Tuvalu, Uruguay, Virgin Islands (U.S.), Yemen, Tanzania United Republic of, Turkey, Ukraine, United States of America, Viet Nam, Western Sahara*, Thailand, Tonga, Turks and Caicos Islands, United States Minor Outlying Islands, Venezuela (Bolivarian Republic of), Zimbabwe, Togo, Tunisia, Uganda, United Arab Emirates, Uzbekistan, Virgin Islands (British), Zambia, Tokelau, Turkmenistan, United Kingdom of Great Britain and Northern Ireland, Vanuatu, Wallis and Futuna, Côte dIvoire, Korea (the Democratic Peoples Republic of), Unknown |
| `Transactions[].Payments[].Patient.Demographics.Address` | object | No | Patient's home address |
| `Transactions[].Payments[].Patient.Demographics.Address.StreetAddress` | string or null | No | Street address |
| `Transactions[].Payments[].Patient.Demographics.Address.City` | string or null | No | City |
| `Transactions[].Payments[].Patient.Demographics.Address.State` | string or null | No | State |
| `Transactions[].Payments[].Patient.Demographics.Address.ZIP` | string or null | No | ZIP |
| `Transactions[].Payments[].Patient.Demographics.Address.County` | string or null | No | County |
| `Transactions[].Payments[].Patient.Demographics.Address.Country` | string or null | No | Country. Value set 39791e31-0cee-4c58-a6c1-3d9e2c71d13b: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, IO, CM, CL, CO, CI, DK, EC, ER, FK, TF, GM, GI, GW, VA, IS, IM, JP, KI, LS, LT, MK, MV, MX, MS, NA, NC, MP, PK, PG, PL, RU, PM, SA, SG, SB, SS, SE, TZ, TO, TV, US, VN, EH, ZW, BQ, BR, BF, CA, TD, KM, CK, CU, DO, EE, FI, GE, GL, GN, GY, IN, IE, JE, KW, LB, LY, MO, ML, MR, MN, MM, NZ, NU, OM, PY, PT, RO, KN, SN, RS, ZA, LK, SJ, SY, TK, TM, UG, UM, UZ, WF, BA, BG, CV, CX, CD, CW, DJ, GQ, FO, PF, DE, GD, GG, HT, HK, IR, IL, KE, KG, LU, MY, MT, MU, ME, MZ, NP, NF, PW, PH, QA, BL, MF, ST, SX, SI, GS, SR, TJ, TG, TN, UA, VU, VG, BW, BN, KH, KY, CC, CR, CY, EG, FJ, FR, GH, GP, GU, HN, IQ, JM, KZ, KP, LA, LR, MW, MH, YT, MD, MA, NI, NG, NO, PA, PN, RE, RW, LC, SM, SC, SK, ES, CH, TH, TT, TR, GB, VE, VI, ZM, BV, BI, CF, CN, CG, HR, CZ, DM, SV, ET, GF, GA, GR, GT, HM, HU, ID, IT, JO, KR, LV, LI, MG, MQ, FM, MC, NR, NL, NE, PS, PE, PR, SH, VC, WS, SL, SO, SD, SZ, TW, TL, TC, AE, UY, YE, DR |
| `Transactions[].Payments[].Patient.Notes` | Array of string | No | Patient-level notes |
| `Transactions[].Payments[].Claims` | Array of object | No |  |
| `Transactions[].Payments[].Claims[].ControlNumber` | string or null | No | The Payer's reference number |
| `Transactions[].Payments[].Claims[].SubmissionNumber` | string or null | No | This will generally be the claim number sent on the initial claim submission. |
| `Transactions[].Payments[].Claims[].ReceivedDate` | string or null | No | Date the claim was submitted. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Claims[].StartDateTime` | string or null | No | Date the statement period started. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Claims[].EndDateTime` | string or null | No | Date the statement period ended. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Claims[].Status` | string or null | No | Status of the claim. Value set d6e064d4-3a0b-42bd-ab48-95ff56d5137e: Processed as Primary, Not Our Claim, Predetermination Pricing Only, Processed as Secondary, Forwarded to Additional Payers, Denied, Processed as Secondary, Processed as Tertiary, Reversal of Previous Payment, Processed as Primary, Forwarded to Additional Payers, Processed as Tertiary, Forwarded to Additional Payers |
| `Transactions[].Payments[].Claims[].ChargedAmount` | string or null | No | Total monetary amount of the claim |
| `Transactions[].Payments[].Claims[].PaymentAmount` | string or null | No | Monetary amount of the claim paid |
| `Transactions[].Payments[].Claims[].PatientResponsibilityAmount` | string or null | No | Monetary amount of the claim the patient is responsible for |
| `Transactions[].Payments[].Claims[].ReferenceNumbers` | Array of object | No | Reference numbers associated to the claim like Prior Auth Number, Member ID, and Provider IDs |
| `Transactions[].Payments[].Claims[].ReferenceNumbers[].ID` | string or null | No | ID for the claim |
| `Transactions[].Payments[].Claims[].ReferenceNumbers[].IDType` | string or null | No | The type of ID |
| `Transactions[].Payments[].Claims[].Adjustments` | Array of object | No | Adjustments explain why a claim was paid differently than it was billed. *Adjustments may not exist at the claim level if they exist at the service level* |
| `Transactions[].Payments[].Claims[].Adjustments[].Amount` | string or null | No | Monetary amount of the adjustment. *A negative number indicates a payment increase, while a positive number indicates a payment reduction.* |
| `Transactions[].Payments[].Claims[].Adjustments[].Quantity` | string or null | No |  |
| `Transactions[].Payments[].Claims[].Adjustments[].Type` | string or null | No | Type of Adjustment. Value set 5e523f56-2e85-438c-94fd-4e8c8dc1649b: Other adjustments, Patient responsibility, Payor initiated reductions, Contractual obligations |
| `Transactions[].Payments[].Claims[].Adjustments[].Reason` | string or null | No | Adjustment reason. Value set 2242ceb1-6b74-45d2-bc33-e71891342ca5: Co-payment amount, Coinsurance amount, Deductible amount, Claim specific negotiated discount, Denial |
| `Transactions[].Payments[].Claims[].Services` | Array of object | No | This array will provide additional detail for claims processed at the line level. |
| `Transactions[].Payments[].Claims[].Services[].ChargedAmount` | string or null | No | The monetory amount charged |
| `Transactions[].Payments[].Claims[].Services[].PaymentAmount` | string or null | No | The monetory amount paid |
| `Transactions[].Payments[].Claims[].Services[].ChargedUnits` | string or null | No | The number of units of service charged for |
| `Transactions[].Payments[].Claims[].Services[].PaymentUnits` | string or null | No | The number of units of service paid for |
| `Transactions[].Payments[].Claims[].Services[].AllowedAmount` | string or null | No | Maximum monetary amount of payment |
| `Transactions[].Payments[].Claims[].Services[].SubmittedService` | object | No | Submitted service information |
| `Transactions[].Payments[].Claims[].Services[].SubmittedService.Code` | string or null | No | Code for the submitted service |
| `Transactions[].Payments[].Claims[].Services[].SubmittedService.Codeset` | string or null | No | Code set used to identify the submitted service |
| `Transactions[].Payments[].Claims[].Services[].SubmittedService.Description` | string or null | No | Description of the submitted service |
| `Transactions[].Payments[].Claims[].Services[].SubmittedService.Modifiers` | Array of string | No | Array of modifiers |
| `Transactions[].Payments[].Claims[].Services[].AdjudicatedService` | object | No | Adjudicated service information |
| `Transactions[].Payments[].Claims[].Services[].AdjudicatedService.Code` | string or null | No | Code for the adjudicated service |
| `Transactions[].Payments[].Claims[].Services[].AdjudicatedService.Codeset` | string or null | No | Code set used to identify the adjudicated service |
| `Transactions[].Payments[].Claims[].Services[].AdjudicatedService.Description` | string or null | No | Description of the adjudicated service |
| `Transactions[].Payments[].Claims[].Services[].AdjudicatedService.Modifiers` | Array of string | No | Array of modifiers |
| `Transactions[].Payments[].Claims[].Services[].Adjustments` | Array of object | No | Adjustments explain why a claim was paid differently than it was billed. |
| `Transactions[].Payments[].Claims[].Services[].Adjustments[].Amount` | string or null | No | Monetary amount of the adjustment. *A negative number indicates a payment increase, while a positive number indicates a payment reduction.* |
| `Transactions[].Payments[].Claims[].Services[].Adjustments[].Quantity` | string or null | No |  |
| `Transactions[].Payments[].Claims[].Services[].Adjustments[].Type` | string or null | No | Type of Adjustment. Value set 5e523f56-2e85-438c-94fd-4e8c8dc1649b: Other adjustments, Patient responsibility, Payor initiated reductions, Contractual obligations |
| `Transactions[].Payments[].Claims[].Services[].Adjustments[].Reason` | string or null | No | Adjustment reason. Value set 2242ceb1-6b74-45d2-bc33-e71891342ca5: Co-payment amount, Coinsurance amount, Deductible amount, Claim specific negotiated discount, Denial |
| `Transactions[].Payments[].Claims[].Services[].StartDateTime` | string or null | No | Date the claim was submitted. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Claims[].Services[].EndDateTime` | string or null | No | Date the statement period started. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Transactions[].Payments[].Claims[].Services[].ReferenceNumbers` | Array of object | No | Reference numbers associated to the claim service line |
| `Transactions[].Payments[].Claims[].Services[].ReferenceNumbers[].ID` | string or null | No | ID for the service line |
| `Transactions[].Payments[].Claims[].Services[].ReferenceNumbers[].IDType` | string or null | No | The type of ID |

## Example

```json
{
  "Meta": {
    "DataModel": "Claim",
    "EventType": "PaymentBatch",
    "EventDateTime": "2026-11-20T22:18:53.621Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Transactions": [
    {
      "ID": "000000001",
      "IDType": null,
      "Type": "Profressional",
      "TotalPaymentAmount": "580.00",
      "CreditOrDebit": "Credit",
      "PaymentMethod": "Check",
      "PaymentDateTime": "2016-11-11T02:11:03.111Z",
      "TrackingNumber": "8675309",
      "Submitter": {
        "Identifiers": [
          {
            "ID": "123456",
            "IDType": "TIN"
          }
        ],
        "Name": "National Insurance Company of Redox",
        "Address": {
          "StreetAddress": null,
          "City": null,
          "State": null,
          "ZIP": null,
          "County": null,
          "Country": null
        },
        "EmailAddress": null,
        "PhoneNumber": {
          "Office": null,
          "Fax": null
        }
      },
      "Receiver": {
        "Identifiers": [
          {
            "ID": "8675309",
            "IDType": "TIN"
          }
        ],
        "Name": "Redox Health System",
        "Address": {
          "StreetAddress": null,
          "City": null,
          "State": null,
          "ZIP": null,
          "County": null,
          "Country": null
        },
        "EmailAddress": null,
        "PhoneNumber": {
          "Office": null,
          "Fax": null
        }
      },
      "Payments": [
        {
          "DateTime": "2016-11-08T02:11:03.111Z",
          "Patient": {
            "Identifiers": [
              {
                "ID": "0000000001",
                "IDType": "MR"
              },
              {
                "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                "IDType": "EHRID"
              },
              {
                "ID": "a1d4ee8aba494ca",
                "IDType": "NIST"
              }
            ],
            "Demographics": {
              "FirstName": "Timothy",
              "MiddleName": "Paul",
              "LastName": "Bixby",
              "DOB": "2008-01-06",
              "SSN": "101-01-0001",
              "Sex": "Male",
              "Race": "White",
              "IsHispanic": null,
              "Religion": null,
              "MaritalStatus": "Single",
              "IsDeceased": null,
              "DeathDateTime": null,
              "PhoneNumber": {
                "Home": "+18088675301",
                "Office": null,
                "Mobile": null
              },
              "EmailAddresses": [],
              "Language": "en",
              "Citizenship": [],
              "Address": {
                "StreetAddress": "4762 Hickory Street",
                "City": "Monroe",
                "State": "WI",
                "ZIP": "53566",
                "County": "Green",
                "Country": "US"
              }
            },
            "Notes": []
          },
          "Claims": [
            {
              "ControlNumber": "94151100100",
              "SubmissionNumber": "66729659983",
              "ReceivedDate": "2016-10-31",
              "StartDateTime": null,
              "EndDateTime": null,
              "Status": "Processed as Primary",
              "ChargedAmount": "100.00",
              "PaymentAmount": "65.00",
              "PatientResponsibilityAmount": "20.00",
              "ReferenceNumbers": [
                {
                  "ID": "AUTH000000",
                  "IDType": "Prior Authorization"
                }
              ],
              "Adjustments": [],
              "Services": [
                {
                  "ChargedAmount": "100.00",
                  "PaymentAmount": "65.00",
                  "ChargedUnits": null,
                  "PaymentUnits": null,
                  "AllowedAmount": "85.00",
                  "SubmittedService": {
                    "Code": null,
                    "Codeset": null,
                    "Description": null,
                    "Modifiers": []
                  },
                  "AdjudicatedService": {
                    "Code": null,
                    "Codeset": null,
                    "Description": null,
                    "Modifiers": []
                  },
                  "Adjustments": [
                    {
                      "Amount": "20.00",
                      "Quantity": null,
                      "Type": "Patient responsibility",
                      "Reason": "Deductible amount"
                    },
                    {
                      "Amount": "15.00",
                      "Quantity": null,
                      "Type": "Contractual obligations",
                      "Reason": "Claim specific negotiated discount"
                    }
                  ],
                  "StartDateTime": null,
                  "EndDateTime": null,
                  "ReferenceNumbers": [
                    {
                      "ID": "1",
                      "IDType": "Control Number"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "DateTime": "2016-11-08T02:11:03.111Z",
          "Patient": {
            "Identifiers": [
              {
                "ID": "0000000001",
                "IDType": "MR"
              },
              {
                "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
                "IDType": "EHRID"
              },
              {
                "ID": "a1d4ee8aba494ca",
                "IDType": "NIST"
              }
            ],
            "Demographics": {
              "FirstName": "Timothy",
              "MiddleName": "Paul",
              "LastName": "Bixby",
              "DOB": "2008-01-06",
              "SSN": "101-01-0001",
              "Sex": "Male",
              "Race": "White",
              "IsHispanic": null,
              "Religion": null,
              "MaritalStatus": "Single",
              "IsDeceased": null,
              "DeathDateTime": null,
              "PhoneNumber": {
                "Home": "+18088675301",
                "Office": null,
                "Mobile": null
              },
              "EmailAddresses": [],
              "Language": "en",
              "Citizenship": [],
              "Address": {
                "StreetAddress": "4762 Hickory Street",
                "City": "Monroe",
                "State": "WI",
                "ZIP": "53566",
                "County": "Green",
                "Country": "US"
              }
            },
            "Notes": []
          },
          "Claims": [
            {
              "ControlNumber": "94151100200",
              "SubmissionNumber": "774466586",
              "ReceivedDate": "2016-10-31",
              "StartDateTime": null,
              "EndDateTime": null,
              "Status": "Processed as Primary",
              "ChargedAmount": "100.00",
              "PaymentAmount": "75.00",
              "PatientResponsibilityAmount": "20.00",
              "ReferenceNumbers": [
                {
                  "ID": "AUTH000000",
                  "IDType": "Prior Authorization"
                }
              ],
              "Adjustments": [],
              "Services": [
                {
                  "ChargedAmount": "100.00",
                  "PaymentAmount": "75.00",
                  "ChargedUnits": null,
                  "PaymentUnits": null,
                  "AllowedAmount": "95.00",
                  "SubmittedService": {
                    "Code": null,
                    "Codeset": null,
                    "Description": null,
                    "Modifiers": []
                  },
                  "AdjudicatedService": {
                    "Code": null,
                    "Codeset": null,
                    "Description": null,
                    "Modifiers": []
                  },
                  "Adjustments": [
                    {
                      "Amount": "20.00",
                      "Quantity": null,
                      "Type": "Patient responsibility",
                      "Reason": "Deductible amount"
                    },
                    {
                      "Amount": "5.00",
                      "Quantity": null,
                      "Type": "Contractual obligations",
                      "Reason": "Claim specific negotiated discount"
                    }
                  ],
                  "StartDateTime": null,
                  "EndDateTime": null,
                  "ReferenceNumbers": [
                    {
                      "ID": "1",
                      "IDType": "Control Number"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
```
