Suspend a Financial Account

Suspend a Customer or Recipient Financial Account. A suspended Financial Account cannot be used in transactions.

Endpoint

POST /v1/financial-accounts/{financialAccountId}/suspend

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

financialAccountId REQUIRED

string (UUID)

ID of the Financial Account.

Request Body

stateReason CONDITIONAL

string enum, values: CARD_ACTIVATED, CARD_REISSUED, PENDING, ISSUED_INACTIVE, LOST_CARD, STOLEN_CARD, LOST_CARD_NOT_CAPTURED, STOLEN_CARD_NOT_CAPTURED, FRAUD_BLOCK

Required for integrated card Financial Accounts. Reason for suspending the Financial Account.

The following values are supported for ACTIVE status:

CARD_ACTIVATED Card has been activated.
CARD_REISSUED Card has been reissued.

The following values are supported for PENDING status:

PENDING Card is pending acceptance.

The following values are supported for SUSPENDED status:

ISSUED_INACTIVE Card has been issued or reissued in an inactive state. The card state will become ACTIVE after the card is activated.
LOST_CARD Card has been lost.
STOLEN_CARD Card has been stolen.
LOST_CARD_NOT_CAPTURED Card has been lost and one or more transactions have not been captured.
STOLEN_CARD_NOT_CAPTURED Card has been stolen and one or more transactions have not been captured.
FRAUD_BLOCK Card has been blocked due to potential fraud.

Returns

If successful, returns 204 Financial Account suspended.

SAMPLE RESPONSE

				
					{
  204 Financial Account suspended
}