Table CSS

Example Request
curl --location -g --request POST '{{claimspay-base-url}}/rest.php' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'method=CreatePaymentMaster' \
--data-urlencode 'input_type=JSON' \
--data-urlencode 'response_type=JSON' \
--data-urlencode 'rest_data={"session": "{{session}}",     "str_json": "{          \"PM_CarrierId\" :\"{{PM_CarrierId}}\",         \"PM_PaymentID\":\"PMTPMM001PL06666100127012\",         \"PM_PaymentType\":\"Contact(s)\",         \"PM_Amount\":\"127.12\",         \"PM_UserId\":\"user01\",         \"PM_User_FirstName\":\"John\",         \"PM_User_LastName\":\"R\",         \"PM_User_EmailAddress\":\"[email protected]\",         \"CL_ClaimNumber\": \"052017\",         \"PCON_ContactId\": \"PCON121503\",         \"PCON_FirstName\": \"Joe\",         \"PCON_LastName\": \"Root\",         \"PCON_EmailAddress\": \"[email protected]\",         \"PCON_MobilePhone\": \"8051231234\",         \"PMA_Street\": \"09-5A, Woodland Hills\",         \"PMA_City\": \"Simi Valley\",         \"PMA_State\": \"CA\",         \"PMA_Zipcode\": \"93065-2234\",         \"PMA_Country\": \"USA\",         \"PMETHOD\": \"Check\",         \"PMA_MailTo\": \"James Smith\",         \"PM_Additional_Text_3\": \"James Smith\"      }" }'
var https = require('follow-redirects').https;
var fs = require('fs');

var qs = require('querystring');

var options = {
  'method': 'POST',
  'hostname': '{{claimspay-base-url}}',
  'path': '/rest.php',
  'headers': {
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = qs.stringify({
  'method': 'CreatePaymentMaster',
  'input_type': 'JSON',
  'response_type': 'JSON',
  'rest_data': '{"session": "{{session}}",     "str_json": "{          \\"PM_CarrierId\\" :\\"{{PM_CarrierId}}\\",         \\"PM_PaymentID\\":\\"PMTPMM001PL06666100127012\\",         \\"PM_PaymentType\\":\\"Contact(s)\\",         \\"PM_Amount\\":\\"127.12\\",         \\"PM_UserId\\":\\"user01\\",         \\"PM_User_FirstName\\":\\"John\\",         \\"PM_User_LastName\\":\\"R\\",         \\"PM_User_EmailAddress\\":\\"[email protected]\\",         \\"CL_ClaimNumber\\": \\"052017\\",         \\"PCON_ContactId\\": \\"PCON121503\\",         \\"PCON_FirstName\\": \\"Joe\\",         \\"PCON_LastName\\": \\"Root\\",         \\"PCON_EmailAddress\\": \\"[email protected]\\",         \\"PCON_MobilePhone\\": \\"8051231234\\",         \\"PMA_Street\\": \\"09-5A, Woodland Hills\\",         \\"PMA_City\\": \\"Simi Valley\\",         \\"PMA_State\\": \\"CA\\",         \\"PMA_Zipcode\\": \\"93065-2234\\",         \\"PMA_Country\\": \\"USA\\",         \\"PMETHOD\\": \\"Check\\",         \\"PMA_MailTo\\": \\"James Smith\\",         \\"PM_Additional_Text_3\\": \\"James Smith\\"      }" }'
});

req.write(postData);

req.end();
var client = new RestClient("{{claimspay-base-url}}/rest.php");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("method", "CreatePaymentMaster");
request.AddParameter("input_type", "JSON");
request.AddParameter("response_type", "JSON");
request.AddParameter("rest_data", "{\"session\": \"{{session}}\",     \"str_json\": \"{          \\\"PM_CarrierId\\\" :\\\"{{PM_CarrierId}}\\\",         \\\"PM_PaymentID\\\":\\\"PMTPMM001PL06666100127012\\\",         \\\"PM_PaymentType\\\":\\\"Contact(s)\\\",         \\\"PM_Amount\\\":\\\"127.12\\\",         \\\"PM_UserId\\\":\\\"user01\\\",         \\\"PM_User_FirstName\\\":\\\"John\\\",         \\\"PM_User_LastName\\\":\\\"R\\\",         \\\"PM_User_EmailAddress\\\":\\\"[email protected]\\\",         \\\"CL_ClaimNumber\\\": \\\"052017\\\",         \\\"PCON_ContactId\\\": \\\"PCON121503\\\",         \\\"PCON_FirstName\\\": \\\"Joe\\\",         \\\"PCON_LastName\\\": \\\"Root\\\",         \\\"PCON_EmailAddress\\\": \\\"[email protected]\\\",         \\\"PCON_MobilePhone\\\": \\\"8051231234\\\",         \\\"PMA_Street\\\": \\\"09-5A, Woodland Hills\\\",         \\\"PMA_City\\\": \\\"Simi Valley\\\",         \\\"PMA_State\\\": \\\"CA\\\",         \\\"PMA_Zipcode\\\": \\\"93065-2234\\\",         \\\"PMA_Country\\\": \\\"USA\\\",         \\\"PMETHOD\\\": \\\"Check\\\",         \\\"PMA_MailTo\\\": \\\"James Smith\\\",         \\\"PM_Additional_Text_3\\\": \\\"James Smith\\\"      }\" }");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "method=CreatePaymentMaster&input_type=JSON&response_type=JSON&rest_data={\"session\": \"{{session}}\",     \"str_json\": \"{          \\\"PM_CarrierId\\\" :\\\"{{PM_CarrierId}}\\\",         \\\"PM_PaymentID\\\":\\\"PMTPMM001PL06666100127012\\\",         \\\"PM_PaymentType\\\":\\\"Contact(s)\\\",         \\\"PM_Amount\\\":\\\"127.12\\\",         \\\"PM_UserId\\\":\\\"user01\\\",         \\\"PM_User_FirstName\\\":\\\"John\\\",         \\\"PM_User_LastName\\\":\\\"R\\\",         \\\"PM_User_EmailAddress\\\":\\\"[email protected]\\\",         \\\"CL_ClaimNumber\\\": \\\"052017\\\",         \\\"PCON_ContactId\\\": \\\"PCON121503\\\",         \\\"PCON_FirstName\\\": \\\"Joe\\\",         \\\"PCON_LastName\\\": \\\"Root\\\",         \\\"PCON_EmailAddress\\\": \\\"[email protected]\\\",         \\\"PCON_MobilePhone\\\": \\\"8051231234\\\",         \\\"PMA_Street\\\": \\\"09-5A, Woodland Hills\\\",         \\\"PMA_City\\\": \\\"Simi Valley\\\",         \\\"PMA_State\\\": \\\"CA\\\",         \\\"PMA_Zipcode\\\": \\\"93065-2234\\\",         \\\"PMA_Country\\\": \\\"USA\\\",         \\\"PMETHOD\\\": \\\"Check\\\",         \\\"PMA_MailTo\\\": \\\"James Smith\\\",         \\\"PM_Additional_Text_3\\\": \\\"James Smith\\\"      }\" }");
Request request = new Request.Builder()
  .url("{{claimspay-base-url}}/rest.php")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute();
var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/x-www-form-urlencoded");

var urlencoded = new URLSearchParams();
urlencoded.append("method", "CreatePaymentMaster");
urlencoded.append("input_type", "JSON");
urlencoded.append("response_type", "JSON");
urlencoded.append("rest_data", "{\"session\": \"{{session}}\",     \"str_json\": \"{          \\\"PM_CarrierId\\\" :\\\"{{PM_CarrierId}}\\\",         \\\"PM_PaymentID\\\":\\\"PMTPMM001PL06666100127012\\\",         \\\"PM_PaymentType\\\":\\\"Contact(s)\\\",         \\\"PM_Amount\\\":\\\"127.12\\\",         \\\"PM_UserId\\\":\\\"user01\\\",         \\\"PM_User_FirstName\\\":\\\"John\\\",         \\\"PM_User_LastName\\\":\\\"R\\\",         \\\"PM_User_EmailAddress\\\":\\\"[email protected]\\\",         \\\"CL_ClaimNumber\\\": \\\"052017\\\",         \\\"PCON_ContactId\\\": \\\"PCON121503\\\",         \\\"PCON_FirstName\\\": \\\"Joe\\\",         \\\"PCON_LastName\\\": \\\"Root\\\",         \\\"PCON_EmailAddress\\\": \\\"[email protected]\\\",         \\\"PCON_MobilePhone\\\": \\\"8051231234\\\",         \\\"PMA_Street\\\": \\\"09-5A, Woodland Hills\\\",         \\\"PMA_City\\\": \\\"Simi Valley\\\",         \\\"PMA_State\\\": \\\"CA\\\",         \\\"PMA_Zipcode\\\": \\\"93065-2234\\\",         \\\"PMA_Country\\\": \\\"USA\\\",         \\\"PMETHOD\\\": \\\"Check\\\",         \\\"PMA_MailTo\\\": \\\"James Smith\\\",         \\\"PM_Additional_Text_3\\\": \\\"James Smith\\\"      }\" }");

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: urlencoded,
  redirect: 'follow'
};

