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
Field
Type
Description
type
string
satispay_gateways
id
string
The satispay gateway unique identifier
links.self
string
The satispay gateway endpoint URL
attributes.name
string
The payment gateway's internal name.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
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.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.token
string
Activation code generated from the Satispay Dashboard.
attributes.skey
string
The private RSA key auto generated.
attributes.pkey
string
The public RSA key auto generated.
attributes.key_id
string
The Satispay API key auto generated basing on activation code.
attributes.webhook_endpoint_url
string
The gateway webhook URL, generated automatically.
relationships.payment_methods
array
The associated payment methods.
relationships.versions
array
The associated changes.
relationships.satispay_payments
array
The associated payments.
meta.mode
string
The resource environment (can be one of test or live)

Field	Type	Description
type	`string`	`satispay_gateways`
id	`string`	The satispay gateway unique identifier
links.self	`string`	The satispay gateway endpoint URL
attributes.name	`string`	The payment gateway's internal name.
attributes.created_at	`datetime`	Time at which the resource was created.
attributes.updated_at	`datetime`	Time at which the resource was last updated.
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.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.token	`string`	Activation code generated from the Satispay Dashboard.
attributes.skey	`string`	The private RSA key auto generated.
attributes.pkey	`string`	The public RSA key auto generated.
attributes.key_id	`string`	The Satispay API key auto generated basing on activation code.
attributes.webhook_endpoint_url	`string`	The gateway webhook URL, generated automatically.
relationships.payment_methods	`array`	The associated payment methods.
relationships.versions	`array`	The associated changes.
relationships.satispay_payments	`array`	The associated payments.
meta.mode	`string`	The resource environment (can be one of `test` or `live`)

Satispay gateways

Create a satispay gateway

Last modified 29d ago