GRgreendot
Affiliate

Create Affiliate Settlement

Creates a new affiliate settlement for the specified program.

post/programs/{programCode}/affiliate/settlements

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code to associate the affiliate settlement with.

Headers

X-GD-RequestIdstring required

The unique request identifier for tracking.

Request body

affiliateIdentifierstring nullable

The unique identifier for the affiliate for whom the settlement is being created.

settlementRailstring nullable

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

frequencystring nullable

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

bankNamestring nullable

The name of the bank associated with the affiliate settlement.

descriptionstring nullable

An optional description for the affiliate settlement.

Response

OK

affiliateSettlementIdentifierstring nullable

Gets or sets the unique identifier for the created affiliate settlement.

Changes

No recorded changes to this operation across all 2 revisions of this API.