---
title: "Delete Affiliate Settlement"
method: DELETE
path: "/programs/{programCode}/affiliate/settlements/{affiliateSettlementIdentifier}"
tags: ["Affiliate"]
---

# Delete Affiliate Settlement

`DELETE /programs/{programCode}/affiliate/settlements/{affiliateSettlementIdentifier}`

Deletes a specific affiliate settlement for the specified program.

## Path parameters

- `programCode` string, required
- `affiliateSettlementIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- DeleteAffiliateSettlementResponse — Represents the response for deleting an affiliate settlement. Inherits standard response metadata and details from Gd.Bos.DataTransfer.Response.ResponseBase. Contains the affiliate settlement data that was deleted.
  - `affiliateSettlement` AffiliateSettlement — Represents an affiliate settlement entity with status, frequency, rail, and related affiliate information. Used in API responses to convey affiliate settlement details.
    - `affiliateSettlementIdentifier` string, nullable — The unique identifier for the affiliate settlement.
    - `bankName` string, nullable — The name of the bank associated with the affiliate settlement.
    - `description` string, nullable — The description of the affiliate settlement.
    - `affiliateSettlementStatus` 'Pending' | 'Active' | 'Denied' | 'Inactive' — The status of the affiliate settlement.
    - `frequency` 'Daily' | 'Weekly' | 'Monthly' | 'NotApplicable' | 'PerUse' | 'Yearly' | 'BiYearly' | 'Initial' | 'Quarterly' | 'SemiYearly' — The frequency of the affiliate settlement.
    - `settlementRail` 'ACH' — The settlement rail used for the affiliate settlement.
    - `encryptedData` EncryptedData — Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.
      - `version` string, nullable — The version of the encryption algorithm used to encrypt the data (e.g., "v1", "v2").
      - `ephemeralPublicKey` string, nullable — The ephemeral public key used in the encryption process, typically for key exchange or session establishment.
      - `publicKeyHash` string, nullable — The hash of the public key used to verify the integrity and authenticity of the encryption key.
      - `data` string, nullable — The encrypted data payload, typically base64-encoded, containing the sensitive information.
    - `affiliate` Affiliate — Represents an affiliate entity with onboarding status and address information. Used in API responses to convey affiliate details.
      - `affiliateName` string, nullable — The name of the affiliate.
      - `affiliateIdentifier` string, nullable — The unique identifier for the affiliate.
      - `affiliateOnboardingStatus` 'Pending' | 'Active' | 'Denied' | 'Inactive' — The onboarding status of the affiliate.
      - `addressLine1` string, nullable — The first line of the affiliate's address.
      - `addressLine2` string, nullable — The second line of the affiliate's address.
      - `city` string, nullable — The city where the affiliate is located.
      - `state` string, nullable — The state where the affiliate is located.
      - `zipCode` string, nullable — The ZIP code of the affiliate's address.
      - `programCode` string, nullable — The program code associated with the affiliate.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)