GET STARTED
RECIPIENT
FINANCIAL ACCOUNT
PAYMENT REASON
TRANSACTION
NOTE
PUT /api/external/recipients/{recipientId}
Basic Auth REQUIRED
username is your API key ID and password is your API key secret.
recipientId REQUIRED
string (UUID)
ID of the Recipient Account to be suspended or unsuspended.
state REQUIRED
string enum, values: SUSPENDED, ACTIVE
Recipient Account state. Possible values are SUSPENDED (make an account inactive) and ACTIVE (reactivate a suspended account).
Returns the Recipient Account details. The following fields are returned.
id
string (UUID)
Unique ID assigned to the Recipient Account.
createdAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Recipient Account was created.
updatedAt
string (date-time), required format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Recipient Account was last updated.
requestorId
string, max length: 40, min length: 0
ID of the entity that requested the Recipient Account creation. This could be a RocketKOR Business Account (if the account is created via an API) or a Team Member (if the account is created in the RocketKOR Portal).
businessAccountId
string (UUID)
ID of the Business Account that the Recipient Account belongs to.
clientId
string, max length: 40, min length: 0
ID of the client application interacting with the RocketKOR system.
createdSource
string, max length: 40, min length: 0
Application used to create the Recipient Account, such as a RocketKOR API, the RocketKOR Portal, or an iframe.
state
string, values: ACTIVE, SUSPENDED
Current status of the Recipient Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive). A Recipient Account is ACTIVE when first created.
SAMPLE REQUEST
{
"state": "SUSPENDED"
}
SAMPLE RESPONSE
{
"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"
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2022 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2022 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2022 by Rocket Financial Inc. All rights reserved.