fetch("{{claimspay-base-url}}/rest.php", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));
import http.client

conn = http.client.HTTPSConnection("{{claimspay-base-url}}")
payload = 'method=CreatePaymentMaster&input_type=JSON&response_type=JSON&rest_data=%7B%22session%22%3A%20%22{{session}}%22%2C%20%20%20%20%20%22str_json%22%3A%20%22%7B%20%20%20%20%20%20%20%20%20%20%5C%22PM_CarrierId%5C%22%20%3A%5C%22{{PM_CarrierId}}%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_PaymentID%5C%22%3A%5C%22PMTPMM001PL06666100127012%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_PaymentType%5C%22%3A%5C%22Contact(s)%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_Amount%5C%22%3A%5C%22127.12%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_UserId%5C%22%3A%5C%22user01%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_User_FirstName%5C%22%3A%5C%22John%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_User_LastName%5C%22%3A%5C%22R%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_User_EmailAddress%5C%22%3A%5C%22john%40insurpay.com%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22CL_ClaimNumber%5C%22%3A%20%5C%22052017%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_ContactId%5C%22%3A%20%5C%22PCON121503%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_FirstName%5C%22%3A%20%5C%22Joe%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_LastName%5C%22%3A%20%5C%22Root%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_EmailAddress%5C%22%3A%20%5C%22insurpay.inbound.v2%40gmail.com%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_MobilePhone%5C%22%3A%20%5C%228051231234%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_Street%5C%22%3A%20%5C%2209-5A%2C%20Woodland%20Hills%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_City%5C%22%3A%20%5C%22Simi%20Valley%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_State%5C%22%3A%20%5C%22CA%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_Zipcode%5C%22%3A%20%5C%2293065-2234%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_Country%5C%22%3A%20%5C%22USA%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMETHOD%5C%22%3A%20%5C%22Check%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_MailTo%5C%22%3A%20%5C%22James%20Smith%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_Additional_Text_3%5C%22%3A%20%5C%22James%20Smith%5C%22%20%20%20%20%20%20%7D%22%20%7D'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}
conn.request("POST", "/rest.php", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
require "uri"
require "net/http"

url = URI("{{claimspay-base-url}}/rest.php")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/x-www-form-urlencoded"
request.body = "method=CreatePaymentMaster&input_type=JSON&response_type=JSON&rest_data=%7B%22session%22%3A%20%22{{session}}%22%2C%20%20%20%20%20%22str_json%22%3A%20%22%7B%20%20%20%20%20%20%20%20%20%20%5C%22PM_CarrierId%5C%22%20%3A%5C%22{{PM_CarrierId}}%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_PaymentID%5C%22%3A%5C%22PMTPMM001PL06666100127012%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_PaymentType%5C%22%3A%5C%22Contact(s)%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_Amount%5C%22%3A%5C%22127.12%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_UserId%5C%22%3A%5C%22user01%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_User_FirstName%5C%22%3A%5C%22John%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_User_LastName%5C%22%3A%5C%22R%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_User_EmailAddress%5C%22%3A%5C%22john%40insurpay.com%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22CL_ClaimNumber%5C%22%3A%20%5C%22052017%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_ContactId%5C%22%3A%20%5C%22PCON121503%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_FirstName%5C%22%3A%20%5C%22Joe%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_LastName%5C%22%3A%20%5C%22Root%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_EmailAddress%5C%22%3A%20%5C%22insurpay.inbound.v2%40gmail.com%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PCON_MobilePhone%5C%22%3A%20%5C%228051231234%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_Street%5C%22%3A%20%5C%2209-5A%2C%20Woodland%20Hills%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_City%5C%22%3A%20%5C%22Simi%20Valley%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_State%5C%22%3A%20%5C%22CA%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_Zipcode%5C%22%3A%20%5C%2293065-2234%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_Country%5C%22%3A%20%5C%22USA%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMETHOD%5C%22%3A%20%5C%22Check%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PMA_MailTo%5C%22%3A%20%5C%22James%20Smith%5C%22%2C%20%20%20%20%20%20%20%20%20%5C%22PM_Additional_Text_3%5C%22%3A%20%5C%22James%20Smith%5C%22%20%20%20%20%20%20%7D%22%20%7D"

response = http.request(request)
puts response.read_body
Example Response
{
  "PM_PaymentID": "PMTPMM001PL06666123",
  "PM_Status": "Issued",
  "PM_Id": "d46c8eb5-8fa8-432e-6cc5-5f3e6094bf40",
  "PM_PaymentMethod": "Check",
  "Status": "Success",
  "PM_TranId": "700000001"
}
POST
{{claimspay-base-url}}/rest.php

The CreatePaymentMaster POST method creates payments in the ClaimsPay system. This API can be used for multiple scenarios such as creating a single party check payment, customer pickup, vendor payment etc. Details of these scenarios are provided in the rest_data sample payloads by use case code sample tabs below and the Use Case section of the Outbound Payments Guide.


Request Body Parameters


BODY urlencoded

KeyValueTypeDescription
methodCreatePaymentMasterstring,
required
Must be CreatePaymentMaster
input_typeJSONstring,
required
JSON - this is a constant value
response_typeJSONstring,
required
JSON - this is a constant value
rest_data{
"session": "{{session}}",
"str_json": "{ "PM_CarrierId" :"{{PM_CarrierId}}", "PM_PaymentID":"{{PM_PaymentID}}", "PM_PaymentType":"{{PM_PaymentType}}", "PM_Amount":"{{PM_Amount}}", "PM_UserId":"{{PM_UserId}}", "PM_User_FirstName":"{{PM_User_FirstName}}", "PM_User_LastName":"{{PM_User_LastName}}", "PM_User_EmailAddress":"{{PM_User_EmailAddress}}", "CL_ClaimNumber": "{{CL_ClaimNumber}}", "PCON_ContactId": "{{PCON_ContactId}}", "PCON_FirstName": "{{PCON_FirstName}}", "PCON_LastName": "{{PCON_LastName}}", "PMA_Street": "{{PMA_Street}}", "PMA_City": "{{PMA_City}}", "PMA_State": "{{PMA_State}}", "PMA_Zipcode": "{{PMA_Zipcode}}", "PMA_Country": "{{PMA_Country}}", "PMETHOD": "{{PMETHOD}}", "PMA_MailTo": "{{PMA_MailTo}}", "PM_Additional_Text_3": "{{PM_Additional_Text_3}}" }"
}
string,
required
JSON data in string format. The exact parameters and values will vary by Use Case, you can also find more information on use case payloads in the rest_data sample payloads by use case section below.

BODY details

rest_data object

NameTypeDescription
sessionstring,
required
Hashed session ID for this operation.
str_jsonstring,
required
Stringified object that contains primary payload

str_json object

Payment Detail Fields
Parameter Name (Required?)DataType(allowed length)Valid Values
PM_PaymentType (Required)String"Contact(s)",
"Vendor",
"Lienholder",
"Contact(s) and Vendor", or
"Contact(s) and Mortgagee"
PM_PaymentID (Required)String(50)
PM_Amount (Required)Decimal(26,2)
PM_RequestReason (Optional)String(200)
PM_Expedite (Optional)Char(1)"Y" or "N"
PM_Certified (Optional)Char(1)"Y" or "N"
PM_ENV (Optional)String (50)"DEV", "QA", or "PROD"
PM_CarrierId (Optional)String(36)
PM_LoanAccountNumber (Conditional)String(50)
PM_PrintNow (Optional)Char(1)"Y" or "N"
PM_Check_Fraud_Language (Optional)String(700)

Adjuster Details Fields

The adjuster details are used to associate a payment to an adjuster and are also displayed to the payee for contact purposes.

Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
PM_UserId (Required)String(60)"user0123kjsd"Unique username/id for the adjuster from source system.
PM_User_FirstName (Required)String(30)Allowed RegEx characters: A-Za-z0-9-"Taylor"First Name for the adjuster.
PM_User_LastName (Required)String(30)Allowed RegEx characters: A-Za-z0-9-"Tutoikally"Last Name for the adjuster.
PM_User_EmailAddress (Required)String(255)Allowed RegEx characters: /^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+.)+[A-Z]{2,}$/si"[email protected]"Email address for the adjuster from claims management system.
PM_User_PhoneNumber (Optional)String(50)"6985231407"Phone number for the adjuster.

