Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Gateway Integrations

Create a Gateway Integration

Create a Gateway Integration that connects a Merchant to a third-party payment gateway. At this time, the only supported gateway is Cybersource.

If subscribed, a Gateway Integration - Created webhook is sent when the integration is created with a Gateway Integration ›state of PENDING.

When the state changes to SUCCEEDED or FAILED, a Gateway Integration - Updated webhook is sent.

post/gateway_integrations

Headers

Finix-Versionstring
Example:2022-02-01

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

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

emailstring email

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

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)
type'CYBERSOURCE' required

The type of Gateway Integration to create. At this time, the only supported value is CYBERSOURCE.

Example request

{
  "email": "michael@finix.com"
}

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"
}