Skip to main content
Embedded Payments

Post transaction restrictions on accounts

You can add or remove transaction restrictions using an API request. These restrictions prevent specific types of transactions from posting to your account. There are four restriction types.

Posting transaction restrictions can prevent specific types of transactions from posting to the account. There are four restriction types
Restriction type Description Allowed accounts
DEBITS Restricts debit transactions from the account.
  • TRANSACTION_ACCOUNT
  • LIMITED_DDA
  • LIMITED_DDA_PAYMENTS
CREDITS Restricts credit transactions to the account.
  • TRANSACTION_ACCOUNT
  • LIMITED_DDA
  • LIMITED_DDA_PAYMENTS
DEBIT_CREDIT Restricts both debit and credit transactions preventing funds moving in or out of the account.
  • TRANSACTION_ACCOUNT
  • LIMITED_DDA
  • LIMITED_DDA_PAYMENTS
DIRECT_DEBIT

Restricts only direct debit transactions.

Other debit transactions are unaffected unless you apply a general debit restriction.

  • TRANSACTION_ACCOUNT
  • LIMITED_DDA_PAYMENTS

How to add a transaction restriction

Submit an API request to add a transaction restriction via the POST /accounts/{id}/restrictions endpoint.

Note:

  • The account must be in PENDING_OPEN, OPEN or PENDING_CLOSE state.
  • Only one transaction restriction can be added per API request.
  • Multiple transaction restrictions of the same type can exist, but a single restriction is sufficient to block that transaction type.
  • Transaction restrictions remain in place until removed.

Sample request:

{
  "restrictionType": "DEBIT_CREDIT"
}

Sample response:

{
  "restrictionId": "a5435e6c3208446589c0795e65ad094a",
  "restrictionType": "DEBIT_CREDIT"
}

How to remove a transaction restriction

Submit an API request to remove a transaction restriction via the DELETE /accounts/{id}/restrictions/{restrictionId} endpoint.

Note:

  • The account must be in PENDING_OPEN, OPEN, or PENDING_CLOSE state.
  • The transaction restriction must exist and not have already been removed.
  • Only one transaction restriction can be removed per API request.

Sample request:

DELETE /api/v2/accounts/{id}/restrictions/{restrictionId}

Sample response:

{
  "restrictionId": "a5435e6c3208446589c0795e65ad094a"
}

Transaction restriction by support team

The Embedded Payments operations team may impose transaction restrictions on your account, such as those resulting from a court order. You can view these restrictions and their reasons using the GET /account endpoint. When retrieving account details, you can see any active restrictions and their associated reasons. If you have any questions about these transaction restrictions, please contact our support team for assistance. The following table lists each restriction type and its client-visible reasons.

The following table lists each restriction type and its client-visible reasons.
Restriction type Client visible reasons
DEBITS
  • OTHER_RESTRICTION
  • COURT_ORDER
  • CLIENT_REQUESTED
CREDITS
  • OTHER_RESTRICTION
  • COURT_ORDER/OTHER_RESTRICTION
  • CLIENT_REQUESTED
DEBIT_CREDIT
  • OTHER_RESTRICTION
  • PROBATE
  • FDIC
  • CLIENT_REQUESTED
DIRECT_DEBIT
  • OTHER_RESTRICTION
  • COURT_ORDER/OTHER_RESTRICTION
  • CLIENT_REQUESTED