Paya Connect docs

Submitting a Merchant API Integration Application

This page defines key value fields, lists field restrictions, and describes the steps to submit the Merchant API Integration application and provides examples of the schema as a reference for required key values. Your application may contain different or additional key values.

Fields

The following table describes all of the available fields available for use on the Merchant API Integration Endpoint. You can use the tabs at the top of the table to reveal additional details about the fields including what Actions a field is applicable to, as well as whether a field is required (R), optional (O), conditional (C) or not required (N) for each of the Endpoint Actions.

Field Definitions

The table below lists the fields for the key values and their structure.

Note: Not all field values are applicable to each field. Some fields may have a drop-down menu with a list of required options. The field values may vary depending on the specific offer.

Application

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

offerId

UUID Version 4

 32 32 ✔ ✔      

userId

 UUID Version 4 32 32 ✔ ✔      

 

Answers

businessOwnership

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

ownershipType

 string       ✔ ✔ Yes*

Array: C Corporation, Government (Fed,St,Local), LLC- C Corp, LLC- Disregarded Entity, LLC- Partnership, LLC- S Corp, LLC- Sole Proprietor, Non-Profit, Non-US Entity, Partnership, S Corporation, Sole Proprietor, Trust/Estate.

See Key Value Field Requirements table.

*Editable fields may vary depending on specific offer.

businessIndustry

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

industryType

 string 2 128   ✔ ✔ Yes* Enumerated list of what is allowable. The list may be restricted based on the specific offer.

industrySic

 string 2 128   ✔ ✔ Yes* Enumerated list of what is allowable. The list may be restricted based on the specific offer.

*Editable fields may vary depending on specific offer.

customerConsent

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

secCodes

 string 2 16   ✔ ✔ Yes*

 

*Editable fields may vary depending on specific offer.

owner1Information, owner2Information, owner3Information, and owner4Information

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

title

 string       ✔ ✔ Yes* See Key Value Field Requirements table.

firstName

 string 2 25   ✔ ✔ Yes*  

lastName

 string 2 25   ✔ ✔ Yes*  

address

 string 2 35   ✔ ✔ Yes*  

unit

 string 2 10   ✔ ✔ Yes*  

city

 string 2 25   ✔ ✔ Yes*  

state

 string 2 2   ✔ ✔ Yes* See Key Value Field Requirements table.

zipCode

 string       ✔ ✔ Yes* Valid U.S. zip codes. Valid patterns include five digit, nine digit, and five digit-four digits.

dateOfBirth

 string       ✔ ✔ Yes* Pattern: ^d{4}-d{2}-d{2}$

socialSecurityNumber

 string       ✔ ✔ Yes* Pattern: ^d{9}$

driversLicenseNumber

 string 5 16   ✔ ✔ Yes*  

phoneNumber

 string       ✔ ✔ Yes* Pattern: ^d{10}$

faxNumber

 string       ✔ ✔ Yes* Pattern: ^d{10}$

emailAddress

 string       ✔ ✔ Yes* Valid email address.

*Editable fields may vary depending on specific offer.

ownerEquity

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

owner1

 number       ✔ ✔ Yes* Positive value less than 100.

owner2

 number       ✔ ✔ Yes* Positive value less than 100.

owner3

 number       ✔ ✔ Yes* Positive value less than 100.

owner4

 number       ✔ ✔ Yes* Positive value less than 100.

*Editable fields may vary depending on specific offer.

organizationInformation

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

organizationName

 string 2 128   ✔ ✔ Yes*  

employeeIdentificationNumber

 string       ✔ ✔ Yes* Pattern: ^d{2}-d{7}$

website

 string       ✔ ✔ Yes* Valid URL protocol required. Examples: http://www.example.com/ and https://www.example.com/

*Editable fields may vary depending on specific offer.

organizationContact

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

title

 string       ✔ ✔ Yes* See Key Value Field Requirements table.

firstName

 string 2 25   ✔ ✔ Yes*  

