DELETE

/PaymentDetail

When to Use

Remove outdated or incorrect payment methods
Clean up duplicate or test payment details
Decommission payment accounts that are no longer used
Comply with data retention and privacy policies

Common Scenarios

Closed Account Cleanup: Remove payment details for bank accounts that have been closed or are no longer accessible
Duplicate Payment Method Removal: Delete duplicate payment details created during data imports or manual entry errors
Entity Transfer Preparation: Clean up payment details before transferring entities between systems or providers
Privacy Compliance: Remove payment details as part of data subject access requests or right to erasure requirements

Prerequisites

Valid Bearer token with payment detail deletion permissions
Payment detail must exist and be accessible to your account
No pending transactions using this payment method

Considerations

Business Rules: Payment details with pending or recent transactions cannot be deleted
Entity Relationship: Removing the last payment detail may affect distribution capabilities
Irreversible: Deletion is permanent and cannot be undone
Audit Trail: Consider keeping payment details for audit purposes even if no longer used

Description

Permanently deletes a payment detail record from the system. This operation has business rule validation to prevent deletion of payment methods that are actively used or have 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.

⚠️ Deletion Restrictions

Payment details cannot be deleted if they have:

Pending distribution or redemption transactions
Recent transaction history within the retention period
Active references from scheduled distributions

Recommended: Verify payment method is not referenced before deletion.

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": []
}