> For the complete documentation index, see [llms.txt](https://docs.payments.thalescloud.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payments.thalescloud.io/ecom/integrate-the-d1-api/d1-api-reference/outbound-apis-from-thales-d1.md).
# Outbound APIs (from Thales D1)
[D1-Ecom-DCS-OUT-oas3.yaml](https://openapi.gitbook.com/o/fwy1mtbRONGA2YDKDBr0/spec/D1-Ecom-DCS-OUT-oas3.yaml)
## Get Access 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.
```json
{"openapi":"3.1.0","info":{"title":"d1-ecom_dcs-outbound-api","version":"1.0"},"servers":[{"url":"https://YOUR_PROD_DOMAIN_NAME","description":"Production server"},{"url":"https://YOUR_STAGING_DOMAIN_NAME","description":"Staging server"}],"paths":{"/oauth2/token":{"post":{"summary":"Get Access Token","description":"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.","operationId":"getAccessToken","parameters":[{"name":"authorization","in":"header","description":"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","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/auth2Request"}}}},"responses":{"200":{"description":"Default allowed response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/auth2Response"}}}},"400":{"description":"Bad Request - Not Retryable\n|Error Code|Description|\n|-------|-------| \n| FIELD_INVALID_FORMAT | JSON not well formatted or one field is not expected format as defined in this documentation (first found) |\n\n-----------------","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}}},"components":{"schemas":{"auth2Request":{"type":"object","title":"Authorization request body","properties":{"grant_type":{"const":"client_credentials"},"scope":{"type":"string","description":"Access request scope as optionally defined by the merchant gateway "}},"required":["grant_type"]},"auth2Response":{"type":"object","properties":{"access_token":{"$ref":"#/components/schemas/access_token"},"expires_in":{"$ref":"#/components/schemas/expires_in"},"token_type":{"$ref":"#/components/schemas/token_type"},"scope":{"$ref":"#/components/schemas/scope"},"expires_at":{"$ref":"#/components/schemas/expires_at"}}},"access_token":{"type":"string","description":"The access_token that will be used to call the APIs."},"expires_in":{"type":"number","description":"Remaining time in seconds for the access_token to expire."},"token_type":{"type":"string","description":"Type of the access_token that will be used to call the APIs."},"scope":{"type":"string","description":"Scope of the access_token."},"expires_at":{"type":"string","description":"Access token expiration timestamp"},"error":{"type":"object","additionalProperties":false,"properties":{"errorCode":{"type":"string","description":"The type of error"},"error":{"type":"string","description":"Provide additional information about the error if possible.
\nUsed for logging and troubleshooting purpose. It can change at any time so MUST NOT be parsed, and is not supposed to be human readable so CANNOT be displayed to end users."}}}}}}
```
## Notify token update
> Notify token update.
```json
{"openapi":"3.1.0","info":{"title":"d1-ecom_dcs-outbound-api","version":"1.0"},"tags":[{"name":"Token Management"}],"servers":[{"url":"https://YOUR_PROD_DOMAIN_NAME","description":"Production server"},{"url":"https://YOUR_STAGING_DOMAIN_NAME","description":"Staging server"}],"security":[{"clientCredsOAuth":[]}],"components":{"securitySchemes":{"clientCredsOAuth":{"type":"oauth2","description":"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","flows":{"clientCredentials":{"refreshUrl":"N/A","scopes":{},"tokenUrl":"${tokenPath}"}}}},"parameters":{"merchant-gateway-id-path":{"name":"merchantGatewayId","in":"path","description":"The merchant gateway identifier","required":true,"schema":{"$ref":"#/components/schemas/merchantGatewayId"}},"merchant-id-path":{"name":"merchantId","in":"path","description":"The merchant identifier","required":true,"schema":{"$ref":"#/components/schemas/merchantId"}},"token-id-path":{"name":"tokenId","in":"path","description":"The token identifier","required":true,"schema":{"$ref":"#/components/schemas/tokenId"}}},"schemas":{"merchantGatewayId":{"type":"string","description":"Merchant Gateway Identifier.","pattern":"^[A-Za-z0-9_-]{10}$","minLength":10,"maxLength":10},"merchantId":{"type":"string","description":"Merchant Identifier (aka Token Requestor ID) generated by the scheme TSP for that merchant.","pattern":"^[A-Za-z0-9_-]{11}$","minLength":11,"maxLength":11},"tokenId":{"type":"string","description":"Token unique identifier","pattern":"^[A-Za-z0-9_-]{1,48}$","minLength":1,"maxLength":48},"notifyTokenUpdateRequest":{"type":"object","properties":{"updateType":{"type":"string","enum":["TOKEN_STATE_CHANGE","CARD_UPDATE"]}},"required":["updateType"]},"error":{"type":"object","additionalProperties":false,"properties":{"errorCode":{"type":"string","description":"The type of error"},"error":{"type":"string","description":"Provide additional information about the error if possible.
\nUsed for logging and troubleshooting purpose. It can change at any time so MUST NOT be parsed, and is not supposed to be human readable so CANNOT be displayed to end users."}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized - Not Retryable"},"503":{"description":"Service Unavailable - Retryable"}}},"paths":{"/merchant-gateways/{merchantGatewayId}/merchants/{merchantId}/tokens/{tokenId}/notify-update":{"post":{"tags":["Token Management"],"summary":"Notify token update","description":"Notify token update.","operationId":"notifyTokenUpdate","parameters":[{"$ref":"#/components/parameters/x-correlation-id-header"},{"$ref":"#/components/parameters/merchant-gateway-id-path"},{"$ref":"#/components/parameters/merchant-id-path"},{"$ref":"#/components/parameters/token-id-path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/notifyTokenUpdateRequest"}}}},"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"description":"Bad Request - Not Retryable\n|Error Code|Description|\n|-------|-------| \n| FIELD_INVALID_FORMAT | JSON not well formatted or one field is not expected format as defined in this documentation (first found) |\n\n-----------------","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"description":"Bad Request - Not Retryable\n\n|Error Code|Description|\n|-------|-------|\n|UNKNOWN_TOKEN|Not able to identify the token.|\n|UNKNOWN_MERCHANT|Not able to identify the merchant.|\n\n-----------------"},"500":{"description":"Bad Request - Not Retryable\n\n|Error Code|Description|\n|-------|-------|\n| INTERNAL_ERROR | Internal Merchant Gateway error |\n| MERCHANT_ERROR | An error occurred with Merchant |\n\n-----------------","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"503":{"$ref":"#/components/responses/503"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.payments.thalescloud.io/ecom/integrate-the-d1-api/d1-api-reference/outbound-apis-from-thales-d1.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.