lastName

 string 2 25   ✔ ✔ Yes*  

phoneNumber

 string       ✔ ✔ Yes* Pattern: ^d{10}$

emailAddress

 string       ✔ ✔ Yes* Valid email address.

*Editable fields may vary depending on specific offer.

organizationLocation

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

address

 string 2 35   ✔ ✔ Yes*  

unit

 string 2 10   ✔ ✔ Yes*  

city

 string 2 25   ✔ ✔ Yes*  

state

 string 2 2   ✔ ✔ Yes* See Key Value Field Requirements table.

zipCode

 string       ✔ ✔ Yes* Valid U.S. zip codes. Valid patterns include five digit, nine digit, and five digit-four digits.

phoneNumber

 string       ✔ ✔ Yes* Pattern: ^d{10}$

*Editable fields may vary depending on specific offer.

organizationAddress

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

address

 string 2 35   ✔ ✔ Yes*  

unit

 string 2 10   ✔ ✔ Yes*  

city

 string 2 25   ✔ ✔ Yes*  

state

 string 2 2   ✔ ✔ Yes* See Key Value Field Requirements table.

zipCode

 string       ✔ ✔ Yes* Valid U.S. zip codes. Valid patterns include five digit, nine digit, and five digit-four digits.

phoneNumber

 string       ✔ ✔ Yes* Pattern: ^d{10}$

*Editable fields may vary depending on specific offer.

bankInformation

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

routingNumber

 string 9 9   ✔ ✔ Yes*  

accountNumber

 string 1 17   ✔ ✔ Yes*  

accountNumberReEnter

 string 1 17   ✔ ✔ Yes*  

bankName

 string 2 128   ✔ ✔ Yes*  

*Editable fields may vary depending on specific offer.

salesInformation

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments

monthlyVolume

 number   999999999.99   ✔ ✔ Yes* See Key Value Field Requirements table.

averageTicket

 number   999999999.99   ✔ ✔ Yes* See Key Value Field Requirements table.

highestTicket

 number   999999999.99   ✔ ✔ Yes* See Key Value Field Requirements table.

amexAnnualVolume

 number   999999999.99   ✔ ✔ Yes* See Key Value Field Requirements table.

amexMarketingOptOut

 boolean       ✔ ✔ Yes* Example: true

*Editable fields may vary depending on specific offer.

 

Signature

After the application has been accurately completed, it must be signed and submitted. The table below lists the fields for the application key values and their structure.

Fields

Format

Min

Max

POST Required

POST Allowed

PUT Allowed

Edit

Comments
signatureType varchar     ✔ ✔     See Key Value Field Requirements table.

eConsent

 boolean     ✔ ✔     Example: true

name

 string     ✔ ✔     The full name of the signer.

ipAddress

 string     ✔ ✔     The IP address used by the signer. May be either v4 or v6 formatted. Must be a public IP.

timestamp

 ISO Standard     ✔      

Pattern: yyyy-mm-ddThh:mm:ss.s+zzzzzz

Example: 2020-10-15T00:05:32.000Z

 

Key Value Field Requirements

The Key Value Field Requirements table lists specific enumerating restrictions for certain key values in the application. Use these requirements as they apply to your application. Failure to follow the requirements for these values will result in errors for the application submission. Enter the applicable key values using the Key Value Requirements column.

Field Type

Field Name