Claim Data Fields
Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
CL_ClaimNumber (Required)String(50)"256314-8"Claim Number from claim management system this payment.
CL_ClaimType (Optional)String(50)"Personal Auto"Type of claim, typically the line of business.
CL_CoverageType (Optional)String(50)"Collision"Type of Coverage.
CL_CauseofLoss (Conditional)String(50)"Collision with motor vehicle"Cause of Loss.
CL_DateofLoss (Conditional)DateYYYY-MM-DD"2021-04-27"Date of Loss.
CL_PolicyNumber (Conditional)String(50)"INJ456"Policy Number. This is only required for “Contact(s) and Mortgagee” payment types.

Document Data Fields
Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
PM_DocCount (Optional)Int(1)4Total number of documents expected to be attached to the payment.

Primary Contact Fields

*Required for Payment Types: "Contact(s)", "Contact(s) and Vendor", "Contact(s) and Mortgagee"

Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
PCON_Business (Optional)Char(1)"Y" – Payee is a company
"N" – Payee is a contact.
"Y"This is a flag to pay an insured/claimant that is a business. When this field is set to "Y", PCON_FirstName is not required and 2 party payments are not allowed.
PCON_ContactId (Required)String(50)"con147"Unique identifier for this contact from the call originating system.
PCON_FirstName (Required)String(100)Allowed RegEx characters: A-Za-z0-9-"Albert"First Name of Primary Contact
PCON_LastName (Required)String(100)Allowed RegEx characters: A-Za-z0-9-"Camus"Last Name of Primary Contact
PCON_MobilePhone (Conditional)String(100)Supported formats: "##########", "###-###-####""6985231407"Mobile Phone Number of Primary Contact
PCON_OfficePhone (Optional)String(100)Supported formats: "##########", "###-###-####""6985231407"Office Phone Number of Primary Contact
PCON_EmailAddress (Conditional)String(255)Allowed RegEx characters: /^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+.)+[A-Z]{2,}$/si[email protected]Email Address of Primary Contact
PCON_Delivery (Optional)String(20)"Text" or "Email""Email"Specifies the communication method for the primary contact. If PCON_Delivery parameter is not supplied default communication method(s) will be used.
PCON_SSN (Optional)String(11)"999-99-9999"Social Security Number of Primary Contact
PCON_DOB (Optional)DateYYYY-MM-DD"1913-11-07"Date of Birth of Primary Contact in yyyy-mm-dd format.
PCON_Approval_Reqd (Conditional)Char(1)"Y" or "N""Y"Is approval required from this contact before paying a Vendor? This is only used for Payment_Type = "Contact(s) and Vendor".

Secondary Contact Fields

Optional for Payment Types: "Contact(s)", "Contact(s) and Vendor", "Contact(s) and Mortgagee".

Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
SCON_Business (Optional)Char(1)"Y" – Payee is a company
"N" – Payee is a contact.
"Y"This is a flag to pay an insured/claimant that is a business. When this field is set to "Y", SCON_FirstName is not required and 2 party payments are not allowed.
SCON_ContactId (Required)String(50)"con147"Unique identifier for this contact from the call originating system.
SCON_FirstName (Required)String(100)Allowed RegEx characters: A-Za-z0-9-"Albert"First Name of Secondary Contact
SCON_LastName (Required)String(100)Allowed RegEx characters: A-Za-z0-9-"Camus"Last Name of Secondary Contact
SCON_MobilePhone (Conditional)String(100)Supported formats: "##########", "###-###-####""6985231407"Mobile Phone Number of Secondary Contact. This is required for payments that require approval such as Multi party payments.
SCON_OfficePhone (Optional)String(100)Supported formats: "##########", "###-###-####""6985231407"Office Phone Number of Secondary Contact
SCON_EmailAddress (Conditional)String(255)Allowed RegEx characters: /^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+.)+[A-Z]{2,}$/si"[email protected]"Email Address of Secondary Contact. This is required for payments that require approval such as Multi party payments.
SCON_Delivery (Optional)String(20)"Text" or "Email""Email"Specifies the communication method for the Secondary contact. If SCON_Delivery parameter is not supplied default communication method(s) will be used.
SCON_SSN (Optional)String(11)"999-99-9999"Social Security Number of Secondary Contact
SCON_DOB (Optional)DateYYYY-MM-DD"1913-11-07"Date of Birth of Secondary Contact in yyyy-mm-dd format.
SCON_Approval_Reqd (Conditional)Char(1)"Y" or "N"Is approval required from this contact before paying a Vendor? This is only used for Payment_Type = "Contact(s) and Vendor".

