Tax Payer

Get Taxpayer Details (v2.0)

get

Retrieve taxpayer details for the merchant identified by merchantNumber.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

encryptedTinbooleanOptional

Specifies whether to return the Taxpayer Identification Number (TIN) in encrypted format. Defaults: false.

Default: false

Responses

200

Returns a Taxpayer's details successfully.

application/json

204

No content.

400

Bad Request: If merchant number is null or empty. Or URL refers to an obsolete version of API.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found: Taxpayer details not found.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v2/Taxpayers/{merchantNumber}

HTTPcURLJavaScriptPython

GET /api/demographics/v2/Taxpayers/{merchantNumber} HTTP/1.1
Host: 
Accept: */*

{
  "legalFirstName": "John",
  "legalLastName": "Doe",
  "tin": "123456789",
  "encryptedTIN": "[****3433, ****4485]",
  "tinLastFour": "4673",
  "tinTypeID": "2",
  "businessLegalName": "Acme Corporation",
  "stateIncorporatedCode": "CA"
}

Update Taxpayer Details (v2.0)

put

Update the taxpayer details for the merchant identified by merchantNumber.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

encryptedTinbooleanOptional

Specifies whether to return the Taxpayer Identification Number (TIN) in encrypted format. Defaults: false.

Default: false

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

legalFirstNamestring | nullableOptional

First name of the tax payer.

Example: John

legalLastNamestring | nullableOptional

Last name of the tax payer.

Example: Doe

tinstring · min: 9 · max: 9Required

Taxpayer Identification Number (TIN). Must be exactly 9 characters long.

Example: 123456789

encryptedTINstring · byte | nullableOptional

Encrypted representation of the TIN for security purposes.

Example: [****3433, ****4485]

tinLastFourstring | nullableRead-onlyOptional

Represents last fout digits of TIN number

Example: 4673

tinTypeIDstring · min: 1 · max: 3Required

Identifier for the type of TIN. Must be between 1 and 3.

Example: 2

businessLegalNamestring · min: 1Required

The legal name of the business associated with the taxpayer.

Example: Acme Corporation

stateIncorporatedCodestring | nullableOptional

The state where the business is incorporated. Represented as a two-character code.

Example: CA

Responses

200

Saves a Taxpayer successfully.

application/json

202

Accepted: Request change was accepted.

application/json

400

Bad Request: If merchant number is null or empty, or data is invalid. Or URL refers to an obsolete version of API.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

404

Not Found:: Resource not found exception.

application/json

409

Conflict: Request change was rejected because there is another one.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

put

/api/demographics/v2/Taxpayers/{merchantNumber}

HTTPcURLJavaScriptPython

PUT /api/demographics/v2/Taxpayers/{merchantNumber} HTTP/1.1
Host: 
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 187

{
  "legalFirstName": "John",
  "legalLastName": "Doe",
  "tin": "123456789",
  "encryptedTIN": "[****3433, ****4485]",
  "tinTypeID": "2",
  "businessLegalName": "Acme Corporation",
  "stateIncorporatedCode": "CA"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "legalFirstName": "John",
  "legalLastName": "Doe",
  "tin": "123456789",
  "encryptedTIN": "[****3433, ****4485]",
  "tinLastFour": "4673",
  "tinTypeID": "2",
  "businessLegalName": "Acme Corporation",
  "stateIncorporatedCode": "CA"
}