DELETE

/PaymentDetail

When to Use

Remove payment details created with incorrect details
Clean up duplicate payment detail records
Delete test payment details from development environments

Prerequisites

Payment detail must exist with no pending or recent transactions

Considerations

Payment details with pending or recent transactions cannot be deleted
Deletion is permanent and cannot be undone
Alternative: Use PUT to update bank account details instead of deleting

Description

Permanently deletes a payment detail record from the system. This operation follows strict business rules to prevent deletion of payment methods with active or recent transaction history.

Advanced Resource: Payment detail records are typically managed through BizEntity operations. Use this endpoint for direct payment detail deletion only when the payment method is no longer needed or for data cleanup purposes.

Payment details with pending or recent transactions cannot be deleted. Deletion is permanent with no recovery mechanism available. Consider using PUT to update bank account details instead of deleting when possible.

Required Headers - See Authentication

Header	Value	Description
Authorization	{accessToken}	Bearer token for API access
Version	2.0	API version identifier

Query Parameters

Parameter	Type	Required	Description
`PaymentDetailID` >	integer	> Conditional...	The unique system identifier for the payment detail record to delete. Provide this for direct deletion using the internal 7G ID.
`ExternalPaymentDetailId` >	string(50)	> Conditional...	Your external system identifier for the payment detail record to delete. Use this when referencing payment details by your organization's ID system for cross-system consistency.

PaymentDetailID

integer

> Conditional...

The unique system identifier for the payment detail record to delete. Provide this for direct deletion using the internal 7G ID.

ExternalPaymentDetailId

string(50)

> Conditional...

Your external system identifier for the payment detail record to delete. Use this when referencing payment details by your organization's ID system for cross-system consistency.

Example Requests

bash

# Delete using payment detail ID
curl -X DELETE "https://api.7g.com.au/PaymentDetail?PaymentDetailID=12345" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

# Delete using external payment detail ID
curl -X DELETE "https://api.7g.com.au/PaymentDetail?ExternalPaymentDetailId=PD-001" \
  -H "Authorization: {accessToken}" \
  -H "Version: 2.0"

Response Examples

json

{
  "result": true,
  "message": "Payment detail deleted successfully",
  "recordCount": 0,
  "data": []
}