Key Value Field Requirements
businessOwnership SOLE_PROPRIETOR “Sole Proprietorship”
LLC_SOLE_PROPRIETOR “LLC Sole Proprietorship”
LLC “Limited Liability Corporation”
NON_PROFIT “Non-Profit”
NON_US_ENTITY “Non-US Entity”
PARTNERSHIP “Partnership”
LLC_PARTNERHIP “LLC Partnership”
CORPORATION “Corporation”
C_CORPORATION “C Corporation”
LLC_C_CORPORATION “LLC C Corporation”
S_CORPORATION “S Corporation”
LLC_S_CORPORATION “LLC S Corporation”
TRUST_ESTATE “Trust/Estate”
salesInformation FIRST “1  –  10000”
SECOND “10001  –  25000”
THIRD “25001  –  50000”
FOURTH “50001  –  100000”
FIFTH “100001  –  250000”
SIXTH “250001  –  500000”
SEVENTH “GREATER THAN 500000”
FIRST “LESS THAN 100”
SECOND “101  -  1000”
THIRD “GREATER THAN 1000”
FIRST “0  -  9999”
SECOND “10000  -  49999”
THIRD “50000  -  99999”
FOURTH “100000  -  249999”
FIFTH “250000+”
FIRST “1  -  10000”
SECOND “10001  -  25000”
THIRD “25001  -  50000”
FOURTH “50001  -  100000”
FIFTH “1000001  -  250000”
SIXTH “250001  -  500000”
SEVENTH “GREATER THAN 500000”

ownership1Information

ownershipt2Information

ownership3Information

ownership4Information

organizationContact

 MR “Mr.”
MRS “Mrs.”
MISS “Miss”
MS “Ms.”
DR “Dr.”
PRESIDENT “President”
CEO “CEO”

ownership1Information

ownershipt2Information

ownership3Information

ownership4Information

organizationLocation

organizationAddress

 

 AL “AL”
AK “AK”
AS “AS”
AZ “AZ”
AR “AR”
CA “CA”
CO “CO”
CT “CT”
DE “DE”
DC “DC”
FM “FM”
FL “FL”
GA “GA”
GU “GU”
HI “HI”
ID “ID”
IL “IL”
IN “IN”
IA “IA”
KS “KS”
KY “KY”
LA “LA”
ME “ME”
MH “MH”
MD “MD”
MA “MA”
MI “MI”
MN “MN”
MS “MS”
MO “MO”
MT “MT”
NE “NE”
NV “NV”
NH “NH”
NJ “NJ”
NM “NM”
NY “NY”
NC “NC”
ND “ND”
MP “MP”
OH “OH”
OK “OK”
OR “OR”
PW “PW”
PA “PA”
PR “PR”
RI “RI”
SC “SC”
TN “TN”
TX “TX”
UT “UT”
VT “VT”
VI “VI”
VA “VA”
WA “WA”
WV “WV”
WI “WI”
WY “WY”
signatureType bankcardDisclosure "bankcardDisclosure"
bankcardPersonalGurantee "bankcardPersonalGurantee"
achPersonalGurantee "achPersonalGurantee"
eConsent "eConsent"

Endpoint Actions

Endpoint actions are used to submit the API integration application and provides examples of the schema as a reference for required key values. Your application may contain different or additional key values.

Boarding API sandbox URL: boarding.sandbox.payaconnect.com. 

Get an Offer Details

The first endpoint action to complete the application process is to obtain your IDs. This section lists the steps to complete this action.  

  1. Perform GET /v1/offer/vanityurl/{vanityUrl} Get a List of Offer details.
    A list of offers are displayed.
  2. Find the applicable OfferID for your application request.

GET /v1/offer/vanityurl/{vanityUrl}