Vendor Details Fields

Required only for Payment Types: "Vendor", "Lienholder", "Contact(s) and Vendor", "Contact(s) and Mortgagee"

Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
BUS_BusinessId (Required)String(50)"BUS4841"
BUS_Name (Required)String(180)Allowed charachters: a-zA-Z0-9 !@#?()"Sarte's Body Shop"
BUS_Type (Required)String(100)"Lienholder", "Mortgagee", or "Vendor""Vendor"Use Lienholder as the business type on “Lienholder” payment type requests. Use Mortgagee as the business type on “Contact(s) and Mortgagee” payment type requests. Use Vendor as the business type in all other scenarios.
BUS_SubType (Conditional)String(255)"Auto Repair Shop"Sub Type of Business.
This is only required when BUS_Type is Vendor.
BUS_OfficePhone (Optional)String(100)Supported formats: "##########", "###-###-####""754-865-1280"Office Phone Number of business.
BUS_Fax (Optional)String(100)Supported formats: "##########", "###-###-####""444-584-4542"Fax Number of business
BUS_EmailAddress (Optional)String(255)Allowed RegEx characters: /^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+.)+[A-Z]{2,}$/si"[email protected]"Email Address of business.
BUS_Street (Optional)String(150)"123 East Street, Ste. #5"Street Address of business.
BUS_City (Optional)String(100)"Nome"City
BUS_State (Optional)String(100)"AK"State
BUS_Zipcode (Optional)String(20)Supported formats: "#####", "#####-####""12345"Zip code
BUS_Country (Optional)String(255)"USA"Country
BUS_TIN (Conditional)String(11)Digits 0 to 9"789410598"Tax identification number of business. Required for payments to vendors using the vendor network. If TIN is not specified the payment method will be based on the vendor sub type and will be mailed check or mailed virtual card. Should be 9 digits.
BUS_TINType (Optional)String(100)"TIN", "FEIN", "TIBN", "SSN", or "EIN""FEIN"Type of identification number. Default = Null.
BUS_Reportable1099 (Optional)Char(1)"Y" or "N""N"Reportable flag for 1099 reporting. Default = Null.
BUS_ReportingType1099 (Optional)String(100)"Medical"Reporting Type. This parameter determines the box on the 1099 where the vendor's payment some is placed.

Property Address Fields

All Required only for Payment Type – "Contact(s) and Mortgagee"

Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
PA_Street (Conditional)String(255)"123 Happy Place"Street Address of Home.
PA_City (Conditional)String(100)"Burlington"City
PA_State (Conditional)Strin(100)"VT"State
PA_Zipcode (Conditional)String(20)"12345"Zip code
PA_Country (Conditional)String(100)"USA"Country

Payment Mailing Address Fields

This address is used for mailing checks and prepaid cards. It is required for when payments methods are defaulted to check.

Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
PMA_Street (Required)String(255)"453 Exeter Street"Street Address of Home.
PMA_City (Required)String(100)Allowed characters: a-zA-Z0-9 !@#?()"Austin"City
PMA_State (Required)Strin(100)"TX"State
PMA_Zipcode (Required)String(20)Supported formats: "#####", "#####-####""12345-6789"Zip code
PMA_Country (Required)String(100)2 and 3 letter country codes are supported."US"Country
PMA_MailTo (Optional)String(200)"Samson Simpson"If specified, will be used as the payment recipient’s name. If not provided, the PCON_FirstName and PCON_LastName OR the BUS_Name will be used.

Payment Method Details Fields
Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
PMETHOD_Stored (Conditional)String"hkjasdh-asdhadsas-adsadsa-adsas"Unique identifier to be sent in for supplemental payments. This id is generated on the initial payment request and included in the response. Only Direct Deposit, Debit Card, and Prepaid Card stored payment methods can be used for supplemental payments.
PMETHOD (Conditional)String"Let Customer Pickup",
"Check",
"Mail Prepaid Card",
"Instant Prepaid Card", or
"Generate Barcode".
"Check"Payment Method to use to process this payment. This is only required for the following payment types: "Contact(s)", "Contact(s) and Mortgagee".

Default Payment Methods:
Contact(s) = "Let Customer Pickup",
Contact(s) and Mortgagee-(Monitored) = "Check",
Contact(s) and Mortgagee-(Non-Monitored) = "Let Customer Pickup"
PMETHOD_IC_ProxyNumber (Conditional)String(50)"9237423"Proxy Number.This is only required for Payment Method – "Instant Prepaid Card". Doesn't allow Alphabets and special Characters.

Additonal Text Fields

These parameters are used for additional carrier specific data such as: service start date to be printed on check, PayPalId for internal use, or a memo. Values can be displayed on checks, emails, and the customer portal.

Parameter Name (Required?)DataType(allowed length)Valid ValuesFormatExampleNotes & Restrictions
PM_Additional_Text_1 (Optional)String(200)"INV5201"Invoice Number displayed on check, vendor remittance, and within vendor portal.
PM_Additional_Text_2 (Optional)String(200)"David Christopher"Insured Name displayed on check and vendor remittance.
PM_Additional_Text_3 (Conditional)String(180)"Davy Jones"Check Payee Name displayed on check. Required if One Inc. printing checks.
PM_Additional_Text_4 (Optional)String(200)"ABC Assurance Ltd"Claimant Name displayed on check and vendor remittance.
PM_Additional_Text_5 (Optional)String(200)"Paid for the Accidental Loss"Payment Description displayed on check stub and vendor remittance.
PM_Additional_Text_6 (Optional)String(200)"2021-05-07"Service Start Date displayed on check. This is for display only, so it can accept any date format.
PM_Additional_Text_7 (Optional)String(200)Additional Information from Carrier that can be used for reporting or other needs.
PM_Additional_Text_8 (Optional)String(200)Additional Information from Carrier that can be used for reporting or other needs.
PM_Additional_Text_9 (Optional)String(200)"David Chrisotpher"To Pay For (Memo) displayed on check.
PM_Additional_Text_10 (Optional)String(200)"2021-05-07"Service End Date displayed on check. This is for display only, so it can accept any date format.
PM_Additional_Text_11 (Optional)String(300)Agency displayed on check.
PM_Additional_Text_12 (Optional)String(300)Additional Information from Carrier that can be used for reporting or other needs.
PM_Additional_Text_13 (Optional)String(300)Additional Information from Carrier that can be used for reporting or other needs.
PM_Additional_Text_14 (Optional)String(300)Additional Information from Carrier that can be used for reporting or other needs.
PM_Additional_Text_15 (Optional)String(300)Additional Information from Carrier that can be used for reporting or other needs.

rest_data sample payloads by use case:

This use case demonstrates making a check payment for a single party. The value in PM_Additional_Text_3 field will be used as the Check payee name and it will be printed on the check.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL06666100127012\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"127.12\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"R\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON121503\", \"PCON_FirstName\": \"Joe\", \"PCON_LastName\": \"Root\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Check\", \"PMA_MailTo\": \"James Smith\", \"PM_Additional_Text_3\": \"James Smith\" }"
}
This use case demonstrates paying an insured/claimant using direct deposit information provided by the carrier's claims system:

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"GBDD101\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"500.00\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"GC1051\", \"PCON_FirstName\": \"John\", \"PCON_LastName\": \"Smith\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Direct Deposit\", \"PMETHOD_DD_AccountNumber\":\"10012\", \"PMETHOD_DD_RoutingNumber\":\"123456789\", \"PMETHOD_DD_AccountType\":\"Personal Checking\"}"
}
The payment will be issued through a Prepaid card, which will be mailed to mailing address.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL06688121\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"4.71\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON1215041\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Mail Prepaid Card\" }"
}
This use case demonstrates making a payment that allows the customer to select their method of payment. 
ClaimsPay v3 will send an email and/or and SMS to the customer with a secure link. 
2 factor authentication is performed using email and phone (text or voice) therefore PCON_EmailAddress and PCON_MobilePhone are both required.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL0666612365\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"12.7\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON121503\", \"PCON_FirstName\": \"Sam\", \"PCON_LastName\": \"Billings\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_MobilePhone\": \"8051231234\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Let Customer Pickup\" }"
}
This use case demonstrates paying an insured / claimant that is a business rather than a person. 
The business will have the same payment experience as a person. 
A single party business payment is created by setting PCON_Business to "Y" and the business name is placed in PCON_LastName. 
PCON_FirstName is not required and should be empty string or not included in payload. 
2 party payments are not allowed.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL066\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"175.00\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON121503\", \"PCON_Business\": \"Y\", \"PCON_LastName\": \"Small Vendor Name\", \"PCON_EmailAddress\": \"\", \"PCON_MobilePhone\": \"\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Let Customer Pickup\" }"
}
This payload is for issuing a field payment. The adjuster can select the payment method through the ClaimsPay Mobile application.

{
	"session": "{{session}}",
	"str_json": "{\"PM_CarrierId\": \"{{PM_CarrierId}}\",\"PM_PaymentID\": \"PMTPMM001PL066660166\",\"PM_PaymentType\": \"Contact(s)\",\"PM_Amount\": \"4.75\",\"PM_UserId\": \"user01\",\"PM_User_FirstName\": \"John\",\"PM_User_LastName\": \"Doe\",\"PM_User_EmailAddress\": \"[email protected]\",\"CL_ClaimNumber\": \"052017\",\"PCON_ContactId\": \"PCON1215031\",\"PCON_FirstName\": \"James\",\"PCON_LastName\": \"Smith\",\"PCON_EmailAddress\": \"[email protected]\",\"PCON_MobilePhone\": \"8051231234\",\"PMA_Street\": \"09-5A, Woodland Hills\",\"PMA_City\": \"Simi Valley\",\"PMA_State\": \"CA\",\"PMA_Zipcode\": \"93065-2234\",\"PMA_Country\": \"USA\",\"PMETHOD\": \"Generate Barcode\"}"
}
This use case demonstrates issuing an instant prepaid card. The amount is loaded to the card through a valid proxy number.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL06666367\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"12.34\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON1215032\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Instant Prepaid Card\", \"PMETHOD_IC_ProxyNumber\":\"123412341234\" }"
}
This method is used for reloading a prepaid card which was mailed earlier to the Customer.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL06688170\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"4.71\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON1215041\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD_Stored\":\"127b5d22-0cb6-2ac6-1352-5f4f41b349cc\" }"
}
This use case demonstrates using a insured/claimant's previous payment method for a subsequent payment. 
Typically when CreatePaymentMaster is called with "Let Customer Pickup" the CreatePaymentMaster response's PMETHOD_Stored token is saved in the source system. 
This saved token is then used for any subsequent payments in the PMETHOD_Stored parameter.
A payment method token can also be retrieved by GetPaymentStatus for a previous related payment.

Note:
1) PMETHOD_Stored tokens are not valid for subsequent payment use until the insured/claimant has selected a payment method. Otherwise the error "Stored Payment Mode type is not valid" will be raised.
2) If a stored payment method's limit is exceeded on a subsequent payment, then Error Code 111 "Amount not in Min/Max limit" will be returned. 

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL06688170\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"4.71\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON1215041\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_MobilePhone\": \"8051231234\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD_Stored\":\"127b5d22-0cb6-2ac6-1352-5f4f41b349cc\" }"
}
The check payee name can be passed through the PM_Additional_Text_3. In this case, it will be printed on the check as the payee name. 
If this field is blank, the names of both contacts will be printed on the check.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL06677169\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"2.71\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON121503\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_MobilePhone\": \"8051231234\", \"SCON_ContactId\": \"SCON121503\", \"SCON_FirstName\": \"Robert\", \"SCON_LastName\": \"Smith\", \"SCON_EmailAddress\": \"[email protected]\", \"SCON_MobilePhone\": \"8051231235\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Check\", \"PMA_MailTo\": \"James Smith\", \"PM_Additional_Text_3\": \"James Smith & Robert Smith & Mike Bennet\" }"
}
ClaimsPay sends an email to the customer with a secure link, and performs the validation through a text message or voice call. 
Since it is a multiparty payment, the PCON_EmailAddress, PCON_MobilePhone, SCON_EmailAddress and SCON_MobilePhone are mandatory for this API method.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL06677071\", \"PM_PaymentType\":\"Contact(s)\", \"PM_Amount\":\"7.70\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON1215032\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_MobilePhone\": \"8051231234\", \"SCON_ContactId\": \"SCON1215032\", \"SCON_FirstName\": \"Robert\", \"SCON_LastName\": \"Smith\", \"SCON_EmailAddress\": \"[email protected]\", \"SCON_MobilePhone\": \"8051231235\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Let Customer Pickup\" }"
}
This method is for issuing a field payment. The adjuster can select the payment method through the ClaimsPay Mobile application for the multiparty field payment.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\": \"{{PM_CarrierId}}\", \"PM_PaymentID\": \"PMTPMM001PL066532373\", \"PM_PaymentType\": \"Contact(s)\", \"PM_Amount\": \"7.24\", \"PM_UserId\": \"user01\", \"PM_User_FirstName\": \"John\", \"PM_User_LastName\": \"Doe\", \"PM_User_EmailAddress\": \"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON1215032\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_MobilePhone\": \"8051231234\", \"SCON_ContactId\": \"SCON1215032\", \"SCON_FirstName\": \"Robert\", \"SCON_LastName\": \"Smith\", \"SCON_EmailAddress\": \"[email protected]\", \"SCON_MobilePhone\": \"8051231235\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Generate Barcode\" }"
}
This method is for creating a payment involving one contact and a vendor. The payment may or may not require an approval.

1) With approval: When a "Contact(s) and Vendor" payment is created with "Approval Required", an approval link will be sent to the contact’s email address.
   Once the contact approves the paymentin the approval portal, the payment will be processed as a Vendor preferred method (Direct Deposit / Virtual Card / Check)
