The satispay gateway object

A comprehensive list of the satispay gateway resource's attributes and relationships

A satispay gateway object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/satispay_gateways endpoint.

Fields

FieldTypeDescription

type

string

satispay_gateways

id

string

The satispay gateway unique identifier

links.self

string

The satispay gateway endpoint URL

attributes.created_at

datetime

Time at which the resource was created.

attributes.key_id

string

The Satispay API key auto generated basing on activation code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

attributes.name

string

The payment gateway's internal name.

attributes.pkey

string

The public RSA key auto generated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.skey

string

The private RSA key auto generated.

attributes.token

string

Activation code generated from the Satispay Dashboard.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.webhook_endpoint_url

string

The gateway webhook URL, generated automatically.

relationships.payment_methods

array

The associated payment methods.

relationships.satispay_payments

array

The associated payments.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

Last updated