Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Outbound APIs (from Thales D1)

OpenAPI specification for APIs Thales D1 calls on your system.

D1-Ecom-DCS-OUT-oas3.yaml

Get Access Token

post
/oauth2/token

This request is used by Thales to retrieve an access token to be used for outgoing API requests. Endpoint URL used for retrieving access token is configurable.

Header parameters
authorizationstringRequired

The authorization header includes a client secret in base64URL encoded format following this syntax: Basic "[clientId:client secret]" as per https://www.rfc-editor.org/rfc/rfc2617

Example: Basic aXNfdGJhbmswMToxMjM=
Body
grant_typeconst: client_credentialsRequired
scopestringOptional

Access request scope as optionally defined by the merchant gateway

Responses
200

Default allowed response

application/json
access_tokenstringOptional

The access_token that will be used to call the APIs.

Example: ey...HRT6LOON7w
expires_innumberOptional

Remaining time in seconds for the access_token to expire.

Example: 900
token_typestringOptional

Type of the access_token that will be used to call the APIs.

Example: Bearer
scopestringOptional

Scope of the access_token.

expires_atstringOptional

Access token expiration timestamp

Example: 2023-06-06T05:05:59.711Z
post
/oauth2/token

Notify token update

post
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}/notify-update

Notify token update.

Authorizations
OAuth2clientCredentialsRequired

OAUTH activation for outbound endpoints is optional and part of D1 Tenant configuration (i.e. Token URL, Credentials, Scope).A merchant gateway entity wishing to opt for OAUTH scheme needs to support an endpoint (Token URL) from which the access token can be retrieved.This endpoint shall support HTTP POST Client Credentials grant requests in x-www-form-urlencoded content type as specified here: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4.2

Token URL: Refresh URL:
Path parameters
merchantGatewayIdstring · min: 10 · max: 10Required

Merchant Gateway Identifier.

Example: MGW_000001Pattern: ^[A-Za-z0-9_-]{10}$
merchantIdstring · min: 11 · max: 11Required

Merchant Identifier (aka Token Requestor ID) generated by the scheme TSP for that merchant.

Example: 10610027312Pattern: ^[A-Za-z0-9_-]{11}$
tokenIdstring · min: 1 · max: 48Required

Token unique identifier

Example: 01fb32ff-5ed0-497f-8835-6af0916f29c0Pattern: ^[A-Za-z0-9_-]{1,48}$
Header parameters
x-correlation-idstringRequired

Random identifier which can be used to correlate the different API calls done as part of a single use-case. This identifier will be the one primarily used for troubleshooting.

Warning: This identifier should not be derived from sensitive personal data, as its value will be logged in clear.

There is no strong guarantee of the uniqueness of this identifier, so please refrain from using it for other purpose than logging and troubleshooting.

Pattern: ^[A-Za-z0-9_-]{1,64}$
Body
updateTypestring · enumRequiredPossible values:
Responses
post
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}/notify-update
No content
PreviousInbound APIs (to Thales D1)NextSet up mutual TLS (mTLS)

Last updated

Was this helpful?