2) Without approval: In this case, payment will be processed as vendor preferred payment method.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\": \"{{PM_CarrierId}}\", \"PM_PaymentID\": \"PMTPMM001PL06666123\", \"PM_PaymentType\": \"Contact(s) and Vendor\", \"PM_Amount\": \"724.75\", \"PM_UserId\": \"user01\", \"PM_User_FirstName\": \"John\", \"PM_User_LastName\": \"Doe\", \"PM_User_EmailAddress\": \"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON121503\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_MobilePhone\": \"8051231234\", \"PCON_Approval_Reqd\": \"Y\", \"BUS_BusinessId\": \"abc:01192\", \"BUS_Name\": \"Auto Rental Ltd\", \"BUS_Type\": \"Vendor\", \"BUS_SubType\": \"Company\", \"BUS_TINType\": \"TIN\", \"BUS_TIN\": \"874-01-1118\", \"BUS_OfficePhone\": \"8884875890\", \"BUS_Fax\": \"8884875890\", \"BUS_EmailAddress\":\"[email protected]\", \"BUS_Street\": \"P O Box 1257, Siachin\", \"BUS_City\": \"Simi Valley\", \"BUS_State\": \"CA\", \"BUS_Zipcode\": \"93063\", \"BUS_Country\": \"USA\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMA_MailTo\": \"James Smith\", \"PM_Additional_Text_3\": \"Check Payee Name - James Smith\", \"PM_Additional_Text_1\": \"Invoice-124555\", \"PM_Additional_Text_2\": \"Insured Name - James Smith\", \"PM_Additional_Text_4\": \"Claimant Name - James Smith\", \"PM_Additional_Text_5\": \"Description - Repair Cost\", \"PM_Additional_Text_6\": \"Service Start Date\", \"PM_Additional_Text_10\": \"Service End Date\", \"PM_Additional_Text_9\": \"To Pay for\" }"
}
This method is for creating a multiparty payment involving "Contact(s) and Vendor".
If approval is required for issuing the payment, the PCON_Approval_Reqd and SCON_Approval_Reqdset fields need to be set to Y and both contacts need to approve in the case of a non-check payment.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\" :\"{{PM_CarrierId}}\", \"PM_PaymentID\":\"PMTPMM001PL02220274\", \"PM_PaymentType\":\"Contact(s) and Vendor\", \"PM_Amount\":\"132.75\", \"PM_UserId\":\"user01\", \"PM_User_FirstName\":\"John\", \"PM_User_LastName\":\"Doe\", \"PM_User_EmailAddress\":\"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"PCON_ContactId\": \"PCON12150312\", \"PCON_FirstName\": \"James\", \"PCON_LastName\": \"Smith\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_MobilePhone\": \"8051231234\", \"PCON_Approval_Reqd\":\"Y\", \"SCON_ContactId\": \"SCON12150312\", \"SCON_FirstName\": \"Robert\", \"SCON_LastName\": \"Smith\", \"SCON_EmailAddress\": \"[email protected]\", \"SCON_MobilePhone\": \"8051231235\", \"SCON_Approval_Reqd\":\"Y\", \"BUS_BusinessId\":\"abc:01192\", \"BUS_Name\":\"Auto Rental Ltd\", \"BUS_Type\":\"Vendor\", \"BUS_SubType\":\"Company\", \"BUS_TINType\":\"TIN\", \"BUS_TIN\":\"874-01-1118\", \"BUS_OfficePhone\":\"8884875890\", \"BUS_Fax\":\"8884875890\", \"BUS_EmailAddress\":\"[email protected]\", \"BUS_Street\":\"P O Box 1257, Siachin\", \"BUS_City\":\"Simi Valley\", \"BUS_State\":\"CA\", \"BUS_Zipcode\":\"93063\", \"BUS_Country\":\"USA\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMA_MailTo\": \"James Smith\", \"PM_Additional_Text_3\": \"Check Payee Name - James Smith\", \"PM_Additional_Text_1\": \"Invoice-124555\", \"PM_Additional_Text_2\": \"Insured Name - James Smith\", \"PM_Additional_Text_4\": \"Claimant Name - James Smith\", \"PM_Additional_Text_5\": \"Description - Repair Cost\", \"PM_Additional_Text_6\": \"Service Start Date\", \"PM_Additional_Text_10\": \"Service End Date\", \"PM_Additional_Text_9\": \"To Pay for\" }"
}
This use case creates a payment to an insured and a mortgage provider.

{
	"session": "{{session}}",
	"str_json": "{ \"PM_CarrierId\": \"{{PM_CarrierId}}\", \"PM_PaymentID\": \"IPNS112101049177\", \"PM_PaymentType\": \"Contact(s) and Mortgagee\", \"PM_Amount\": \"15.52\", \"PM_UserId\": \"ipuser01\", \"PM_User_LastName\": \"Jhon\", \"PM_User_FirstName\": \"Doe\", \"PM_User_EmailAddress\": \"[email protected]\", \"CL_ClaimNumber\": \"IP2021\", \"PCON_ContactId\": \"PCON1129011\", \"PCON_FirstName\": \"Rio\", \"PCON_LastName\": \"Dsouza\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_OfficePhone\": \"\", \"PCON_MobilePhone\": \"6362616507\", \"PCON_Approval_Reqd\": \"Y\", \"BUS_BusinessId\": \"ab:31904\", \"BUS_Name\": \"Test Mortgagee 5\", \"BUS_Type\": \"Mortgagee\", \"BUS_Fax\": \"3121232235\", \"BUS_EmailAddress\": \"[email protected]\", \"BUS_OfficePhone\": \"6362616507\", \"BUS_Street\": \"Siachin\", \"BUS_City\": \"Simi Valley\", \"BUS_State\": \"CA\", \"BUS_Zipcode\": \"98564\", \"BUS_TINType\": \"FEIN\", \"BUS_Country\": \"USA\", \"BUS_TIN\": \"11-9990000\", \"PM_LoanAccountNumber\": \"454354534534\", \"PMA_Street\": \"Mount Street 2\", \"PMA_City\": \"Fort Worth\", \"PMA_State\": \"TX\", \"PMA_Zipcode\": \"76140\", \"PMA_Country\": \"USA\", \"PA_Street\": \"P. O. Box 08302016\", \"PA_City\": \"Austin\", \"PA_State\": \"TX\", \"PA_Zipcode\": \"73013-1234\", \"PA_Country\": \"USA\", \"CL_CauseofLoss\": \"Fire\", \"CL_DateofLoss\": \"2014-01-10\", \"CL_PolicyNumber\": \"G900785962\", \"PM_RequestReason\": \"Loss Type Payment\", \"PMETHOD\": \"Let Customer Pickup\" }"
}
This use case creates a payment to an insured, a secondary contact, and a mortgage provider.

