Delete Payout Account

The Delete Payout Account endpoint in Payiano enables your company to remove a specific payout account from the system. This is useful when an account is no longer active, required, or has been replaced due to updated payout configurations.

You can perform a soft delete (reversible) or force delete (permanent) based on your needs. Soft deletion preserves data for audit trails and future restoration, while force deletion permanently removes the record from your database.

DELETE/payout/accounts/{account_id}
Sandbox: https://api.payiano.dev/v1/payout/accounts/{account_id}
Live: https://api.payiano.com/v1/payout/accounts/{account_id}
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission payout.accounts.delete
Request
Request body schema:
application/json
Path parameters:
account_id
required
Type: ulid
Length: 26

The unique ID assigned to each payout account which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every payout account. This ULID is automatically created by our system and is used to uniquely identify and track each payout account in our database.

Query parameters:
identify_by
Type: enum|null
Possible values:
[ "id", "reference_id" ]

This attribute specifies which identifier is being used to interact with a resource in the Payiano API. It helps the system understand how to identify resource when processing API requests. By default, the identify_by attribute is set to id, so you only need to specify it if you're using a different identifier.

force_delete
Type: boolean
Default: false

This attribute determines the deletion method to be applied to the payout account delete in the database. When the value is set to true, it indicates that the payout account should be permanently and irreversibly removed from the database, commonly known as a Hard Delete. If the value is set to false, it implies a Soft Delete approach, where the payout account is not physically removed from the database. With Soft Delete it's still possible to restore the payout account record.

Response
200
Response schema:
application/json
Response body:
status
Type: boolean

This value indicates whether the payout account delete was successful or not.

Response sample:
1
{ 2 "status": true 3}