Skip to content

Integration management

The Integration management operations includes APIs for managing integrations with third-party service providers.

Create an Integration

Request

Create an integration with a third-party service provider, including payment processors, tokenization services, and other payment services.

Security
ApiKeyAuth
Headers
Client-Idstring, (ulid)required
Example:CLIENT-01KFDKXMQ637EKEAY410MSQSXB
X-Acting-As-Client-Idstring, (ulid)

The child client this request acts on behalf of. A reseller still authenticates as itself — Api-Key and Client-Id stay the reseller's — and names the child here.

This works only from a parent to its own children. Merchants have no children, so a merchant calling as itself omits the header. Sending your own client ULID here is not the same as omitting it, and is rejected on some operations.

Example:CLIENT-01KFDKXMQ637EKEAY410MSQSXB
Bodyapplication/json
clientstring or null

The client ID to associate with this integration. Defaults to the caller's client if omitted.

Example:"CLIENT-01KFDKXMQ637EKEAY410MSQSXB"
is_activebooleanrequired

Whether the integration should be active immediately upon creation.

Default:false
Example:true
processorstring(Processor)required

The payment processor or service provider for the integration. Send the value exactly as spelled here. On the integration operations the gateway parses this field case-sensitively, so TSYS is rejected.

Enum ValueDescription
Tsys

TSYS payment processor

Vericheck

Vericheck ACH processor

Example:"Tsys"
integration_detailsTSYS (object) or Vericheck (object)(IntegrationDetailRequest)required
One of:

TSYS processor-specific configuration details for creating a merchant integration.

A complete TSYS host configuration for the merchant. Twenty-nine of these fields are required — the gateway enforces them in TsysHostDetailsValidator — so this payload is close to the minimum a real onboarding needs rather than a generous illustration. The processor-specific identifiers here are illustrative placeholders.

{ "client": "CLIENT-01KFDKXMQ637EKEAY410MSQSXB", "is_active": true, "processor": "Tsys", "integration_details": { "name": "Acme Jewelry LLC", "amex_number": "1234567890", "association": "123456", "bin": "888888", "discover_number": "123456789012345", "dba": "Acme Jewelry", "url": "https://example.apiserver.com", "phone_number": 17035550123, "fax_number": "+17035550199", "mid": "888000001234", "mcc": "5944", "bank_number": "1234", "industry": "R", "amex_opt_blue": true, "agent_chain": "012345", "store_number": "0001", "mvv": "123456", "terminal_number": "0001", "agent_bank_number": "123456", "agent_chain_number": "654321", "descriptor_postal": "22150", "descriptor_city": "Springfield", "descriptor_state": "VA", "descriptor_country": "US", "descriptor_phone": 17035550123, "descriptor_store_number": "0001", "address1": "123 Main St", "address2": "Suite 100", "descriptor_line3": "ACME JEWELRY 703-555-0123", "terminal_id": "00000001", "v_number": "V1234567", "settlement_time": "23:00", "merchant_area_code": 703, "descriptor_area_code": 703, "sharing_group": "AEFGKMQ", "merchant_aba_number": "123456789", "merchant_settlement_agent_number": "1234", "reimbursement_attribute": "0", "fcsid": "12345" } }

Responses

Integration created successfully

Headers
x-request-idstring, (uuid)^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...required

Unique identifier assigned to the request by the API server. Returned on every response, including errors. Log this value and supply it when contacting support so that a specific request can be traced.

Example:"73039bd9-c380-4186-bffe-259125144a56"
Bodyapplication/json
idstring or null

Unique identifier for this integration configuration.

Example:"INTEGRATION-01KFDKXMQ637EKEAY410MSQSXB"
is_activebooleanrequired

Whether the integration is currently active.

Example:true
clientstring or null

The client ID associated with this integration.

Example:"CLIENT-01KFDKXMQ637EKEAY410MSQSXB"
processorstring(Processor)required

The payment processor or service provider for the integration. Send the value exactly as spelled here. On the integration operations the gateway parses this field case-sensitively, so TSYS is rejected.

Enum ValueDescription
Tsys

TSYS payment processor

Vericheck

Vericheck ACH processor

Example:"Tsys"
integration_detailsTSYSHostDetailsResponse (object) or VericheckOnboardingResponse (object)(IntegrationDetailResponse)required
One of:

TSYS processor-specific configuration details returned in integration responses.

correlation_idstring(CorrelationId)

Identifier the gateway assigns to the request and carries across the services that handled it. Quote it when reporting a problem.

Example:"01KFDKXMQ637EKEAY410MSQSXB"
Response

The stored configuration, echoing back what was submitted and adding the id to reference it, the network identifiers TSYS assigns during onboarding (amex_number, discover_number, association, bin), and the audit fields.

{ "id": "INTEGRATION-01KFDKXMQ637EKEAY410MSQSXB", "is_active": true, "client": "CLIENT-01KFDKXMQ637EKEAY410MSQSXB", "processor": "Tsys", "integration_details": { "name": "Acme Jewelry LLC", "dba": "Acme Jewelry", "url": "https://example.apiserver.com", "phone_number": 17035550123, "fax_number": "+17035550199", "mid": "888000001234", "amex_number": "1234567890", "association": "VISA", "bin": "431940", "discover_number": "601100999999", "mcc": "5944", "bank_number": "1234", "industry": "R", "amex_opt_blue": true, "agent_chain": "012345", "store_number": "0001", "mvv": "123456", "terminal_number": "0001", "agent_bank_number": "123456", "agent_chain_number": "654321", "descriptor_postal": "22150", "descriptor_city": "Springfield", "descriptor_state": "VA", "descriptor_country": "US", "descriptor_phone": 17035550123, "descriptor_store_number": "0001", "address1": "123 Main St", "address2": "Suite 100", "descriptor_line3": "ACME JEWELRY 703-555-0123", "terminal_id": "00000001", "v_number": "V1234567", "settlement_time": "23:00", "merchant_area_code": 703, "descriptor_area_code": 703, "sharing_group": "AEFGKMQ", "merchant_aba_number": "123456789", "merchant_settlement_agent_number": "1234", "reimbursement_attribute": "0", "fcsid": "12345", "created_by": 1042, "created_at": "2026-02-11T09:24:17Z", "modified_by": 1042, "modified_at": "2026-06-30T14:02:51Z" }, "correlation_id": "01KFDKXMQ637EKEAY410MSQSXB" }