{
	"session": "{{session}}",
	"str_json": "{\"PM_CarrierId\": \"{{PM_CarrierId}}\", \"PM_PaymentID\": \"IPNS1121058\", \"PM_PaymentType\": \"Contact(s) and Mortgagee\", \"PM_Amount\": \"15.52\", \"PM_UserId\": \"ipuser01\", \"PM_User_LastName\": \"Jhon\", \"PM_User_FirstName\": \"Doe\", \"PM_User_EmailAddress\": \"[email protected]\", \"CL_ClaimNumber\": \"IP2021\", \"PCON_ContactId\": \"PCON1129011\", \"PCON_FirstName\": \"John\", \"PCON_LastName\": \"Smith\", \"PCON_EmailAddress\": \"[email protected]\", \"PCON_OfficePhone\": \"\", \"PCON_MobilePhone\": \"6362616507\", \"SCON_ContactId\": \"SCON1129011\", \"SCON_FirstName\": \"Jane\", \"SCON_LastName\": \"Smith\", \"SCON_EmailAddress\": \"[email protected]\", \"SCON_OfficePhone\": \"\", \"SCON_MobilePhone\": \"5555551212\", \"BUS_BusinessId\": \"ab:31904\", \"BUS_Name\": \"Test Mortgagee 5\", \"BUS_Type\": \"Mortgagee\", \"BUS_Fax\": \"3121232235\", \"BUS_EmailAddress\": \"[email protected]\", \"BUS_OfficePhone\": \"6362616507\", \"BUS_Street\": \"Siachin\", \"BUS_City\": \"Simi Valley\", \"BUS_State\": \"CA\", \"BUS_Zipcode\": \"98564\", \"BUS_TINType\": \"FEIN\", \"BUS_Country\": \"USA\", \"BUS_TIN\": \"11-9990000\", \"PM_LoanAccountNumber\": \"454354534534\", \"PMA_Street\": \"Mount Street 2\", \"PMA_City\": \"Fort Worth\", \"PMA_State\": \"TX\", \"PMA_Zipcode\": \"76140\", \"PMA_Country\": \"USA\", \"PA_Street\": \"P. O. Box 08302016\", \"PA_City\": \"Austin\", \"PA_State\": \"TX\", \"PA_Zipcode\": \"73013-1234\", \"PA_Country\": \"USA\", \"CL_CauseofLoss\": \"Fire\", \"CL_DateofLoss\": \"2014-01-10\", \"CL_PolicyNumber\": \"G900785962\", \"PM_RequestReason\": \"Loss Type Payment\", \"PMETHOD\": \"Let Customer Pickup\"}"
}
This method is for creating a lienholder payment. 
The system will look up the lienholder's preferred payment method preference in the lienholder network by Bus_Name and mailing address.

{
	"session": "{{session}}",
	"str_json": "{\"PM_CarrierId\": \"{{PM_CarrierId}}\", \"PM_PaymentID\": \"PMTPMM001PL06666123\", \"PM_PaymentType\": \"Lienholder\", \"PM_Amount\": \"724.75\", \"PM_UserId\": \"user01\", \"PM_User_FirstName\": \"John\", \"PM_User_LastName\": \"Doe\", \"PM_User_EmailAddress\": \"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"BUS_BusinessId\": \"abc:01193\", \"BUS_Name\": \"Toyota Financial Services\", \"BUS_Type\": \"Lienholder\", \"BUS_TINType\": \"TIN\", \"BUS_TIN\": \"874-01-1118\", \"BUS_OfficePhone\": \"8884875890\", \"BUS_Fax\": \"8884875890\", \"BUS_Street\": \"P O Box 1257, Siachin\", \"BUS_City\": \"Simi Valley\", \"BUS_State\": \"CA\", \"BUS_Zipcode\": \"93063\", \"BUS_Country\": \"USA\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PM_LoanAccountNumber\": \"372531979012006\", \"PMA_MailTo\": \"James Smith\", \"PM_Additional_Text_3\": \"Check Payee Name - James Smith\", \"PM_Additional_Text_1\": \"Invoice-124555\", \"PM_Additional_Text_2\": \"Insured Name - James Smith\", \"PM_Additional_Text_4\": \"Claimant Name - James Smith\", \"PM_Additional_Text_5\": \"Description - Repair Cost\", \"PM_Additional_Text_6\": \"Service Start Date\", \"PM_Additional_Text_10\": \"Service End Date\", \"PM_Additional_Text_9\": \"To Pay for\" }"
}
This use case sends a check payment to a vendor. 
The payment method "Check" bypasses the vendor network specified payment method.

{
	"session": "{{session}}",
	"str_json": "{\"PM_CarrierId\": \"{{PM_CarrierId}}\", \"PM_PaymentID\": \"PMTPMM001PL06666123\", \"PM_PaymentType\": \"Vendor\", \"PM_Amount\": \"724.75\", \"PM_UserId\": \"user01\", \"PM_User_FirstName\": \"John\", \"PM_User_LastName\": \"Doe\", \"PM_User_EmailAddress\": \"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"BUS_BusinessId\": \"abc:01192\", \"BUS_Name\": \"Auto Rental Ltd\", \"BUS_Type\": \"Vendor\", \"BUS_SubType\": \"Company\", \"BUS_TINType\": \"TIN\", \"BUS_TIN\": \"874-01-1118\", \"BUS_OfficePhone\": \"8884875890\", \"BUS_Fax\": \"8884875890\", \"BUS_EmailAddress\":\"[email protected]\", \"BUS_Street\": \"P O Box 1257, Siachin\", \"BUS_City\": \"Simi Valley\", \"BUS_State\": \"CA\", \"BUS_Zipcode\": \"93063\", \"BUS_Country\": \"USA\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMETHOD\": \"Check\", \"PMA_MailTo\": \"James Smith\", \"PM_Additional_Text_3\": \"Check Payee Name - James Smith\", \"PM_Additional_Text_1\": \"Invoice-124555\", \"PM_Additional_Text_2\": \"Insured Name - James Smith\", \"PM_Additional_Text_4\": \"Claimant Name - James Smith\", \"PM_Additional_Text_5\": \"Description - Repair Cost\", \"PM_Additional_Text_6\": \"Service Start Date\", \"PM_Additional_Text_10\": \"Service End Date\", \"PM_Additional_Text_9\": \"To Pay for\" }"
}
This use case creates a payment to a vendor using their vendor network payment method.

{
	"session": "{{session}}",
	"str_json": "{\"PM_CarrierId\": \"{{PM_CarrierId}}\", \"PM_PaymentID\": \"PM2356235\", \"PM_PaymentType\": \"Vendor\", \"PM_Amount\": \"724.75\", \"PM_UserId\": \"user01\", \"PM_User_FirstName\": \"John\", \"PM_User_LastName\": \"Doe\", \"PM_User_EmailAddress\": \"[email protected]\", \"CL_ClaimNumber\": \"052017\", \"BUS_BusinessId\": \"abc:01192\", \"BUS_Name\": \"Auto Rental Ltd\", \"BUS_Type\": \"Vendor\", \"BUS_SubType\": \"Company\", \"BUS_TINType\": \"TIN\", \"BUS_TIN\": \"874-01-1118\", \"BUS_OfficePhone\": \"8884875890\", \"BUS_Fax\": \"8884875890\", \"BUS_EmailAddress\":\"[email protected]\", \"BUS_Street\": \"P O Box 1257, Siachin\", \"BUS_City\": \"Simi Valley\", \"BUS_State\": \"CA\", \"BUS_Zipcode\": \"93063\", \"BUS_Country\": \"USA\", \"PMA_Street\": \"09-5A, Woodland Hills\", \"PMA_City\": \"Simi Valley\", \"PMA_State\": \"CA\", \"PMA_Zipcode\": \"93065-2234\", \"PMA_Country\": \"USA\", \"PMA_MailTo\": \"James Smith\", \"PM_Additional_Text_3\": \"Check Payee Name - James Smith\", \"PM_Additional_Text_1\": \"Invoice-124555\", \"PM_Additional_Text_2\": \"Insured Name - James Smith\", \"PM_Additional_Text_4\": \"Claimant Name - James Smith\", \"PM_Additional_Text_5\": \"Description - Repair Cost\", \"PM_Additional_Text_6\": \"Service Start Date\", \"PM_Additional_Text_10\": \"Service End Date\", \"PM_Additional_Text_9\": \"To Pay for\" }"
}

