logo
Documentation Powered by ReDoc

Styx XS2A Client API (0.8.0)

Download OpenAPI specification:Download

E-mail: info@petafuel.de URL: https://github.com/petafuel/styx License: Apache License 2.0 Terms of Service

This is the Styx XS2A Client API documentation.

Styx GitHub Repository

Introduction

This API definition is intended to to be a good starting point for developers who want to create application (clients) that make use of the features provided by Styx. The documentation makes use of the OpenAPI Specification.

OpenAPI Specification

The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.

Authentication

styx_user_token

Styx access token - will be bound to a new payment initiations or an account information.

Security Scheme Type API Key
Header parameter name: token

styx_master_token

The Styx master token allows to generate Styx user tokens.

Security Scheme Type API Key
Header parameter name: token

PIS

Payment Initiation Service

Payment Initiation Request

Create a payment initiation. This is usually the first action when using Styx PIS. The request contains information about debtor account, creditor account and the transaction itself.

Authorizations:
styx_user_token
path Parameters
payment-product
required
string

Payment product identifier

payment-service
required
string

Payment-service identifier

header Parameters
redirectPreferred
required
boolean

Indicates if redirect is preferred processing method.

PSU-Geo-Location
string
Example: GEO:48.377993;11.752393

Geo location

PSU-Device-ID
required
string

Unique identifier of the user's device or application.

PSU-BIC
required
string

BIC (Bank Identifier Code/ISO 9362) of the user's account.

Request Body schema: application/json
batchBookingPreferred
boolean

Indicator if batch booking is preferred. Only needed for bulk payments. If omitted it is interpreted as false for bulk payments.

requestedExecutionDate
string

Requested execution date for a future payment. If omitted interpreted as instant payment.

startDate
string

Needed for recurring payments, indicating the scheduled start of a recurring payment.

executionRule
string

following or preceding supported as values. This data attribute defines the behavior when recurring payment dates falls on a weekend or bank holiday. The payment is then executed either the preceding or following working day.

frequency
string

Needed for recurring payments, indicating the frequency of a recurring payment.

dayOfExecution
string

Needed for recurring payments, indicating executionDay of a recurring payment.

debtorAccount
string

Information about the debtor account.

payments
string

Contains one or multiple payments.

instructedAmount
string

Information about the requested transfer amount and currency.

creditorAccount
string

Information about the creditor account.

creditorName
string

Creditor name.

remittanceInformationUnstructured
string

Transfer purpose (Max. 140 characters. The character set that is at least supported is: 'a - z' 'A - Z' '0 - 9' / - ? : ( ) . , ' + 'space')

Responses

200

Success

401

Authorization of the Styx API token expired

403

Styx API token is bound to a different service for example a AIS

405

Http Method is not allowed for the requested resource

500

Internal server error

post /{payment-service}/{payment-product}
https://mystyxserver.com/v1/{payment-service}/{payment-product}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "batchBookingPreferred": true,
  • "requestedExecutionDate": "string",
  • "startDate": "string",
  • "executionRule": "string",
  • "frequency": "string",
  • "dayOfExecution": "string",
  • "debtorAccount": "string",
  • "payments": "string",
  • "instructedAmount": "string",
  • "creditorAccount": "string",
  • "creditorName": "string",
  • "remittanceInformationUnstructured": "string"
}

Get Payment Request

Read the details of an initiated payment.

Authorizations:
styx_user_token
path Parameters
payment-product
required
string

Payment product identifier

payment-service
required
string

Payment-service identifier

paymentId
required
string

Payment identifier

header Parameters
PSU-Geo-Location
string
Example: GEO:48.377993;11.752393

Geo location

PSU-Device-ID
required
string

Unique identifier of the user's device or application.

Responses

200

Success

get /{payment-service}/{payment-product}/{paymentId}
https://mystyxserver.com/v1/{payment-service}/{payment-product}/{paymentId}

Get Payment Initiation Status

Read the transaction status of the payment. (Subset of the call above)

Authorizations:
styx_user_token
path Parameters
payment-product
required
string

Payment product identifier

payment-service
required
string

Payment-service identifier

paymentId
required
string

Payment identifier

header Parameters
PSU-Geo-Location
string
Example: GEO:48.377993;11.752393

Geo location

PSU-Device-ID
required
string

Unique identifier of the user's device or application.

Responses

200

Success

get /{payment-service}/{payment-product}/{paymentId}/status
https://mystyxserver.com/v1/{payment-service}/{payment-product}/{paymentId}/status

Start Authorisation Process

Creates an authorisation sub-resource and start the authorisation process for a given payment request.

Authorizations:
styx_user_token
path Parameters
payment-service
required
string

Payment-service identifier

payment-product
required
string

Payment product identifier

paymentId
required
string

Payment identifier

header Parameters
PSU-ID
string
Example: 12345678

identifier known by the PSU

PSU-Geo-Location
string
Example: GEO:48.377993;11.752393

Geo location

PSU-Device-ID
required
string

Unique identifier of the user's device or application.

Request Body schema: application/json
psudata
string

Container for the psu data requested by the ASPSP. The object contains the password known by the psu.

password
string

Element of psudata

Responses

200

Success

post /{payment-service}/{payment-product}/{paymentId}/authorisations
https://mystyxserver.com/v1/{payment-service}/{payment-product}/{paymentId}/authorisations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "psudata": "string",
  • "password": "string"
}

Get Authorisation Sub-Resources

Read a list of all authorisation subresources IDs which have been created.

Authorizations:
styx_user_token
path Parameters
payment-service
required
string

Payment-service identifier

payment-product
required
string

Payment product identifier

paymentId
required
string

Payment identifier

header Parameters
PSU-Geo-Location
string
Example: GEO:48.377993;11.752393

Geo location

PSU-Device-ID
required
string

Unique identifier of the user's device or application.

Responses

200

Success

get /{payment-service}/{payment-product}/{paymentId}/authorisations
https://mystyxserver.com/v1/{payment-service}/{payment-product}/{paymentId}/authorisations

Update Authorisation Process

Update the authorisation process and choose a SCA Method or update the OTP.

Authorizations:
styx_user_token
path Parameters
payment-service
required
string

Payment-service identifier

payment-product
required
string

Payment product identifier

paymentId
required
string

Payment identifier

authorisationId
required
string

Identifier of the authorisation linked to the payment.

header Parameters
PSU-Geo-Location
string
Example: GEO:48.377993;11.752393

Geo location

PSU-Device-ID
required
string

Unique identifier of the user's device or application.

Request Body schema: application/json
scaAuthenticationData
string

The actual OTP value to complete the SCA process.

authenticationMethodId
string

The ID of the SCA authentication method choosen by the PSU.

Responses

200

Success

put /{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
https://mystyxserver.com/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "scaAuthenticationData": "string",
  • "authenticationMethodId": "string"
}

Get Status of Authorisation Process

Read the status of the given authorisation resource.

Authorizations:
styx_user_token
path Parameters
payment-service
required
string

Payment-service identifier

payment-product
required
string

Payment product identifier

paymentId
required
string

Payment identifier

authorisationId
required
string

Authorisation resource identifier.

header Parameters
PSU-Geo-Location
string
Example: GEO:48.377993;11.752393

Geo location

PSU-Device-ID
required
string

Unique identifier of the user's device or application.

Responses

200

Success

get /{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
https://mystyxserver.com/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}