SwitchApp API
  • Introduction
  • Quick Start
  • Authentication
  • Errors
  • Metadata
  • Pagination
  • Versioning
  • No-code solutions
  • Webhooks
  • Payments
    • Transactions
      • Initialize a transaction
      • Verify transaction
      • List transactions
      • Retrieve Transaction
      • Transaction Webhooks
  • Payment Providers
    • Payment Providers
  • Countries & Currencies
    • Countries
    • Currencies
  • Products
    • Products
      • Create a product
      • Retrieve a product
      • Update a product
      • List all products
      • Delete a product
  • Customers
    • Customers
      • Create Customer
      • List Customers
      • Fetch Customer
      • Update Customer
      • Delete/Archive Customer
  • Payment Links
    • Payment Links
      • Create a payment link
      • Fetch payment link
      • Update a payment link
      • List all payment links
      • Delete a payment link
  • Payouts
    • Payouts
      • List Payouts
      • Fetch Payout
      • Retry Payout
  • BALANCES
    • Balances
      • Fetch all balances
      • Fetch a balance
      • Fetch currency balance
  • DISBURSEMENTS
    • Disbursements (Transfers)
      • Batch Disbursements
        • Initiate A Disbursement
        • List Batch Transfers
        • Fetch A Batch
        • Requeue All Failed Transfers
      • Single Disbursements
        • Fetch List By Batch Reference
        • Fetch All Singles By Page
        • Fetch A Single Disbursement
        • Fetch fee
        • Fetch rate
    • Beneficiaries
      • Create a beneficiary
      • List all beneficiaries
      • Fetch a beneficiary
      • Delete a beneficiary
    • Banks
      • Bank list
      • Bank slugs
      • Resolve account details
  • VIRTUAL ACCOUNTS
    • Virtual Accounts
      • Top-up virtual accounts
        • Fetch providers
        • Create top-up account
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
      • Payment virtual accounts
        • Fetch providers
        • Create payment account
        • Update account details
        • List accounts
        • Fetch account
        • Requery account
        • Deallocate account
Powered by GitBook
On this page
  1. DISBURSEMENTS
  2. Beneficiaries

Delete a beneficiary

PreviousFetch a beneficiaryNextBanks

Last updated 4 months ago

This endpoint deletes a beneficiary. You will no longer be able to initiate disbursements using the deleted beneficiary ID. This action is irreversible.

Delete a bank transfer beneficiary by id.

delete
Authorizations
Path parameters
idstringrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/v1/beneficiaries/bank-beneficiary/{id}' \
  --header 'Authorization: YOUR_API_KEY'
200
No body

Success

Delete a payment gateway beneficiary by id

delete
Authorizations
Path parameters
idstringrequired
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/v1/beneficiaries/gateway-beneficiary/{id}' \
  --header 'Authorization: YOUR_API_KEY'
200
No body

Success

  • DELETEDelete a bank transfer beneficiary by id.
  • DELETEDelete a payment gateway beneficiary by id