API salientes (desde Thales D1)

Especificación OpenAPI de las API que Thales D1 llama en su sistema.

D1-Ecom-DCS-OUT-oas3.yaml

Get Access Token

post

https://YOUR_PROD_DOMAIN_NAMEhttps://YOUR_STAGING_DOMAIN_NAME

/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.

Parámetros de encabezado

authorizationstringRequerido

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=

Cuerpo

application/x-www-form-urlencoded

grant_typeconst: client_credentialsRequerido

scopestringOpcional

Access request scope as optionally defined by the merchant gateway

Respuestas

200

Default allowed response

application/json

access_tokenstringOpcional

The access_token that will be used to call the APIs.

Example: ey...HRT6LOON7w

expires_innumberOpcional

Remaining time in seconds for the access_token to expire.

Example: 900

token_typestringOpcional

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

Example: Bearer

scopestringOpcional

Scope of the access_token.

expires_atstringOpcional

Access token expiration timestamp

Example: 2023-06-06T05:05:59.711Z

400

Bad Request - Not Retryable

Error Code	Description
FIELD_INVALID_FORMAT	JSON not well formatted or one field is not expected format as defined in this documentation (first found)

---

application/json

post

/oauth2/token

HTTPcURLJavaScriptPython

POST /oauth2/token HTTP/1.1
Host: YOUR_PROD_DOMAIN_NAME
authorization: Basic aXNfdGJhbmswMToxMjM=
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 34

"grant_type=null&scope='text'"

{
  "access_token": "ey...HRT6LOON7w",
  "expires_in": 900,
  "token_type": "Bearer",
  "scope": "text",
  "expires_at": "2023-06-06T05:05:59.711Z"
}

Notify token update

post

https://YOUR_PROD_DOMAIN_NAMEhttps://YOUR_STAGING_DOMAIN_NAME

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

Notify token update.

Autorizaciones

clientCredsOAuth

OAuth2clientCredentialsRequerido

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:

Parámetros de ruta

merchantGatewayIdstring · mín: 10 · máx: 10Requerido

Merchant Gateway Identifier.

Example: MGW_000001Pattern: ^[A-Za-z0-9_-]{10}$

merchantIdstring · mín: 11 · máx: 11Requerido

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

Example: 10610027312Pattern: ^[A-Za-z0-9_-]{11}$

tokenIdstring · mín: 1 · máx: 48Requerido

Token unique identifier

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

Parámetros de encabezado

x-correlation-idstringRequerido

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

Cuerpo

application/json

updateTypestring · enumRequeridoValores posibles:

Respuestas

204

No Content

400

Bad Request - Not Retryable

Error Code	Description
FIELD_INVALID_FORMAT	JSON not well formatted or one field is not expected format as defined in this documentation (first found)

---

application/json

401

Unauthorized - Not Retryable

404

Bad Request - Not Retryable

Error Code	Description
UNKNOWN_TOKEN	Not able to identify the token.
UNKNOWN_MERCHANT	Not able to identify the merchant.

---

500

Bad Request - Not Retryable

Error Code	Description
INTERNAL_ERROR	Internal Merchant Gateway error
MERCHANT_ERROR	An error occurred with Merchant

---

application/json

503

Service Unavailable - Retryable

post

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

HTTPcURLJavaScriptPython

POST /merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}/notify-update HTTP/1.1
Host: YOUR_PROD_DOMAIN_NAME
Authorization: Bearer YOUR_OAUTH2_TOKEN
x-correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "updateType": "TOKEN_STATE_CHANGE"
}

Sin contenido