# POST /api/resellers/update-own-billing-preferences-async

Replaces the billing preferences of the calling operator's own reseller.

The reseller is resolved from the signed-in user, so this route takes no reseller id. Every
rule that applies to an administrator's edit of the same preferences applies here too.

The preferences are replaced wholesale, so a caller changing one field must first read the
current preferences and post them back with that field changed.

**Operation ID:** `resellersUpdateOwnBillingPreferences`

## Authorization

Requires: Resellers.Resellers.Update, reseller scope.

Requires API key scope: `admin`

Required permissions:
- `Resellers.Resellers.Update`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: [`ResellerBillingPreferences`](https://devportal.demo.winkpg.io/docs/api/models/ResellerBillingPreferences.md)

Properties:
- `defaultPaymentTerms` (integer(int32)): Days until invoice due date (e.g. 30). (nullable)
- `defaultCurrency` (string): ISO 4217 default currency for billing. (nullable, min length 0, max length 3)
- `hppPageId` (string(uuid)): HPP page ID used for invoice payment links. Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true. (nullable)
- `captureHppPageId` (string(uuid)): HPP page ID used to capture and store a card on file for the recurring-contract billing  path (the operator-driven payment-method capture flow). This must reference a  `SaveCard`-purpose page (zero-dollar verification, no charge) so capture does not  prompt the operator for an amount. Distinct from `hppPageId`, which is the  Invoicing payment-link page (a chargeable `Payment` page). Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
- `allowOnlinePayment` (boolean): Whether merchants can pay invoices online via HPP. (nullable)
- `allowStoredPaymentMethods` (boolean): Whether merchants can store payment methods for billing. (nullable)
- `autoChargeStoredMethod` (boolean): Auto-charge stored payment method after invoice generation. (nullable)
- `autoBillingEnabled` (boolean): Whether automated billing runs are enabled. (nullable)
- `billingPeriod` (integer(int32)): Billing period: 1=Monthly, 3=Quarterly. (nullable)
- `billingDayOfMonth` (integer(int32)): Day of month for billing runs (1-28). (nullable, min 1, max 28)
- `invoiceTemplateId` (string(uuid)): Invoice template ID (Phase 2: Invoicing module). (nullable)
- `defaultTaxRateId` (string(uuid)): Default tax rate ID (Phase 2: Invoicing module). (nullable)
- `sendInvoiceOnGeneration` (boolean): Auto-send invoice to merchant after generation. (nullable)
- `billingRunNotificationEmail` (string): Admin notification email for billing run completions. (nullable, min length 0, max length 256)
- `defaultFulfillmentPath` ([BillingFulfillmentPath](https://devportal.demo.winkpg.io/docs/api/models/BillingFulfillmentPath.md)): Default fulfillment path for billing runs under this reseller. When null and a merchant  has no per-assignment override, the merchant is skipped with result status  `NoFulfillmentPath`. (nullable)
  Values:
  - `Invoicing`: Generate an invoice in PhoeniXGate.Invoicing addressed to the Merchant and route payment through the reseller's configured Hosted Payment Page.
  - `RecurringContract`: Charge a stored payment method (card or ACH) against the Merchant on a schedule, via a recurring contract owned by the reseller's collection merchant.
- `collectionMerchantId` (string(uuid)): The reseller-owned billing entity that owns recurring contracts and vaults stored  payment methods. Required when `defaultFulfillmentPath` is  `RecurringContract`. This may be the reseller itself  or a designated child merchant; modeled internally as a single "MLB collection party"  reference so the legacy House Merchant flag is not reintroduced. Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
- `allowCardPayments` (boolean): Whether card tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents. (nullable)
- `allowAchPayments` (boolean): Whether ACH tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents, matching  `allowCardPayments`: both are read permissively, rejecting only an explicit  `false`. (nullable)

**Content type:** `text/json`

Schema: [`ResellerBillingPreferences`](https://devportal.demo.winkpg.io/docs/api/models/ResellerBillingPreferences.md)

Properties:
- `defaultPaymentTerms` (integer(int32)): Days until invoice due date (e.g. 30). (nullable)
- `defaultCurrency` (string): ISO 4217 default currency for billing. (nullable, min length 0, max length 3)
- `hppPageId` (string(uuid)): HPP page ID used for invoice payment links. Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true. (nullable)
- `captureHppPageId` (string(uuid)): HPP page ID used to capture and store a card on file for the recurring-contract billing  path (the operator-driven payment-method capture flow). This must reference a  `SaveCard`-purpose page (zero-dollar verification, no charge) so capture does not  prompt the operator for an amount. Distinct from `hppPageId`, which is the  Invoicing payment-link page (a chargeable `Payment` page). Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
- `allowOnlinePayment` (boolean): Whether merchants can pay invoices online via HPP. (nullable)
- `allowStoredPaymentMethods` (boolean): Whether merchants can store payment methods for billing. (nullable)
- `autoChargeStoredMethod` (boolean): Auto-charge stored payment method after invoice generation. (nullable)
- `autoBillingEnabled` (boolean): Whether automated billing runs are enabled. (nullable)
- `billingPeriod` (integer(int32)): Billing period: 1=Monthly, 3=Quarterly. (nullable)
- `billingDayOfMonth` (integer(int32)): Day of month for billing runs (1-28). (nullable, min 1, max 28)
- `invoiceTemplateId` (string(uuid)): Invoice template ID (Phase 2: Invoicing module). (nullable)
- `defaultTaxRateId` (string(uuid)): Default tax rate ID (Phase 2: Invoicing module). (nullable)
- `sendInvoiceOnGeneration` (boolean): Auto-send invoice to merchant after generation. (nullable)
- `billingRunNotificationEmail` (string): Admin notification email for billing run completions. (nullable, min length 0, max length 256)
- `defaultFulfillmentPath` ([BillingFulfillmentPath](https://devportal.demo.winkpg.io/docs/api/models/BillingFulfillmentPath.md)): Default fulfillment path for billing runs under this reseller. When null and a merchant  has no per-assignment override, the merchant is skipped with result status  `NoFulfillmentPath`. (nullable)
  Values:
  - `Invoicing`: Generate an invoice in PhoeniXGate.Invoicing addressed to the Merchant and route payment through the reseller's configured Hosted Payment Page.
  - `RecurringContract`: Charge a stored payment method (card or ACH) against the Merchant on a schedule, via a recurring contract owned by the reseller's collection merchant.
- `collectionMerchantId` (string(uuid)): The reseller-owned billing entity that owns recurring contracts and vaults stored  payment methods. Required when `defaultFulfillmentPath` is  `RecurringContract`. This may be the reseller itself  or a designated child merchant; modeled internally as a single "MLB collection party"  reference so the legacy House Merchant flag is not reintroduced. Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
- `allowCardPayments` (boolean): Whether card tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents. (nullable)
- `allowAchPayments` (boolean): Whether ACH tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents, matching  `allowCardPayments`: both are read permissively, rejecting only an explicit  `false`. (nullable)

**Content type:** `application/*+json`

Schema: [`ResellerBillingPreferences`](https://devportal.demo.winkpg.io/docs/api/models/ResellerBillingPreferences.md)

Properties:
- `defaultPaymentTerms` (integer(int32)): Days until invoice due date (e.g. 30). (nullable)
- `defaultCurrency` (string): ISO 4217 default currency for billing. (nullable, min length 0, max length 3)
- `hppPageId` (string(uuid)): HPP page ID used for invoice payment links. Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true. (nullable)
- `captureHppPageId` (string(uuid)): HPP page ID used to capture and store a card on file for the recurring-contract billing  path (the operator-driven payment-method capture flow). This must reference a  `SaveCard`-purpose page (zero-dollar verification, no charge) so capture does not  prompt the operator for an amount. Distinct from `hppPageId`, which is the  Invoicing payment-link page (a chargeable `Payment` page). Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
- `allowOnlinePayment` (boolean): Whether merchants can pay invoices online via HPP. (nullable)
- `allowStoredPaymentMethods` (boolean): Whether merchants can store payment methods for billing. (nullable)
- `autoChargeStoredMethod` (boolean): Auto-charge stored payment method after invoice generation. (nullable)
- `autoBillingEnabled` (boolean): Whether automated billing runs are enabled. (nullable)
- `billingPeriod` (integer(int32)): Billing period: 1=Monthly, 3=Quarterly. (nullable)
- `billingDayOfMonth` (integer(int32)): Day of month for billing runs (1-28). (nullable, min 1, max 28)
- `invoiceTemplateId` (string(uuid)): Invoice template ID (Phase 2: Invoicing module). (nullable)
- `defaultTaxRateId` (string(uuid)): Default tax rate ID (Phase 2: Invoicing module). (nullable)
- `sendInvoiceOnGeneration` (boolean): Auto-send invoice to merchant after generation. (nullable)
- `billingRunNotificationEmail` (string): Admin notification email for billing run completions. (nullable, min length 0, max length 256)
- `defaultFulfillmentPath` ([BillingFulfillmentPath](https://devportal.demo.winkpg.io/docs/api/models/BillingFulfillmentPath.md)): Default fulfillment path for billing runs under this reseller. When null and a merchant  has no per-assignment override, the merchant is skipped with result status  `NoFulfillmentPath`. (nullable)
  Values:
  - `Invoicing`: Generate an invoice in PhoeniXGate.Invoicing addressed to the Merchant and route payment through the reseller's configured Hosted Payment Page.
  - `RecurringContract`: Charge a stored payment method (card or ACH) against the Merchant on a schedule, via a recurring contract owned by the reseller's collection merchant.
- `collectionMerchantId` (string(uuid)): The reseller-owned billing entity that owns recurring contracts and vaults stored  payment methods. Required when `defaultFulfillmentPath` is  `RecurringContract`. This may be the reseller itself  or a designated child merchant; modeled internally as a single "MLB collection party"  reference so the legacy House Merchant flag is not reintroduced. Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
- `allowCardPayments` (boolean): Whether card tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents. (nullable)
- `allowAchPayments` (boolean): Whether ACH tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents, matching  `allowCardPayments`: both are read permissively, rejecting only an explicit  `false`. (nullable)

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`ResellerDto`](https://devportal.demo.winkpg.io/docs/api/models/ResellerDto.md)

Properties:
- `extraProperties` (object): (nullable, read only)
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
- `createdFromTemplateId` (string(uuid)): The template this record was created from, or `null` for one started blank. Set by the  create-from-template path and by the add/edit page's Load Template action when the record is  saved. (nullable)
- `name` (string): (nullable)
- `concurrencyStamp` (string): (nullable)
- `tenantId` (string(uuid)): (nullable, read only)
- `entityVersion` (integer(int32)): (read only)
- `parentReseller` (string(uuid)): (nullable)
- `customIdentifier` (string): (nullable)
- `dba` (string): (nullable)
- `code` (string): (nullable)
- `features` ([ResellerFeatures](https://devportal.demo.winkpg.io/docs/api/models/ResellerFeatures.md))
  Fields:
  - `privateLabeling` (boolean)
  - `hostedPage` (boolean)
  - `emulator` (boolean)
  - `merchantCustomFieldConfig` (boolean)
  - `merchantBilling` (boolean)
  - `tokenSharing` (boolean)
  - `subResellers` (boolean)
  - `tenders` ([TenderEnableFlags](https://devportal.demo.winkpg.io/docs/api/models/TenderEnableFlags.md)): Per-tender enable flags evaluated by the capability cascade. A  reseller that has not explicitly opted in to a non-credit tender (EBT/eWIC)  blocks every merchant beneath it from accepting that tender, regardless of  merchant-level or processor-account opt-in.
  - `paymentTokenization` (boolean): Reseller-level opt-in for payment tokenization. When `false` or unset, every merchant  beneath this reseller is blocked from tokenizing payments regardless of the per-merchant  `enablePaymentTokenization` override. (nullable)
- `contactDetail` ([ResellerContactDetail](https://devportal.demo.winkpg.io/docs/api/models/ResellerContactDetail.md)): Represents contact details for a reseller.
  Fields:
  - `primaryContactName` (string): (nullable, max length 100)
  - `emailAddress` (string): The contact's email address. Optional. A value that is not blank must be a valid email address. Conditional: When EmailAddress is not empty. Must be a valid email. (nullable)
  - `phone` (string): The contact's phone number. Optional. A value that is not empty must be a phone number: digits,  with an optional leading `+` and country code, optional parentheses around the area code,  and a space, hyphen or period between groups. Letters, including an extension such as  `x123`, are rejected. (nullable)
  - `fax` (string): The contact's fax number. Optional. Follows the same rule as the phone number. (nullable)
  - `companyUrl` (string): The company's website address. Optional. A value sent without a scheme, such as  `www.example.com`, is stored with `https://` added. A value that starts with  `http://` or `https://` is stored exactly as sent. Any other scheme, and text that is  not a website address, is rejected. (nullable)
  - `addresses` (array<[AddressInputModel](https://devportal.demo.winkpg.io/docs/api/models/AddressInputModel.md)>) required: (nullable)
- `businessInfo` ([ResellerBusinessInfo](https://devportal.demo.winkpg.io/docs/api/models/ResellerBusinessInfo.md)): Represents business-related information for a reseller.
  Fields:
  - `federalTaxId` (string): (nullable, max length 50)
  - `stateTaxId` (string): (nullable, max length 50)
  - `salesTaxId` (string): (nullable, max length 50)
  - `yearlySalesAmount` (number(double)): Conditional: When YearlySalesAmount is not null. Must be > 0. (nullable)
  - `businessStartDate` (string(date-time)): (nullable)
  - `currency` (string): (nullable, max length 3)
- `branding` ([ResellerBranding](https://devportal.demo.winkpg.io/docs/api/models/ResellerBranding.md)): Represents branding information for a reseller, including domain, product, contact, and icon details.
  Fields:
  - `brandedDomainName` (string): Gets or sets the branded domain name for the reseller. (nullable)
  - `productName` (string): Gets or sets the product name for the reseller's offering. (nullable)
  - `emailFromName` (string): Gets or sets the display name used in emails sent from the reseller. (nullable)
  - `emailFromAddress` (string): Gets or sets the email address used as the sender in emails from the reseller. (nullable)
  - `logo` (string): Gets or sets the URL or path to the reseller's logo. (nullable)
  - `displayAddress` ([Address](https://devportal.demo.winkpg.io/docs/api/models/Address.md)): Gets or sets the display address for the reseller. Conditional: Conditional (see validator source).
  - `sdkGlobalName` (string): Gets or sets the window-global name the branded embed SDK shim assigns to the  brand-neutral core artifact (for example "MyBrandPaySDK"). Falls back to the platform  default global name when unset. Conditional: When SdkGlobalName is not empty. Max length: 60. (nullable)
  - `supportPhone` (string): Gets or sets the support phone number for the reseller. (nullable)
  - `salesPhone` (string): Gets or sets the sales phone number for the reseller. (nullable)
  - `supportEmail` (string): Gets or sets the support email address for the reseller. (nullable)
  - `favIcons` ([BrandingFavIcons](https://devportal.demo.winkpg.io/docs/api/models/BrandingFavIcons.md)): Gets or sets the favicon and icon URLs for the reseller's branding.
- `billingPreferences` ([ResellerBillingPreferences](https://devportal.demo.winkpg.io/docs/api/models/ResellerBillingPreferences.md)): Per-reseller billing configuration embedded on the Reseller aggregate root.  Controls billing run scheduling, payment terms, and invoice generation preferences.
  Fields:
  - `defaultPaymentTerms` (integer(int32)): Days until invoice due date (e.g. 30). (nullable)
  - `defaultCurrency` (string): ISO 4217 default currency for billing. (nullable, min length 0, max length 3)
  - `hppPageId` (string(uuid)): HPP page ID used for invoice payment links. Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true. (nullable)
  - `captureHppPageId` (string(uuid)): HPP page ID used to capture and store a card on file for the recurring-contract billing  path (the operator-driven payment-method capture flow). This must reference a  `SaveCard`-purpose page (zero-dollar verification, no charge) so capture does not  prompt the operator for an amount. Distinct from `hppPageId`, which is the  Invoicing payment-link page (a chargeable `Payment` page). Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
  - `allowOnlinePayment` (boolean): Whether merchants can pay invoices online via HPP. (nullable)
  - `allowStoredPaymentMethods` (boolean): Whether merchants can store payment methods for billing. (nullable)
  - `autoChargeStoredMethod` (boolean): Auto-charge stored payment method after invoice generation. (nullable)
  - `autoBillingEnabled` (boolean): Whether automated billing runs are enabled. (nullable)
  - `billingPeriod` (integer(int32)): Billing period: 1=Monthly, 3=Quarterly. (nullable)
  - `billingDayOfMonth` (integer(int32)): Day of month for billing runs (1-28). (nullable, min 1, max 28)
  - `invoiceTemplateId` (string(uuid)): Invoice template ID (Phase 2: Invoicing module). (nullable)
  - `defaultTaxRateId` (string(uuid)): Default tax rate ID (Phase 2: Invoicing module). (nullable)
  - `sendInvoiceOnGeneration` (boolean): Auto-send invoice to merchant after generation. (nullable)
  - `billingRunNotificationEmail` (string): Admin notification email for billing run completions. (nullable, min length 0, max length 256)
  - `defaultFulfillmentPath` ([BillingFulfillmentPath](https://devportal.demo.winkpg.io/docs/api/models/BillingFulfillmentPath.md)): Default fulfillment path for billing runs under this reseller. When null and a merchant  has no per-assignment override, the merchant is skipped with result status  `NoFulfillmentPath`. (nullable)
    Values:
    - `Invoicing`: Generate an invoice in PhoeniXGate.Invoicing addressed to the Merchant and route payment through the reseller's configured Hosted Payment Page.
    - `RecurringContract`: Charge a stored payment method (card or ACH) against the Merchant on a schedule, via a recurring contract owned by the reseller's collection merchant.
  - `collectionMerchantId` (string(uuid)): The reseller-owned billing entity that owns recurring contracts and vaults stored  payment methods. Required when `defaultFulfillmentPath` is  `RecurringContract`. This may be the reseller itself  or a designated child merchant; modeled internally as a single "MLB collection party"  reference so the legacy House Merchant flag is not reintroduced. Required: When DefaultFulfillmentPath == RecurringContract. (nullable)
  - `allowCardPayments` (boolean): Whether card tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents. (nullable)
  - `allowAchPayments` (boolean): Whether ACH tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents, matching  `allowCardPayments`: both are read permissively, rejecting only an explicit  `false`. (nullable)
- `processingDefaults` ([ResellerProcessingDefaults](https://devportal.demo.winkpg.io/docs/api/models/ResellerProcessingDefaults.md)): Gets or sets the portfolio-wide processing defaults applied to merchants under this reseller  that have left the matching merchant-level setting unset. `null` when the reseller sets  no defaults.
  Fields:
  - `enableCreateIdempotency` (boolean): Default for `Merchant.Processing.EnableCreateIdempotency`, applied to every merchant under  this reseller that has left its own value unset. `null` means the reseller sets  no default and an unset merchant runs with create idempotency off, as before. (nullable)
  - `cardAcceptancePolicy` ([CardAcceptancePolicy](https://devportal.demo.winkpg.io/docs/api/models/CardAcceptancePolicy.md)): Default for `Merchant.Processing.CardAcceptancePolicy`, applied to every merchant under  this reseller that has no policy of its own. `null` means the reseller sets no  default and a merchant without a policy accepts every card, as before. Conditional: When CardAcceptancePolicy is not null.
- `isTest` (boolean)
- `legacyNumber` (integer(int64)): Gets the reseller's legacy numeric key, the integer identifier the v1 API addresses resellers  by (its `ResellerKey`). Server-owned and stamped once at create; null on resellers written  before the field existed until the v1 data migration back-fills them. (nullable)
- `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): Gets or sets operational notes attached to the reseller. (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `enteredBy` (string(uuid))
  - `timestamp` (string(date-time))
  - `enteredByName` (string): Denormalized display name of the user who created the note.  Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering. (nullable)
  - `content` (string): (nullable, min length 0, max length 1000)

_Example: Active reseller_

A production reseller with its contact details, the branding and display address its merchants see, and its feature switches.

```json
{
  "id": "5c2e7a90-1b3d-4e6f-8a0b-1c2d3e4f5a01",
  "name": "Sample Reseller",
  "concurrencyStamp": "8e4b2d6f0a1c4d3e9f5a6b7c8d9e0f1a",
  "entityVersion": 0,
  "customIdentifier": "SR-0001",
  "dba": "Sample Payments",
  "code": "SAMPLE",
  "features": {
    "privateLabeling": true,
    "hostedPage": true,
    "emulator": true,
    "merchantCustomFieldConfig": true,
    "merchantBilling": true,
    "tokenSharing": false,
    "subResellers": true,
    "paymentTokenization": false
  },
  "contactDetail": {
    "primaryContactName": "Alex Johnson",
    "emailAddress": "alex.johnson@example.com",
    "phone": "555-555-0150",
    "fax": "",
    "companyUrl": "https://www.example.com",
    "addresses": [ ]
  },
  "businessInfo": {
    "currency": "USD"
  },
  "branding": {
    "brandedDomainName": "payments.example.com",
    "productName": "Sample Gateway",
    "emailFromName": "Sample Payments",
    "emailFromAddress": "no-reply@example.com",
    "displayAddress": {
      "id": "5c2e7a90-1b3d-4e6f-8a0b-1c2d3e4f5a02",
      "address1": "300 Market St",
      "address2": "",
      "city": "Scottsdale",
      "state": "AZ",
      "province": "",
      "zip": "85251",
      "postalCode": "",
      "country": "USA",
      "isMailing": false,
      "isDefault": false
    },
    "supportPhone": "555-555-0199",
    "supportEmail": "support@example.com",
    "favIcons": { }
  },
  "isTest": false,
  "notes": [ ],
  "isDeleted": false,
  "lastModificationTime": "2025-11-20T18:15:00.0000000+00:00",
  "creationTime": "2025-03-03T15:00:00.0000000+00:00",
  "extraProperties": { }
}
```

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a ResellerBillingPreferences. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/resellers/update-own-billing-preferences-async" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "defaultPaymentTerms": 0,
  "defaultCurrency": "",
  "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowOnlinePayment": false,
  "allowStoredPaymentMethods": false,
  "autoChargeStoredMethod": false,
  "autoBillingEnabled": false,
  "billingPeriod": 0,
  "billingDayOfMonth": 1,
  "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sendInvoiceOnGeneration": false,
  "billingRunNotificationEmail": "",
  "defaultFulfillmentPath": {},
  "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowCardPayments": false,
  "allowAchPayments": false
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "defaultPaymentTerms": 0,
  "defaultCurrency": "",
  "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowOnlinePayment": false,
  "allowStoredPaymentMethods": false,
  "autoChargeStoredMethod": false,
  "autoBillingEnabled": false,
  "billingPeriod": 0,
  "billingDayOfMonth": 1,
  "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sendInvoiceOnGeneration": false,
  "billingRunNotificationEmail": "",
  "defaultFulfillmentPath": {},
  "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowCardPayments": false,
  "allowAchPayments": false
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/resellers/update-own-billing-preferences-async' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, ResellersApi } from '@winkpg/winkpg-api';

const api = new ResellersApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.resellersUpdateOwnBillingPreferences({
  "defaultPaymentTerms": 0,
  "defaultCurrency": "",
  "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowOnlinePayment": false,
  "allowStoredPaymentMethods": false,
  "autoChargeStoredMethod": false,
  "autoBillingEnabled": false,
  "billingPeriod": 0,
  "billingDayOfMonth": 1,
  "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sendInvoiceOnGeneration": false,
  "billingRunNotificationEmail": "",
  "defaultFulfillmentPath": {},
  "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowCardPayments": false,
  "allowAchPayments": false
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/resellers/update-own-billing-preferences-async', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "defaultPaymentTerms": 0,
    "defaultCurrency": "",
    "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "allowOnlinePayment": false,
    "allowStoredPaymentMethods": false,
    "autoChargeStoredMethod": false,
    "autoBillingEnabled": false,
    "billingPeriod": 0,
    "billingDayOfMonth": 1,
    "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sendInvoiceOnGeneration": false,
    "billingRunNotificationEmail": "",
    "defaultFulfillmentPath": {},
    "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "allowCardPayments": false,
    "allowAchPayments": false
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new ResellersApi(config);
var body = JsonSerializer.Deserialize<ResellerBillingPreferences>("""
    {
      "defaultPaymentTerms": 0,
      "defaultCurrency": "",
      "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allowOnlinePayment": false,
      "allowStoredPaymentMethods": false,
      "autoChargeStoredMethod": false,
      "autoBillingEnabled": false,
      "billingPeriod": 0,
      "billingDayOfMonth": 1,
      "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sendInvoiceOnGeneration": false,
      "billingRunNotificationEmail": "",
      "defaultFulfillmentPath": {},
      "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allowCardPayments": false,
      "allowAchPayments": false
    }
    """);

var result = await api.ResellersUpdateOwnBillingPreferencesAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/resellers/update-own-billing-preferences-async");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "defaultPaymentTerms": 0,
      "defaultCurrency": "",
      "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allowOnlinePayment": false,
      "allowStoredPaymentMethods": false,
      "autoChargeStoredMethod": false,
      "autoBillingEnabled": false,
      "billingPeriod": 0,
      "billingDayOfMonth": 1,
      "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sendInvoiceOnGeneration": false,
      "billingRunNotificationEmail": "",
      "defaultFulfillmentPath": {},
      "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allowCardPayments": false,
      "allowAchPayments": false
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.ResellersApi(client)
    body = winkpg_api.ResellerBillingPreferences.from_dict({
      "defaultPaymentTerms": 0,
      "defaultCurrency": "",
      "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allowOnlinePayment": False,
      "allowStoredPaymentMethods": False,
      "autoChargeStoredMethod": False,
      "autoBillingEnabled": False,
      "billingPeriod": 0,
      "billingDayOfMonth": 1,
      "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sendInvoiceOnGeneration": False,
      "billingRunNotificationEmail": "",
      "defaultFulfillmentPath": {},
      "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allowCardPayments": False,
      "allowAchPayments": False
    })
    result = api.resellers_update_own_billing_preferences(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "defaultPaymentTerms": 0,
  "defaultCurrency": "",
  "hppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "captureHppPageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowOnlinePayment": False,
  "allowStoredPaymentMethods": False,
  "autoChargeStoredMethod": False,
  "autoBillingEnabled": False,
  "billingPeriod": 0,
  "billingDayOfMonth": 1,
  "invoiceTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultTaxRateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sendInvoiceOnGeneration": False,
  "billingRunNotificationEmail": "",
  "defaultFulfillmentPath": {},
  "collectionMerchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allowCardPayments": False,
  "allowAchPayments": False
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/resellers/update-own-billing-preferences-async",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.