{
  "offerId": "938c5b76-73f4-43a1-a0db-272295ae7436",
  "name": "Bob's Quick Sales",
  "verticalName": "Food Joints",
  "partnerId": "ea508f8d-c82c-4076-85de-43733e1485e3",
  "verticalPresetId": "70670bd6-271b-459c-8cb3-46f230c22903",
  "pricingBundleId": "00670bd6-371b-459c-8cb3-56f230c22903",
  "vanityUrl": "bobsburgers",
  "vanityDomain": "reallygoodburgers.com",
  "presentationalState": {
    "name": "Bobs Burgers",
    "pages": [
      [
        {
          "name": "pageHeader",
          "header": "Tell Us About Your burgers",
          "shortHeader": "Business Type"
        },
        {
          "name": "businessOwership",
          "options": {
            "ownershipType": [
              {
                "1": "C Corporation"
              },
              {
                "2": "Government (Fed,St,Local)"
              },
              {
                "3": "LLC- C Corp"
              }
            ]
          }
        },
        {
          "name": "businessIndustry",
          "options": {
            "industryType": [
              {
                "72": "72 - Butchers"
              },
              {
                "93": "93 - Farmers"
              }
            ],
            "industrySic": [
              {
                "8011": "8011 - Fast Food"
              },
              {
                "8021": "8021 - Food Services"
              }
            ]
          }
        },
        {
          "name": "customerConsent",
          "options": {
            "secCodes": [
              {
                "PPD/CCD": "Signed written authorization"
              },
              {
                "WEB": "Customer initiated debits online"
              }
            ]
          }
        }
      ],
      [
        {
          "name": "pageHeader",
          "header": "Tell Us About Your Joint Owner",
          "shortHeader": "Ownership",
          "subHeader": "Enter all Owners with ownership greater than 25%"
        },
        {
          "name": "owner1Information",
          "active": {
            "driversLicense": false
          }
        },
        {
          "name": "owner2Information",
          "active": {
            "driversLicense": false,
            "faxNumber": false
          }
        }
      ],
      [
        {
          "name": "pageHeader",
          "header": "Tell us more about your burgers",
          "shortHeader": "Business Info"
        },
        {
          "name": "organizationInformation"
        },
        {
          "name": "organizationContact"
        },
        {
          "name": "organizationLocation",
          "label": "Practice Location address"
        },
        {
          "name": "organizationAddress",
          "label": "Corporate/HQ Address"
        },
        {
          "name": "salesInformation"
        }
      ],
      [
        {
          "name": "pageHeader",
          "header": "Bank Information",
          "shortHeader": "Bank Information",
          "subHeader": "Please provide your bank account and routing number to allow funds to be deposited into your account."
        },
        {
          "name": "bankInformation",
          "active": {
            "bankAccountType": false
          }
        }
      ],
      [
        {
          "name": "pageHeader",
          "shortHeader": "Review"
        },
        {
          "name": "applicationReview"
        },
        {
          "name": "offerReview",
          "data": {
            "products": {
              "bankcard": [
                {
                  "feeType": "Per Transaction Fee",
                  "cost": "$0.30"
                },
                {
                  "feeType": "Per Keyed-In Discount Rate %",
                  "cost": "2.99%"
                },
                {
                  "feeType": "Chargeback Fee",
                  "cost": "$15.00"
                }
              ],
              "ach": [
                {
                  "feeType": "Per Transaction Fee*",
                  "cost": "1.00"
                },
                {
                  "feeType": "% Discount Rate*",
                  "cost": "1.00"
                },
                {
                  "feeType": "Chargeback Fee",
                  "cost": "25.00"
                },
                {
                  "feeType": "% Discount Rate Premium**",
                  "cost": "0.10"
                },
                {
                  "feeType": "Return Fee",
                  "cost": "4.00"
                }
              ],
              "solutionIncludes": [
                "Paya Connect Integrated"
              ],
              "agreementTerms": "3 Years"
            },
            "footers": [
              "* All transactions under $100 will be charged a $1 minimum transaction fee",
              "** % Discount Rate premium is an additional fee for transactions above $10,000"
            ]
          }
        },
        {
          "name": "termsAndConditionsSignature",
          "data": "Terms and condition text ...."
        }
      ],
      [
        {
          "name": "pageHeader",
          "header": "Thank You!",
          "shortHeader": "Thank You",
          "subHeader": "Please retain a copy of this page for your records. This confirms submission of your merchant application."
        },
        {
          "name": "applicationReviewThankYou"
        },
        {
          "name": "offerThankYou"
        }
      ]
    ]
  },
  "keysAllowable": [
    "businessOwnership.ownershipType",
    "businessIndustry.industrySic",
    "businessIndustry.industryType",
    "customerConsent.secCodes",
    "owner1Information.title",
    "owner1Information.firstName",
    "owner1Information.lastName",
    "owner1Information.address"
  ],
  "keysDefaultValue": {},
  "keysFixedValue": {
    "meta.associationName": "Acme Partners"
  },
  "keysRequiredValue": [
    "businessOwnership.ownershipType",
    "businessIndustry.industrySic",
    "businessIndustry.industryType",
    "customerConsent.secCodes",
    "owner1Information.title"
  ],
  "isActive": true,
  "isPublished": false,
  "publishedAt": "2021-01-14T17:35:38.362Z",
  "createdAt": "2021-01-14T17:35:38.362Z"
}

