INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Financial Account Use Cases  /  Suspend or Unsuspend a Recipient Financial Account

Suspend or Unsuspend a Recipient Financial Account

Overview

In this use case, we’ll walk through suspending and unsuspending a Recipient Financial Account. You can suspend a Financial Account to make the account temporarily inactive, then unsuspend the account to make it active again. This use case applies to both card and bank account Recipient Financial Accounts.

API Operations

Steps

Send a request to the following endpoint: POST /api/external/financial-accounts/{financialAccountId}
  • Use the {financialAccountId} path parameter to specify the ID of the Financial Account to be suspended or unsuspended.
  • In the request body, use the state parameter to suspend or unsuspend the account. To make an account inactive, set state to SUSPENDED. To reactivate a suspended account, set state to ACTIVE.
  • Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Request

The following request would suspend a Recipient Financial Account.

				
					{
  "state": "SUSPENDED"
}
				
			

Sample Response

If the suspend or unsuspend operation is successful, the Recipient Financial Account details are returned.

The following example shows the response for the successful suspension of a debit card Recipient Financial Account. Notice that the account state has been updated to SUSPENDED.

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "createdAt": "2021-07-08T21:10:51.610Z",
  "updatedAt": "2021-07-08T21:10:51.610Z",
  "name": "Debit Card",
  "accountId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "accountIdType": "RECIPIENT",
  "defaultFlag": true,
  "state": "SUSPENDED",
  "financialInstitutionId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "financialInstitutionName": "CIBC",
  "ledgerIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "card": {
    "id": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
    "firstName": "Mark",
    "middleName": "David",
    "lastName": "Strong",
    "type": "DEBIT",
    "expiry": {
      "year": 2022,
      "month": "JANUARY",
      "monthValue": 1,
      "leapYear": false
    },
    "billingAddress": {
      "addressLine1": "625 Queen St",
      "addressLine2": "",
      "addressLine3": "",
      "city": "Vancouver",
      "state": "BC",
      "country": "Canada",
      "postalCode": "V5K 0A1"
    },
    "cardNumberTail": "6999"
  }
}
				
			
ON THIS PAGE