PMETHOD (Payment Method) Values

The CreatePaymentMaster PMETHOD field is used to specify the method of payment.

PMETHOD Payment MethodsDescription
Let Customer PickupThe insured/claimant will be contacted via email and/or sms and prompted to select a payment method through the customer portal. See Payment Methods for details on payment methods.
CheckA check will be printed and mailed to the insured/claimant or vendor.
Mailed Prepaid CardA physical prepaid card with the payment will be mailed to the insured/claimant.
Instant Prepaid CardA physical prepaid card with the payment will be handed to the insured/claimant. Used in CAT when an adjuster will have cards on hand.
Generate BarcodeThis method issues a field payment. The adjuster will view the payment using the ClaimsPay Adjuster App and select the insured/claimant's payment method.

🚧

Virtual Card is a vendor specific payment method and is not specified in CreatePaymentMaster. The vendor's preferred payment method in the vendor portal will be used unless "PMETHOD": "Check" is specified.


Response Body Parameters


ParameterConditionalDescription
PM_PaymentID
string
Unique identifier for this payment from the call originating system.
PM_Status
string
Current payment status.

Expected Values: Pending, Pending Approval, In Progress, Submitted to Payment Gateway, Error, Issued, Success. View Payment Status Details
PMETHOD_Stored
string
ConditionalUnique identifier generated for this payment method by the ClaimsPay system. This identifier is used for subsequent payments.

This will not be in response for check payments.
PM_Id
string
Unique identifier generated for each payment request by ClaimsPay v3 system.

PM_PaymentMethod
string
The payment method. See PMETHOD (Payment Method) Values above for more details.
Status
string
The status of the CreatePaymentMaster call.

Expected Values: "Success", "Error"
PM_TranId
string
ConditionalUnique identifier generated for each payment by ClaimsPay v3 system for Issued/Successful payments. Will be Check Number in the case of check payment. Present when a PM_Status is "Issued" or Success"

Example value: 15746704100028540
Error Code
int
ConditionalError Code

Present only when an error has occured.
Error Message
string
ConditionalDetailed error message. See CreatePaymentMaster Error Codes below for more details.

Present only when an error has occured.

CreatePaymentMaster Error Codes

Error_CodeError_Message
1PM_PaymentType is required
2PM_PaymentType is not valid
3PM_Amount is required
4PMA_Street is required
5PMA_City is required
6PMA_State is required
7PMA_Zipcode is required
8PMA_Country is required
9PA_Street is required
10PA_City is required
11PA_State is required
12PA_Zipcode is required
13PA_Country is required
14PM_LoanAccountNumber is required
15PM_AdjustersWorksheet is required
16PM_LoanAccountNumber is required
17CL_ClaimNumber is required
18PCON_ContactId is required
19Cannot associate Primary Contact for Stored Payment
20PCON_FirstName is required
21PCON_LastName is required
22Cannot associate Secondary Contact for Stored Payment
23SCON_FirstName is required
24SCON_LastName is required
25BUS_BusinessId is required
26Mortgagee is not valid
27BUS_Name is required
28BUS_Type is required
29BUS_Type is not valid
30Payment Mode for PMETHOD_Stored is required
31Stored Payment Mode is not associated to correct Primary Contact
32Stored Payment Mode is not associated to correct Secondary Contact
33PMETHOD is required
34PCON_EmailAddress is required
35SCON_EmailAddress is required
36PMETHOD_IC_ProxyNumber is required
37PMETHOD_DC_CardNumber is required
38PMETHOD_DC_ExpMonth is required
39PMETHOD_DC_ExpYear is required
40PMETHOD_DD_AccountNumber is required
41PMETHOD_DD_RoutingNumber is required
42PMETHOD_DD_RoutingNumber is not valid
43PMETHOD_DD_AccountType is required
44PMETHOD_DD_AccountType is not valid
45Session Error
46Adjusters Worksheet upload error
47PM_PaymentID is required
48Duplicate payment request
49Primary and Secondary Contacts must be different
50CarrierId is required
51FundingAccountId is required
52FundingAccountId is not valid
53Stored Payment Mode type is not valid
54Stored Payment Mode status is not verified or is in error
55Stored Payment Mode is not associated to correct Vendor
56Stored Payment Mode is not associated to correct Carrier
57PCON_MobilePhone is required
58SCON_MobilePhone is required
59PM_UserId is required
60PM_User_LastName is required
61PM_User_FirstName is required
62PM_User_EmailAddress is required
63PMETHOD is not valid
64PM_Amount is not valid
65CL_DateofLoss is not valid
66PCON_MobilePhone is not valid
67PCON_EmailAddress is not valid
68PCON_SSN is not valid
69PCON_DOB is not valid
70SCON_MobilePhone is not valid
71SCON_EmailAddress is not valid
72SCON_SSN is not valid
73SCON_DOB is not valid
74BUS_Fax is not valid
75BUS_State is not valid
76BUS_State is not valid
77BUS_Zipcode is not valid
78BUS_Country is not valid
79BUS_TIN is not valid
80BUS_TINType is not valid
81BUS_SubType is not valid
82PMA_State is not valid
83PMA_Zipcode is not valid
84PMA_Country is not valid
85PA_State is not valid
86PA_Zipcode is not valid
87PA_Country is not valid
88PMETHOD_IC_ProxyNumber is not valid
89PMETHOD_DD_AccountNumber is not valid
90PMETHOD_DD_RoutingNumber is not valid
91PMETHOD_DC_CardNumber is not valid
92PMETHOD_DC_ExpYear(Month) is not valid
93PM_PaymentID Incorrect
94PA_City is not valid
95PCON_FirstName is not valid
96PCON_LastName is not valid
97SCON_FirstName is not valid
98SCON_LastName is not valid
99PM_LoanAccountNumber is not valid
100BUS_Fax is required
101BUS_EmailAddress is required
102PMA_City is not valid
103BUS_NAME is Invalid or Exceeds 180 characters
104Vendor Subtype Doesnot Exist
105PM_RequestReason is required
106CL_CauseofLoss is required
107CL_DateofLoss is required
108CL_PolicyNumber is required
109PMETHOD_DD_AccountNumber length should not be less than 6 digits
110PM_CarrierId is not valid
111Amount not in Min/Max limit
112Invalid PMETHOD_DD_AccountNumber
113Secondary contact is not allowed
114This payment method is not allowed
115Group Payment Error
116This payment has reached your daily maximum limit
117This payment has reached your authority limit
118Payee name is required
119PM_Additional_Text_3 is not valid
120PM_DocCount is not valid