Create an Application

The second endpoint action is to create your application. This section lists the steps to complete this action.

  1. Perform POST /v1/application Create an Application with or without answers.
  2. Enter the applicable values and submit.

POST /v1/application

{
  "offerId": "995a3ac3-4b4c-49c4-a9a5-4e997ab888ef",
  "userId": "995a3ac3-4b4c-49c4-a9a5-4e997ab888ef",
  "answers": {}
}

{
  "applicationId": "00d8fc88-a0ca-45b7-b96b-9f5d99316da4",
  "verticalPresetId": "00da5e80-fce6-49f0-8a6f-b63b4870cce6",
  "offerId": "995a3ac3-4b4c-49c4-a9a5-4e997ab888ef",
  "status": "0",
  "source": "API",
  "createdAt": "2020-10-09T17:06:54.844Z",
  "answers": {
    "businessOwnership": {
      "ownershipType": "Sole Proprietor"
    },
    "businessIndustry": {
      "industrySic": "1234",
      "industryType": "23"
    },
    "owner1Information": {
      "city": "Atlanta",
      "address": "303 Perimeter Center",
      "state": "GA",
      "unit": "#500",
      "zipCode": "30346",
      "firstName": "Robert",
      "lastName": "Smith",
      "phoneNumber": "202-555-0140",
      "title": "Dr",
      "emailAddress": "example@example.com",
      "faxNumber": "123-555-9876",
      "dateOfBirth": "1960-01-01T00:00:00.000Z"
    },
    "owner2Information": {
      "city": "Atlanta",
      "address": "303 Perimeter Center",
      "state": "GA",
      "unit": "#500",
      "zipCode": "30346",
      "firstName": "Robert",
      "lastName": "Smith",
      "phoneNumber": "202-555-0140",
      "title": "Dr",
      "emailAddress": "example@example.com",
      "faxNumber": "123-555-9876",
      "dateOfBirth": "1960-01-01T00:00:00.000Z"
    },
    "owner3Information": {
      "city": "Atlanta",
      "address": "303 Perimeter Center",
      "state": "GA",
      "unit": "#500",
      "zipCode": "30346",
      "firstName": "Robert",
      "lastName": "Smith",
      "phoneNumber": "202-555-0140",
      "title": "Dr",
      "emailAddress": "example@example.com",
      "faxNumber": "123-555-9876",
      "dateOfBirth": "1960-01-01T00:00:00.000Z"
    },
    "owner4Information": {
      "city": "Atlanta",
      "address": "303 Perimeter Center",
      "state": "GA",
      "unit": "#500",
      "zipCode": "30346",
      "firstName": "Robert",
      "lastName": "Smith",
      "phoneNumber": "202-555-0140",
      "title": "Dr",
      "emailAddress": "example@example.com",
      "faxNumber": "123-555-9876",
      "dateOfBirth": "1960-01-01T00:00:00.000Z"
    },
    "ownerEquity": {
      "owner1": 100,
      "owner2": 0,
      "owner3": 0,
      "owner4": 0
    },
    "organizationInformation": {
      "organizationName": "ACME, Inc.",
      "employerIdentificationNumber": "12-3456789",
      "website": "http://www.example.com/"
    },
    "organizationContact": {
      "firstName": "Robert",
      "lastName": "Smith",
      "phoneNumber": "202-555-0140",
      "title": "Dr",
      "emailAddress": "example@example.com"
    },
    "organizationLocation": {
      "address": "303 Perimeter Center",
      "unit": "Suite 400",
      "city": "Atlanta",
      "state": "GA",
      "zipCode": "30346",
      "phoneNumber": "123-456-7890"
    },
    "organizationAddress": {
      "address": "303 Perimeter Center",
      "unit": "Suite 400",
      "city": "Atlanta",
      "state": "GA",
      "zipCode": "30346",
      "phoneNumber": "123-456-7890"
    },
    "salesInformation": {
      "monthlyVolume": 200,
      "averageTicket": 5,
      "highestTicket": 20,
      "amexAnnualVolume": 500,
      "amexMarketingOptOut": true
    },
    "bankInformation": {
      "routingNumber": "123456789",
      "accountNumber": "987654321",
      "accountNumberReEnter": "987654321",
      "bankName": "First Bank of Georgia"
    }
  }
}

