INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

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

Suspend or Unsuspend a Recipient Account

Overview

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

If a Recipient Account is suspended, the account’s Recipient Financial Accounts cannot be used in transactions.

API Operation

Steps

Send a request to the following endpoint: PUT /api/external/recipients/{recipientId}
  • Use the {recipientId} path parameter to specify the ID of the Recipient 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 Account.

				
					{
  "state": "SUSPENDED"
}
				
			

Sample Response

If the suspend or unsuspend operation is successful, the Recipient Account details are returned. In the following example, notice that the account state has been updated to SUSPENDED.

				
					{
  "createdAt": "2021-07-08T20:56:35.219Z",
  "updatedAt": "2021-07-08T20:56:35.219Z",
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "requestorId": "9kj43t32-2956-2886-x7dy-6r821w39kra3",
  "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "clientId": "C12X896Y",
  "businessRefId": "RECIP001",
  "createdSource": "SDK iOS",
  "firstName": "John",
  "middleName": "",
  "lastName": "Smith",
  "secondLastName": "",
  "email": "jsmith@xyz.com",
  "phoneNumber": "4161234567",
  "nationality": "Canadian",
  "dateOfBirth": "1970-07-08",
  "additionalInformation": "",
  "recipientType": "INDIVIDUAL",
  "businessName": "",
  "state": "SUSPENDED"
}
				
			
ON THIS PAGE