Skip to main content
Version: 2019-05-29 (Current)

Delete a Linked Account

Permanently delete a linked account from your platform. This action is irreversible and the linked account can no longer be used for payments.


Request Parametersโ€‹

Required - 1 fieldRequired Parameters
โ–ผ
`id`STRING(required)
Linked Account ID to delete (must be a valid linked account ID starting with lacct_).
Example:"lacct_test_5xuy4w91xqz7d1w9u0t"
Constraints:Must be a valid linked account ID

Responsesโ€‹

200

Linked account deleted successfully

Linked account permanently deleted. The account can no longer be used for payments.

Deletion effects:
  • Linked account status is set to "deleted"
  • Account can no longer process payments
  • Registration URI becomes invalid
  • Past transactions remain in records
  • Deletion cannot be undone

400

Bad request

Invalid linked account ID format.

Common causes:
  • Linked account ID format is invalid
  • ID does not start with lacct_

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:
  • Missing Authorization header
  • Invalid secret key
  • Using public key instead of secret key
  • Incorrect HTTP Basic Auth format

404

Not found

Linked account not found.

Common causes:
  • Linked account ID does not exist
  • Linked account has already been deleted
  • Linked account does not belong to your platform
  • Mixing test and live mode IDs

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

Code samplesโ€‹

curl https://api.omise.co/linked_accounts/lacct_test_5xuy4w91xqz7d1w9u0t \
-X DELETE \
-u skey_test_5xuy4w91xqz7d1w9u0t:

Error and result codesโ€‹

Common Error Codesโ€‹

CodeDescriptionResolution
bad_requestInvalid linked account ID formatCheck ID format
authentication_failureInvalid API keyVerify your secret key is correct
not_foundLinked account not foundVerify linked account ID exists

Deletion Responseโ€‹

FieldDescription
objectObject type (always "linked_account")
idID of the deleted linked account
livemodeWhether this was a live mode linked account
statusStatus (always "deleted" for successful deletions)
deletedBoolean flag (always true for successful deletions)

๐Ÿ”‘API Credentials

Try it outโ€‹

Required - 1 fields
โ–ผ
Your IP: ...Loading...