Validate Application

The third endpoint action is to validate your application look for any missing values or errors. This section lists the steps to complete this action.

  1. Perform GET /v1/application/{applicationID}/validate Validates that an Application is complete.
  2. Review response for errors.

GET /v/application/{application}/validate

{
  "errors": [
    {
      "errorCode": "MISSING_FIELD_VALUE",
      "field": "Owner Name",
      "message": "Required value is missing"
    }
  ]
}

Update Missing Key Values

A potential endpoint action for the application process is to update missing or inaccurate key values. This section lists the steps to complete this action.

Note: This action overrides all key value data that was previously saved to the application when used.

  1. Perform PUT /v1/application/{applicationID} Provide all app answers as a first or updated revision.

Note: If all key values have been entered and there are no errors, skip this step and proceed to Review Signature and Publish Application steps.

  1. Confirm all required key values have been entered and saved.

PUT /v1/application/{applicationID}

{
  "businessOwnership": {
    "ownershipType": "C Corporation"
  },
  "businessIndustry": {
    "industryType": "38 - Electrical Contractor",
    "industrySic": "1731 - Electrical Contracting"
  },
  "customerConsent": {
    "secCodes": ""
  },
  "owner1Information": {
    "title": "Mr",
    "firstName": "Joseph",
    "lastName": "Smith",
    "address": "1600 Pennsylvania Avenue",
    "unit": "Unit 5",
    "city": "Atlanta",
    "state": "GA",
    "zipCode": "30346",
    "dateOfBirth": "1950-10-15",
    "socialSecurityNumber": "123456789",
    "driversLicenseNumber": "ABC123456789",
    "driversLicenseState": "GA",
    "phoneNumber": "1235559876",
    "faxNumber": "1235559876",
    "emailAddress": "example@example.com"
  },
  "owner2Information": {
    "title": "Mr",
    "firstName": "Joseph",
    "lastName": "Smith",
    "address": "1600 Pennsylvania Avenue",
    "unit": "Unit 5",
    "city": "Atlanta",
    "state": "GA",
    "zipCode": "30346",
    "dateOfBirth": "1950-10-15",
    "socialSecurityNumber": "123456789",
    "driversLicenseNumber": "ABC123456789",
    "driversLicenseState": "GA",
    "phoneNumber": "1235559876",
    "faxNumber": "1235559876",
    "emailAddress": "example@example.com"
  },
  "owner3Information": {
    "title": "Mr",
    "firstName": "Joseph",
    "lastName": "Smith",
    "address": "1600 Pennsylvania Avenue",
    "unit": "Unit 5",
    "city": "Atlanta",
    "state": "GA",
    "zipCode": "30346",
    "dateOfBirth": "1950-10-15",
    "socialSecurityNumber": "123456789",
    "driversLicenseNumber": "ABC123456789",
    "driversLicenseState": "GA",
    "phoneNumber": "1235559876",
    "faxNumber": "1235559876",
    "emailAddress": "example@example.com"
  },
  "owner4Information": {
    "title": "Mr",
    "firstName": "Joseph",
    "lastName": "Smith",
    "address": "1600 Pennsylvania Avenue",
    "unit": "Unit 5",
    "city": "Atlanta",
    "state": "GA",
    "zipCode": "30346",
    "dateOfBirth": "1950-10-15",
    "socialSecurityNumber": "123456789",
    "driversLicenseNumber": "ABC123456789",
    "driversLicenseState": "GA",
    "phoneNumber": "1235559876",
    "faxNumber": "1235559876",
    "emailAddress": "example@example.com"
  },
  "ownerEquity": {
    "owner1": 50,
    "owner2": 25,
    "owner3": 25,
    "owner4": 0
  },
  "organizationInformation": {
    "organizationName": "ACME, Inc.",
    "employerIdentificationNumber": "12-3456789",
    "website": "http://www.example.com/"
  },
  "organizationContact": {
    "title": "Mr",
    "firstName": "Joseph",
    "lastName": "Smith",
    "phoneNumber": "1234567890",
    "emailAddress": "example@example.com"
  },
  "organizationLocation": {
    "address": "1600 Pennsylvania Avenue",
    "unit": "Unit 5",
    "city": "Atlanta",
    "state": "GA",
    "zipCode": "30346",
    "phoneNumber": "18002255288"
  },
  "organizationAddress": {
    "address": "1600 Pennsylvania Avenue",
    "unit": "Unit 5",
    "city": "Atlanta",
    "state": "GA",
    "zipCode": "30346",
    "phoneNumber": "1235559876"
  },
  "bankInformation": {
    "routingNumber": "1234567890",
    "accountNumber": "1234567890",
    "accountNumberReEnter": "1234567890",
    "bankName": "Bank of America"
  },
  "salesInformation": {
    "monthlyVolume": 15000,
    "averageTicket": 250,
    "highestTicket": 25000,
    "amexAnnualVolume": 0,
    "amexMarketingOptOut": true
  }
}

