Update Affiliate Settlement

put

https://example.com/programs/{programCode}/affiliate/settlements/{affiliateSettlementsIdentifier}

Updates an existing affiliate settlement for the specified program.

Path Params

programCode

string

required

The program code associated with the affiliate settlement.

affiliateSettlementsIdentifier

string

required

The identifier of the affiliate settlement to update.

Body Params

The affiliate settlement update request payload.

settlementRail

string | null

The settlement rail used for processing the affiliate settlement (e.g., ACH, Wire).

frequency

string | null

The frequency of the affiliate settlement (e.g., daily, weekly, monthly).

bankName

string | null

The name of the bank associated with the affiliate settlement.

description

string | null

An optional description for the affiliate settlement.

encryptedData

object

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.

Headers

X-GD-RequestId

string

required

The unique request identifier for tracking.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

200OK

403Forbidden

500Internal Server Error

503Service Unavailable