Sign in
latestOpenAPI 3.0.22026-08-131303812.1 MB

3173732208e4

Gateway Integrations

Fetch a Gateway Integration

Retrieve the details of an existing Gateway Integration.

get/gateway_integrations/{gateway_integration_id}

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

A single Gateway Integration

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

application_idstring

ID of the Application the resource was created under.

linked_tostring

The ID of the Merchant to which the Gateway Integration is linked.

linked_type'MERCHANT'

The type of resource to which the Gateway Integration is linked.

emailstring email

The email address to receive the Cybersource dashboard invitation, which lets you retrieve your Cybersource transacting credentials. If this field was not provided, the invitation will be sent to the email address associated with the merchant's email address defined in Identity › entity.email field.

state'FAILED' | 'PENDING' | 'SUCCEEDED'

The state of the Gateway Integration. The possible values are:

  • PENDING: The Gateway Integration is being processed.
  • SUCCEEDED: The Gateway Integration was successful.
  • FAILED: The Gateway Integration failed.
tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

Example response

{
  "linked_to": "MUeg77opgdgQpwejzC9wCNm",
  "email": "michael@finix.com"
}