Save Signature and Publish Application

The final endpoint action to complete the application process is to review the merchant signature and publish your application. This section lists the steps to complete this action.

  1. Perform POST /v1/application/{applicationID}/signature Save signature data and then publish application to subscribed services.
  2. Confirm key values are complete and accurate.

Note: The Paya Boarding API checks that the submitted signature value matches a combination of the organizationContact.firstName and the organizationContact.lastName. If the values do not match, your signature attempt will fail.

Your application is sent to Underwriting for review and processing.

POST /v1/application/{applicationID}/signature

[
  {
    "signatureType": "overall",
    "eConsent": true,
    "name": "John Adams",
    "ipAddress": "8.8.8.8",
    "timestamp": "2020-02-15T00:05:32.000Z"
  },
  {
    "signatureType": "ach",
    "eConsent": true,
    "name": "John Adams",
    "ipAddress": "8.8.8.8",
    "timestamp": "2020-02-15T00:05:32.000Z"
  },
  {
    "signatureType": "bankcard",
    "eConsent": true,
    "name": "John Adams",
    "ipAddress": "8.8.8.8",
    "timestamp": "2020-02-15T00:05:32.000Z"
  }
]
[
  {
    "signatureType": "overall",
    "eConsent": true,
    "name": "John Adams",
    "ipAddress": "8.8.8.8",
    "timestamp": "2020-02-15T00:05:32.000Z"
  },
  {
    "signatureType": "ach",
    "eConsent": true,
    "name": "John Adams",
    "ipAddress": "8.8.8.8",
    "timestamp": "2020-02-15T00:05:32.000Z"
  },
  {
    "signatureType": "bankcard",
    "eConsent": true,
    "name": "John Adams",
    "ipAddress": "8.8.8.8",
    "timestamp": "2020-02-15T00:05:32.000Z"
  }
]

See Boarding Experience Merchant API Integration.