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

入力 API(Thales D1 への)

システムが Thales D1 で呼び出す API の OpenAPI 仕様。

D1-Ecom-DCS-IN-oas3.yaml

Get Access Token

post
/oauth2/token

This request is used by the Merchant Gateway backend to get an access token.

ヘッダーパラメータ
x-correlation-idstring必須

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}$
本文
grant_typeconst: urn:ietf:params:oauth:grant-type:jwt-bearer必須

Describes the flow.
In our case we have defined the JWT bearer flow, so you will have to set urn:ietf:params:oauth:grant-type:jwt-bearer

assertionstring必須

The assertion is the entire JWT value.
Please refer to OAuth2 Access Token for more details on how to generate this JWT.
The JWT must contain the following fields:

  • iss: Issuer of the JWT. It shall be the merchant gateway identifier and it will be used to lookup the onboarded public key.
  • exp: The validity must be the expiration time of the assertion within 15 minutes, expressed as the number of seconds from 1970-01-01T0:0:0Z measured in UTC.
Supported alg: ES256.

Example: ey...HRT8LOON8z
レスポンス
200

Default allowed response

application/json
access_tokenstringオプション

The access_token that will be used to call the APIs.

Example: ey...HRT6LOON7w
expires_innumberオプション

Remaining time in seconds for the access_token to expire.

Example: 900
token_typestringオプション

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

Example: Bearer
scopestringオプション

Scope of the access_token.

Example: d1-s2s:api:merchant-gtw
post
/oauth2/token

Create a Merchant

post
/merchant-gateways/{merchantGatewayId}/merchants

Create a merchant.

認可
Authorizationstring必須

A JWT generated by the Get Access Token API.
The server checks the validity of the provided token to control access to this protected resource.

パスパラメータ
merchantGatewayIdstring · 最小: 10 · 最大: 10必須

Merchant Gateway Identifier.

Example: MGW_000001Pattern: ^[A-Za-z0-9_-]{10}$
ヘッダーパラメータ
x-correlation-idstring必須

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}$
本文
merchantNamestring · 最小: 1 · 最大: 64必須

An unique merchant name that is end user friendly.

Example: My MerchantPattern: ^[A-Za-z0-9-_. ]+$
レスポンス
post
/merchant-gateways/{merchantGatewayId}/merchants

Create a Token

post
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens

Create a token from specified card details.

認可
Authorizationstring必須

A JWT generated by the Get Access Token API.
The server checks the validity of the provided token to control access to this protected resource.

パスパラメータ
merchantGatewayIdstring · 最小: 10 · 最大: 10必須

Merchant Gateway Identifier.

Example: MGW_000001Pattern: ^[A-Za-z0-9_-]{10}$
merchantIdstring · 最小: 11 · 最大: 11必須

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

Example: 10610027312Pattern: ^[A-Za-z0-9_-]{11}$
ヘッダーパラメータ
x-correlation-idstring必須

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}$
本文
encryptedDatastring必須

The user and card information encrypted in a JWE structure (see data encryption section).

Once decrypted, the JWE plaintext contains the following JSON object:

JSON field parameter namedescriptionMOCLength
fpanThe funding pan to tokenize.MFrom 10 to 19
expThe expiry date in format MMYY.M4
nameThe card holder name in the format FIRSTNAME LASTNAME or as written on the card.OUp to 128 char
cvvThe security code.
It can help the issuer in the decision of approving the payment.
O3 or 4

Example: {"fpan":"5123456789012345", "exp":"0822", "name":"JOHN DOE", "cvv":"123"}

Example: ey...4FT8LOON8z
レスポンス
post
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens

Delete a token

delete
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}

Delete a token.

認可
Authorizationstring必須

A JWT generated by the Get Access Token API.
The server checks the validity of the provided token to control access to this protected resource.

パスパラメータ
merchantGatewayIdstring · 最小: 10 · 最大: 10必須

Merchant Gateway Identifier.

Example: MGW_000001Pattern: ^[A-Za-z0-9_-]{10}$
merchantIdstring · 最小: 11 · 最大: 11必須

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

Example: 10610027312Pattern: ^[A-Za-z0-9_-]{11}$
tokenIdstring · 最小: 1 · 最大: 48必須

Token unique identifier

Example: 01fb32ff-5ed0-497f-8835-6af0916f29c0Pattern: ^[A-Za-z0-9_-]{1,48}$
ヘッダーパラメータ
x-correlation-idstring必須

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}$
レスポンス
delete
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}

コンテンツなし

Get the token metadata

get
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}/metadata

Get token metadata.

認可
Authorizationstring必須

A JWT generated by the Get Access Token API.
The server checks the validity of the provided token to control access to this protected resource.

パスパラメータ
merchantGatewayIdstring · 最小: 10 · 最大: 10必須

Merchant Gateway Identifier.

Example: MGW_000001Pattern: ^[A-Za-z0-9_-]{10}$
merchantIdstring · 最小: 11 · 最大: 11必須

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

Example: 10610027312Pattern: ^[A-Za-z0-9_-]{11}$
tokenIdstring · 最小: 1 · 最大: 48必須

Token unique identifier

Example: 01fb32ff-5ed0-497f-8835-6af0916f29c0Pattern: ^[A-Za-z0-9_-]{1,48}$
ヘッダーパラメータ
x-correlation-idstring必須

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}$
レスポンス
200

Get Token Metadata response

application/json

Notice that the card last digits and the card expiry are always returned except if the card has been deleted by the issuer.

cardLastDigitsstringオプション

The card last digits

If the card is a cobagde card with a primary and an auxiliary PAN, then the primary PAN is used to generate the last digits

Example: 0037Pattern: ^[0-9]{4}$
cardExpiryDatestringオプション

Card expiry date in MMYY format

Example: 0928Pattern: ^(0[1-9]|1[0-2])\d{2}$
tokenStatestring · enum必須

Token state

可能な値:
creationDateTimestring · date-time必須

Creation date time as defined by RFC 3339, section 5.6

lastUpdateDateTimestring · date-timeオプション

Last update date time as defined by RFC 3339, section 5.6

get
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}/metadata

Create Transaction

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

Provide all required data to the Merchant/PSP to build a transaction authorisation request.

認可
Authorizationstring必須

A JWT generated by the Get Access Token API.
The server checks the validity of the provided token to control access to this protected resource.

パスパラメータ
merchantGatewayIdstring · 最小: 10 · 最大: 10必須

Merchant Gateway Identifier.

Example: MGW_000001Pattern: ^[A-Za-z0-9_-]{10}$
merchantIdstring · 最小: 11 · 最大: 11必須

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

Example: 10610027312Pattern: ^[A-Za-z0-9_-]{11}$
tokenIdstring · 最小: 1 · 最大: 48必須

Token unique identifier

Example: 01fb32ff-5ed0-497f-8835-6af0916f29c0Pattern: ^[A-Za-z0-9_-]{1,48}$
ヘッダーパラメータ
x-correlation-idstring必須

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}$
本文
transactionIdstring必須

The unique transaction identifier

Example: Rrn123456789Pattern: ^[A-Za-z0-9]{1,12}$
transactionDateTimestring必須

UTC Transaction date in 'YYYYMMDDhhmmss' format.

Example: 20260225140530Pattern: ^[0-9]{14}$
amountstring必須

Amount in the smallest unit of currency, right justified with leading zeros

Example: 000000002100Pattern: ^[0-9]{12}$
currencyCodestring必須

Currency code as per ISO 4217

Example: 978Pattern: ^[0-9]{3}$
レスポンス
post
/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}/transactions

最終更新

役に立ちましたか?