Skip to content
/Termination requests

Credit cards (1.0)

Download OpenAPI description
credit-cards.json
credit-cards.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/credit-cards/

Credit cards

Operations

Termination requests

Operations

Create credit card termination request

Request

Creates a termination request for the credit card application specified in the request URL. See the credit cards guide for more information on how the termination process works.

Path
application_idstringrequired
Bodyapplication/json
reasonstringrequired

The reason for the termination.

Value"CUSTOMER_WISH"
Example: "CUSTOMER_WISH"
application/json
{
  "reason": "CUSTOMER_WISH"
}

Responses

Termination record

Bodyapplication/json
idstring
Example: "ac8df7d811c042faacabd8162de7b789cctr"
application_idstring

The ID of the credit card application that is being terminated.

Example: "796ff7b9961c4fe1b4470e45298b5d69ccla"
reasonstring

The reason for the termination.

Enum"CUSTOMER_WISH""OTHER_IMMEDIATE""OTHER_ORDINARY"
Example: "CUSTOMER_WISH"
statusstring

The current status of the credit card termination.

Enum"INITIATED""IN_PROGRESS""FINALIZED""REVOKED"
Example: "INITIATED"
legally_terminated_atstring(date)

The date when the credit card termination will take effect.

Example: "2023-08-31"
revocable_untilstring(date)

The date until which the termination can be revoked.

Example: "2023-08-02"
created_atstring(date-time)

UTC timestamp from when the termination was created.

Example: "2023-07-28T14:47:00.000Z"
Response
application/json
{
  "id": "ac8df7d811c042faacabd8162de7b789cctr",
  "application_id": "796ff7b9961c4fe1b4470e45298b5d69ccla",
  "reason": "CUSTOMER_WISH",
  "status": "INITIATED",
  "legally_terminated_at": "2023-08-31",
  "revocable_until": "2023-08-02",
  "created_at": "2023-07-28T14:47:00.000Z"
}

Get all credit card termination requests

Request

Returns a list of all credit card termination requests.

Query
page[size]integer

Indicates the number of entries to return on each results page.

Default 10
page[number]integer

Indicates the number of results pages to return.

Default 1
sortstring

Sort the results by created_at or updated_at.

No request payload

Responses

List of terminations records

Headers
Totalstring

Total number of elements that match the provided filters

Example: "123"
Per-Pagestring

Number of elements per page

Example: "10"
Linkstring

Links to other pages

Example: "<url?page[size]=10&page[number]=1>; rel=\"first\", <url?page[size]=10&page[number]=13>; rel=\"last\", <url?page[size]=10&page[number]=2>; rel=\"next\", <url?page[size]=10&page[number]=4>; rel=\"prev\"\n"
Bodyapplication/jsonArray [
idstring
Example: "ac8df7d811c042faacabd8162de7b789cctr"
application_idstring

The ID of the credit card application that is being terminated.

Example: "796ff7b9961c4fe1b4470e45298b5d69ccla"
reasonstring

The reason for the termination.

Enum"CUSTOMER_WISH""OTHER_IMMEDIATE""OTHER_ORDINARY"
Example: "CUSTOMER_WISH"
statusstring

The current status of the credit card termination.

Enum"INITIATED""IN_PROGRESS""FINALIZED""REVOKED"
Example: "INITIATED"
legally_terminated_atstring(date)

The date when the credit card termination will take effect.

Example: "2023-08-31"
revocable_untilstring(date)

The date until which the termination can be revoked.

Example: "2023-08-02"
created_atstring(date-time)

UTC timestamp from when the termination was created.

Example: "2023-07-28T14:47:00.000Z"
]
Response
application/json
[
  {
    "id": "ac8df7d811c042faacabd8162de7b789cctr",
    "application_id": "796ff7b9961c4fe1b4470e45298b5d69ccla",
    "reason": "CUSTOMER_WISH",
    "status": "INITIATED",
    "legally_terminated_at": "2023-08-31",
    "revocable_until": "2023-08-02",
    "created_at": "2023-07-28T14:47:00.000Z"
  }
]

Get credit card termination request

Request

Returns the credit card termination request specified in the request URL.

Path
idstringrequired
No request payload

Responses

Termination record

Bodyapplication/json
idstring
Example: "ac8df7d811c042faacabd8162de7b789cctr"
application_idstring

The ID of the credit card application that is being terminated.

Example: "796ff7b9961c4fe1b4470e45298b5d69ccla"
reasonstring

The reason for the termination.

Enum"CUSTOMER_WISH""OTHER_IMMEDIATE""OTHER_ORDINARY"
Example: "CUSTOMER_WISH"
statusstring

The current status of the credit card termination.

Enum"INITIATED""IN_PROGRESS""FINALIZED""REVOKED"
Example: "INITIATED"
legally_terminated_atstring(date)

The date when the credit card termination will take effect.

Example: "2023-08-31"
revocable_untilstring(date)

The date until which the termination can be revoked.

Example: "2023-08-02"
created_atstring(date-time)

UTC timestamp from when the termination was created.

Example: "2023-07-28T14:47:00.000Z"
Response
application/json
{
  "id": "ac8df7d811c042faacabd8162de7b789cctr",
  "application_id": "796ff7b9961c4fe1b4470e45298b5d69ccla",
  "reason": "CUSTOMER_WISH",
  "status": "INITIATED",
  "legally_terminated_at": "2023-08-31",
  "revocable_until": "2023-08-02",
  "created_at": "2023-07-28T14:47:00.000Z"
}

Revoke a termination request

Request

Revokes the credit card termination request specified in the request URL. Note that you may only revoke a termination request within 5 business days of its creation.

Path
idstringrequired
No request payload

Responses

Termination record

Bodyapplication/json
idstring
Example: "ac8df7d811c042faacabd8162de7b789cctr"
application_idstring

The ID of the credit card application that is being terminated.

Example: "796ff7b9961c4fe1b4470e45298b5d69ccla"
reasonstring

The reason for the termination.

Enum"CUSTOMER_WISH""OTHER_IMMEDIATE""OTHER_ORDINARY"
Example: "CUSTOMER_WISH"
statusstring

The current status of the credit card termination.

Enum"INITIATED""IN_PROGRESS""FINALIZED""REVOKED"
Example: "INITIATED"
legally_terminated_atstring(date)

The date when the credit card termination will take effect.

Example: "2023-08-31"
revocable_untilstring(date)

The date until which the termination can be revoked.

Example: "2023-08-02"
created_atstring(date-time)

UTC timestamp from when the termination was created.

Example: "2023-07-28T14:47:00.000Z"
Response
application/json
{
  "id": "ac8df7d811c042faacabd8162de7b789cctr",
  "application_id": "796ff7b9961c4fe1b4470e45298b5d69ccla",
  "reason": "CUSTOMER_WISH",
  "status": "INITIATED",
  "legally_terminated_at": "2023-08-31",
  "revocable_until": "2023-08-02",
  "created_at": "2023-07-28T14:47:00.000Z"
}