Retrieve host processor configuration

Browse API reference

GET/processing-terminals/{processingTerminalId}/host-configurationsgetProcessingTerminalHostConfiguration

Use this method to retrieve the host processor configuration of a processing terminal. Integrate with this method only if you use your own gateway and want to validate the processor configuration.

Our gateway returns the configuration settings for the merchant and the payment terminal.

Parameters

Name	In	Type	Description
`processingTerminalId`Required	path	`string`	Unique identifier that we assigned to the terminal.

Responses

Successful request. Returns the host configuration of the processing terminal.

200 OK · application/json

{
  "configuration": {
    "merchant": {
      "abaNumber": "967854108",
      "agentBankNumber": "000001",
      "binNumber": "888888",
      "chainNumber": "222222",
      "locationNumber": "000001",
      "posMid": "123456789101",
      "reimbursementAttribute": "Z",
      "settlementAgent": "0001"
    },
    "processor": "tsys",
    "terminal": {
      "authenticationCode": "A1B2C3",
      "cardPresentAllowed": true,
      "internetAllowed": true,
      "motoAllowed": false,
      "sharingGroups": "3E7HULY8NQWZG",
      "terminalId": "V500000",
      "terminalNumber": "1111"
    }
  },
  "processingAccountId": "23451",
  "processingTerminalId": "0123451001"
}

Response schema · 7 of 22 fields

configurationobjectrequired
Polymorphic object that contains the host processor configuration.
- option 1object
  - merchantobjectrequired
    Object that contains the configuration settings for the merchant.+8 more fields at deeper levels — see the full spec
  - processorstringrequired
    Name of the host processor.≤ 50 charstsys
  - terminalobjectrequired
    Object that contains the configuration settings for the terminal.+7 more fields at deeper levels — see the full spec
processingAccountIdstring
Unique identifier that we assigned to the processing account.
processingTerminalIdstringrequired
Unique identifier that our gateway assigned to the terminal.

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

configure-a-device