Suspend or unsuspend a Recipient Account. To make a Recipient inactive, set state to SUSPENDED. To reactivate a suspended Recipient, set state to ACTIVE.
If a Recipient is suspended, their Financial Accounts cannot be used in transactions.
PUT /v1/recipients/{recipientId}
Authorization: Bearer <access_token>
recipientId REQUIRED
string (UUID)
Recipient Account ID.
state
string enum, values: ACTIVE, SUSPENDED
Current status of the Recipient Account. Possible values are:
Returns the Recipient Account details. For details, see the Recipient object.
SAMPLE REQUEST
{
"state": "SUSPENDED"
}
SAMPLE RESPONSE
{
"id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"businessRefId": "RECIP001",
"firstName": "John",
"middleName": "",
"lastName": "Smith",
"secondLastName": "",
"email": "jsmith@xyz.com",
"phoneNumber": "9055621258",
"nationality": "Canadian",
"dateOfBirth": "1970-07-08",
"additionalInformation": "",
"recipientType": "INDIVIDUAL",
"businessName": "",
"state": "SUSPENDED",
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"createdAt": "2021-09-20T22:09:31.947Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"updatedAt": "2021-10-20T22:09:31.947Z",
"requestorId": "9kj43t32-2956-2886-x7dy-6r821w39kra3"
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2023 RocketKOR, Inc. All rights reserved.