Operations

Different operations that can be done on a consumer.

Delete

post

https://api.d1.thalescloud.io/banking/v1https://api.d1-stg.thalescloud.io/banking/v1

/issuers/{issuerId}/consumers/{consumerId}/operations:delete

This request is used by the issuer backend to delete an end user (consumer). The action cascades to delete all the accounts, cards and digital cards associated with the end user. Note: The deletion of the end user cannot be reversed. If the same end user is willing to reuse the solution, we will require a new end user registration with a new consumerId.

Autorizaciones

bearerAuth

AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta

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

The id of the issuer

consumerIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the end user.

Pattern: [A-Za-z0-9_-]{1,64}

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Opcional

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 purposes other than logging and troubleshooting.

Pattern: [a-zA-Z0-9_\-\. ]{1,64}

Cuerpo

application/json

reasonstringOpcional

The reason why the action is performed.

This a free text field in case the Issuer wants to send details, that will be returned in the operations list.

Example: customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$

reasonCodestring · enumOpcional

The reason why the action has been performed. If not provided, default reason code is ISSUER_DECISION.

Valores posibles:

Respuestas

200

End user was deleted successfully.

application/json

Operation result information.

operationIdstring · mín: 1 · máx: 64Opcional

Unique identifier of the operation

Pattern: [A-Za-z0-9_-]{1,64}

statusstring · enumOpcional

Status of the operation

Valores posibles:

400

Bad Request, Invalid request URI or header, or unsupported nonstandard parameter

application/json

401

The provided Authorization header is missing or invalid

application/json

500

Internal Server Error

application/json

post

/issuers/{issuerId}/consumers/{consumerId}/operations:delete

HTTPcURLJavaScriptPython

POST /banking/v1/issuers/{issuerId}/consumers/{consumerId}/operations:delete HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "reason": "customer was contacted on June 28",
  "reasonCode": "USER_DECISION"
}

{
  "operationId": "text",
  "status": "SUCCESSFUL"
}

Get all operations

get

https://api.d1.thalescloud.io/banking/v1https://api.d1-stg.thalescloud.io/banking/v1

/issuers/{issuerId}/consumers/{consumerId}/operations

This request is used by the issuer backend to retrieve the operations details of an end user (consumer).

If no operations are available for the given consumerId, an empty list is returned.

Operations that are older than 3 months will be removed.

Autorizaciones

bearerAuth

AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta

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

The id of the issuer

consumerIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the end user.

Pattern: [A-Za-z0-9_-]{1,64}

Parámetros de consulta

offsetintegerOpcional

Index from which the query starts returning operations – Offset 0 (the default) corresponds to the most recent operation.

limitinteger · mín: 1 · máx: 50Opcional

Number of operations to be returned

Default: 10

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Opcional

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 purposes other than logging and troubleshooting.

Pattern: [a-zA-Z0-9_\-\. ]{1,64}

Respuestas

200

OK

application/json

remainingOperationsintegerOpcional

400

Bad Request, Invalid request URI or header, or unsupported non-standard parameter

application/json

401

The provided Authorization header is missing or invalid

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

/issuers/{issuerId}/consumers/{consumerId}/operations

HTTPcURLJavaScriptPython

GET /banking/v1/issuers/{issuerId}/consumers/{consumerId}/operations HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "operations": [
    {
      "operationId": "text",
      "operation": "CLICK_TO_PAY_UPDATE",
      "status": "SUCCESSFUL",
      "startTime": "2022-06-16T06:28:02.492Z",
      "endTime": "2022-06-16T06:28:32.492Z",
      "requestorType": "ISSUER",
      "requestorId": "text",
      "reason": "customer was contacted on June 28",
      "reasonCode": "USER_DECISION",
      "details": {},
      "errorCode": "text",
      "error": "text"
    }
  ],
  "remainingOperations": 1
}

Get operation

get

https://api.d1.thalescloud.io/banking/v1https://api.d1-stg.thalescloud.io/banking/v1

/issuers/{issuerId}/consumers/{consumerId}/operations/{operationId}

This request is used by the issuer backend to retrieve the information related to an operation on the given end user (consumer).

Autorizaciones

bearerAuth

AuthorizationstringRequerido

A JWT generated by the Get Authorization Token API.
The server checks the validity of the provided token to control access to this protected resource. Please refer to Get OAuth 2.0 access token for more details on the flow and on how to get this JWT.

Parámetros de ruta

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

The id of the issuer

consumerIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the end user.

Pattern: [A-Za-z0-9_-]{1,64}

operationIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the operation

Pattern: [A-Za-z0-9_-]{1,64}

Parámetros de encabezado

x-correlation-idstring · mín: 1 · máx: 64Opcional

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 purposes other than logging and troubleshooting.

Pattern: [a-zA-Z0-9_\-\. ]{1,64}

Respuestas

200

OK

application/json

Operation details related to a specific operationId

operationIdstring · mín: 1 · máx: 64Requerido

Unique identifier of the operation

Pattern: [A-Za-z0-9_-]{1,64}

operationstring · enumRequerido

The operation type.

Valores posibles:

statusstring · enumRequerido

Status of the operation

Valores posibles:

startTimestring · mín: 1 · máx: 64Requerido

The time the request has been processed. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD

Example: 2022-06-16T06:28:02.492Z

endTimestring · mín: 1 · máx: 64Opcional

The time the operation has been completed. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD note: This is an optional field and might not be returned for synchronous operations.

Example: 2022-06-16T06:28:32.492Z

requestorTypestring · enumRequeridoValores posibles:

requestorIdstringRequerido

Identifier of the principal who initiates the operation

• consumerId if requestorType is USER
• issuerId if requestorType is ISSUER
• cci user id if requestorType is CCI

reasonstringOpcional

The reason why the action is performed.

This a free text field in case the Issuer wants to send details, that will be returned in the operations list.

Example: customer was contacted on June 28Pattern: ^[a-zA-Z0-9 ]{1,64}$

reasonCodestring · enumOpcionalValores posibles:

detailsone ofOpcional

o

errorCodestringOpcional

External error code

errorstring · máx: 256Opcional

Human readable string representing the error, only present in case of operation failure

Pattern: /^[a-zA-Z0-9_ \/\\\[\],.'#;:{}()?!*-]*$/

400

Bad Request, Invalid request URI or header, or unsupported non-standard parameter

application/json

401

The provided Authorization header is missing or invalid

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

get

/issuers/{issuerId}/consumers/{consumerId}/operations/{operationId}

HTTPcURLJavaScriptPython

GET /banking/v1/issuers/{issuerId}/consumers/{consumerId}/operations/{operationId} HTTP/1.1
Host: api.d1.thalescloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*