DELETE

/paymentdetail

Usage Notes

When

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

Requirements

Payment detail must have no pending or recent transactions

Notes

Payment details with pending transactions cannot be deleted
Deletion is permanent with no recovery mechanism
Alternative: keep record and add new payment detail instead

Description

Permanently deletes a payment detail record. Only works when no pending or recent transactions reference this payment method.

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": null
}