# POST /api/merchants

Create merchant

Creates a new merchant account in the payment gateway system with the specified configuration.

**Operation ID:** `POST_api_merchants`

## Authorization

Requires: Merchants.Merchants.Create, merchant scope.

Required permissions:
- `Merchants.Merchants.Create`

## Parameters

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

## Request Body

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

Schema: `PhoeniXGateMerchantsMerchantCreateDto`

_Example: Create Sample Merchant_

Creates a sample merchant with a basic configuration

```json
{
  "name": "Sample Merchant",
  "isActive": true,
  "resellerId": "00000000-0000-0000-0000-000000000000",
  "customIdentifier": null,
  "dba": null,
  "mcc": "5411",
  "isTest": true,
  "environment": null,
  "processorMode": null,
  "contactDetail": {
    "primaryContactName": "Primary Contact",
    "emailAddress": "sample@winkpg.io",
    "phone": "555-555-5555",
    "fax": "",
    "companyUrl": "https://www.winkpg.io",
    "addresses": [
      {
        "id": "0f8b0806-4e04-4be5-9772-ef1660e80957",
        "address1": "22601 N. 19th Ave",
        "address2": "Suite 212",
        "city": "Phoenix",
        "state": "AZ",
        "province": "",
        "zip": "85027",
        "postalCode": "",
        "country": "USA",
        "isMailing": true,
        "isDefault": true
      }
    ]
  },
  "businessInfo": {
    "ownershipType": null,
    "federalTaxId": null,
    "stateTaxId": null,
    "salesTaxId": null,
    "yearlySalesAmount": null,
    "businessStartDate": null,
    "currency": "USD"
  },
  "virtualTerminal": {
    "cardBinPrompting": {
      "enableCommercial": true,
      "enableGsa": false,
      "enableFsa": false
    },
    "allowRepeatSales": true,
    "allowRefunds": true,
    "enableEmailReceipts": true,
    "fields": {
      "customer": {
        "allowAddNew": false,
        "fieldKey": "Customer",
        "enabled": false,
        "required": false
      },
      "invoiceNumber": {
        "fieldKey": "InvoiceNum",
        "enabled": false,
        "required": false
      },
      "purchaseOrderNumber": {
        "fieldKey": "PONum",
        "enabled": false,
        "required": false
      },
      "billingAddress": {
        "requireOnlyAvsFields": false,
        "fieldKey": "BillingAddress",
        "enabled": false,
        "required": false
      },
      "shippingAddress": {
        "defaultToSameAsBilling": true,
        "fieldKey": "ShippingAddress",
        "enabled": false,
        "required": false
      },
      "contactPhone": {
        "maskField": true,
        "maskExpression": "(000) 000-0000",
        "fieldKey": "Phone",
        "enabled": false,
        "required": false
      },
      "level3Amount": {
        "defaultAmount": null,
        "fieldKey": "Level3Amount",
        "enabled": false,
        "required": false
      },
      "shippingAmount": {
        "defaultAmount": null,
        "fieldKey": "ShippingAmount",
        "enabled": false,
        "required": false
      },
      "convenienceAmount": {
        "autoCalculate": false,
        "calculationPercentage": null,
        "mode": null,
        "percentage": null,
        "govEducationAttested": null,
        "govEducationAttestedBy": null,
        "govEducationAttestedOn": null,
        "visaServiceFeeRegistered": null,
        "visaServiceFeeRegisteredOn": null,
        "visaServiceFeeRegistrationRecordedBy": null,
        "visaServiceFeeRegistrationRecordedOn": null,
        "attestedCostOfAcceptanceRate": null,
        "costOfAcceptanceAttestedBy": null,
        "costOfAcceptanceAttestedOn": null,
        "exemptDebit": null,
        "exemptPrepaid": null,
        "legacyPercentageNeedsReview": null,
        "standardChannel": null,
        "alternativeChannel": null,
        "alternativeChannelAttested": null,
        "alternativeChannelAttestedBy": null,
        "alternativeChannelAttestedOn": null,
        "offlineChannelExceptionGranted": null,
        "offlineChannelExceptionGrantedBy": null,
        "offlineChannelExceptionGrantedOn": null,
        "offlineChannelExceptionReason": null,
        "customName": "Convenience Fee",
        "customDescription": null,
        "readOnly": false,
        "defaultAmount": null,
        "fieldKey": "ConvenienceFee",
        "enabled": false,
        "required": false
      },
      "dutyAmount": {
        "defaultAmount": null,
        "fieldKey": "DutyAmount",
        "enabled": false,
        "required": false
      },
      "tipAmount": {
        "defaultAmount": null,
        "fieldKey": "TipAmount",
        "enabled": false,
        "required": false
      },
      "taxAmount": {
        "autoCalculate": false,
        "defaultRate": null,
        "fieldKey": "TaxAmount",
        "enabled": false,
        "required": false
      },
      "emailAddress": {
        "validateFormat": false,
        "validationRegex": null,
        "placeholder": null,
        "fieldKey": "Email",
        "enabled": false,
        "required": false
      }
    },
    "allowPartialApprovals": true,
    "partialApprovalStrategy": null,
    "allowSplitTender": true,
    "allowTipAdjustmentOnPartialApproval": false,
    "splitTenderMaxTenders": 2,
    "partialApprovalAckTimeoutMinutes": 15
  },
  "processing": {
    "duplicateCheck": {
      "enable": true,
      "includeInvoiceNumber": false,
      "allowOverride": true
    },
    "orderDataDefaults": {
      "enable": false,
      "applyLevel2DefaultsToApi": true,
      "applyLevel3DefaultsToApi": true,
      "applyLevel2DefaultsToVt": true,
      "applyLevel3DefaultsToVt": true,
      "defaultMerchantZip": null,
      "defaultTaxRate": null,
      "defaultShipFromZip": null,
      "defaultDestinationCountryCode": null,
      "defaultDutyAmount": null,
      "defaultFreightAmount": null,
      "defaultDiscountAmount": null,
      "defaultLineItemValues": null,
      "defaultLineItem": null
    },
    "cardVerification": {
      "avNoMatch": true,
      "avPartialMatch": true,
      "avPartialMatchIntl": false,
      "avNoMatchIntl": false,
      "avMatchIntl": false,
      "avError": true,
      "avMatchUK": false,
      "avNotSupportedIntl": false,
      "avIntlNoMatch": false,
      "avMatchIntlBoth": false,
      "avZipMatchIntl": false,
      "avRetry": true,
      "avNotSupported": true,
      "avUnavailable": true,
      "avZipPartialMatch9Digit": true,
      "avZipMatch9Digit": true,
      "avZipMatch5Digit": true,
      "avZipPartialMatch5Digit": true,
      "cvvMatch": true,
      "cvvNoMatch": true,
      "cvvNotProcessed": true,
      "cvvNotProvided": true,
      "cvvIssuerNotCertified": true,
      "cvvUnableToProcess": true
    },
    "requireLevel2Data": false,
    "requireNameOnCard": false,
    "requireZipCode": false,
    "requireShipping": false,
    "enableForceCapture": false,
    "requestProcessorToken": null,
    "enableCreateIdempotency": null,
    "processorProfiles": [ ],
    "screeningProviderProfiles": null,
    "autoSettlement": {
      "enable": false,
      "settlementTime": null,
      "sendMerchantEmail": false,
      "userNotificationType": "Primary",
      "additionalEmailNotifications": [ ],
      "currentBatchIds": { },
      "currentBatchId": null
    },
    "registers": [ ]
  },
  "features": {
    "enableGsaBinCheck": false,
    "enableAuthEdit": false,
    "configurationLimits": {
      "allowCustomFieldConfig": true,
      "allowHostedPaymentPageConfig": false,
      "allowOrderDataDefaultsConfig": false,
      "allowEmulatorConfig": false,
      "allowFraudControlConfig": false,
      "allowFraudLog": false,
      "allowQuickPayConfig": false,
      "allowPaymentTokenizationConfig": false
    },
    "merchantBilling": {
      "pricePlanId": null,
      "pricePlanVersion": null,
      "priceOverrides": null
    },
    "tenders": null,
    "enablePaymentTokenization": null,
    "hppTokenizeOnPaymentDefault": null
  },
  "customFields": [ ],
  "branding": null,
  "accountUpdater": null,
  "merchantFlowConfig": null,
  "billingAssignment": null,
  "notes": [ ],
  "digitalWallets": [ ]
}
```

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

Schema: `PhoeniXGateMerchantsMerchantCreateDto`

_Example: Create Sample Merchant_

Creates a sample merchant with a basic configuration

```json
{
  "name": "Sample Merchant",
  "isActive": true,
  "resellerId": "00000000-0000-0000-0000-000000000000",
  "customIdentifier": null,
  "dba": null,
  "mcc": "5411",
  "isTest": true,
  "environment": null,
  "processorMode": null,
  "contactDetail": {
    "primaryContactName": "Primary Contact",
    "emailAddress": "sample@winkpg.io",
    "phone": "555-555-5555",
    "fax": "",
    "companyUrl": "https://www.winkpg.io",
    "addresses": [
      {
        "id": "0f8b0806-4e04-4be5-9772-ef1660e80957",
        "address1": "22601 N. 19th Ave",
        "address2": "Suite 212",
        "city": "Phoenix",
        "state": "AZ",
        "province": "",
        "zip": "85027",
        "postalCode": "",
        "country": "USA",
        "isMailing": true,
        "isDefault": true
      }
    ]
  },
  "businessInfo": {
    "ownershipType": null,
    "federalTaxId": null,
    "stateTaxId": null,
    "salesTaxId": null,
    "yearlySalesAmount": null,
    "businessStartDate": null,
    "currency": "USD"
  },
  "virtualTerminal": {
    "cardBinPrompting": {
      "enableCommercial": true,
      "enableGsa": false,
      "enableFsa": false
    },
    "allowRepeatSales": true,
    "allowRefunds": true,
    "enableEmailReceipts": true,
    "fields": {
      "customer": {
        "allowAddNew": false,
        "fieldKey": "Customer",
        "enabled": false,
        "required": false
      },
      "invoiceNumber": {
        "fieldKey": "InvoiceNum",
        "enabled": false,
        "required": false
      },
      "purchaseOrderNumber": {
        "fieldKey": "PONum",
        "enabled": false,
        "required": false
      },
      "billingAddress": {
        "requireOnlyAvsFields": false,
        "fieldKey": "BillingAddress",
        "enabled": false,
        "required": false
      },
      "shippingAddress": {
        "defaultToSameAsBilling": true,
        "fieldKey": "ShippingAddress",
        "enabled": false,
        "required": false
      },
      "contactPhone": {
        "maskField": true,
        "maskExpression": "(000) 000-0000",
        "fieldKey": "Phone",
        "enabled": false,
        "required": false
      },
      "level3Amount": {
        "defaultAmount": null,
        "fieldKey": "Level3Amount",
        "enabled": false,
        "required": false
      },
      "shippingAmount": {
        "defaultAmount": null,
        "fieldKey": "ShippingAmount",
        "enabled": false,
        "required": false
      },
      "convenienceAmount": {
        "autoCalculate": false,
        "calculationPercentage": null,
        "mode": null,
        "percentage": null,
        "govEducationAttested": null,
        "govEducationAttestedBy": null,
        "govEducationAttestedOn": null,
        "visaServiceFeeRegistered": null,
        "visaServiceFeeRegisteredOn": null,
        "visaServiceFeeRegistrationRecordedBy": null,
        "visaServiceFeeRegistrationRecordedOn": null,
        "attestedCostOfAcceptanceRate": null,
        "costOfAcceptanceAttestedBy": null,
        "costOfAcceptanceAttestedOn": null,
        "exemptDebit": null,
        "exemptPrepaid": null,
        "legacyPercentageNeedsReview": null,
        "standardChannel": null,
        "alternativeChannel": null,
        "alternativeChannelAttested": null,
        "alternativeChannelAttestedBy": null,
        "alternativeChannelAttestedOn": null,
        "offlineChannelExceptionGranted": null,
        "offlineChannelExceptionGrantedBy": null,
        "offlineChannelExceptionGrantedOn": null,
        "offlineChannelExceptionReason": null,
        "customName": "Convenience Fee",
        "customDescription": null,
        "readOnly": false,
        "defaultAmount": null,
        "fieldKey": "ConvenienceFee",
        "enabled": false,
        "required": false
      },
      "dutyAmount": {
        "defaultAmount": null,
        "fieldKey": "DutyAmount",
        "enabled": false,
        "required": false
      },
      "tipAmount": {
        "defaultAmount": null,
        "fieldKey": "TipAmount",
        "enabled": false,
        "required": false
      },
      "taxAmount": {
        "autoCalculate": false,
        "defaultRate": null,
        "fieldKey": "TaxAmount",
        "enabled": false,
        "required": false
      },
      "emailAddress": {
        "validateFormat": false,
        "validationRegex": null,
        "placeholder": null,
        "fieldKey": "Email",
        "enabled": false,
        "required": false
      }
    },
    "allowPartialApprovals": true,
    "partialApprovalStrategy": null,
    "allowSplitTender": true,
    "allowTipAdjustmentOnPartialApproval": false,
    "splitTenderMaxTenders": 2,
    "partialApprovalAckTimeoutMinutes": 15
  },
  "processing": {
    "duplicateCheck": {
      "enable": true,
      "includeInvoiceNumber": false,
      "allowOverride": true
    },
    "orderDataDefaults": {
      "enable": false,
      "applyLevel2DefaultsToApi": true,
      "applyLevel3DefaultsToApi": true,
      "applyLevel2DefaultsToVt": true,
      "applyLevel3DefaultsToVt": true,
      "defaultMerchantZip": null,
      "defaultTaxRate": null,
      "defaultShipFromZip": null,
      "defaultDestinationCountryCode": null,
      "defaultDutyAmount": null,
      "defaultFreightAmount": null,
      "defaultDiscountAmount": null,
      "defaultLineItemValues": null,
      "defaultLineItem": null
    },
    "cardVerification": {
      "avNoMatch": true,
      "avPartialMatch": true,
      "avPartialMatchIntl": false,
      "avNoMatchIntl": false,
      "avMatchIntl": false,
      "avError": true,
      "avMatchUK": false,
      "avNotSupportedIntl": false,
      "avIntlNoMatch": false,
      "avMatchIntlBoth": false,
      "avZipMatchIntl": false,
      "avRetry": true,
      "avNotSupported": true,
      "avUnavailable": true,
      "avZipPartialMatch9Digit": true,
      "avZipMatch9Digit": true,
      "avZipMatch5Digit": true,
      "avZipPartialMatch5Digit": true,
      "cvvMatch": true,
      "cvvNoMatch": true,
      "cvvNotProcessed": true,
      "cvvNotProvided": true,
      "cvvIssuerNotCertified": true,
      "cvvUnableToProcess": true
    },
    "requireLevel2Data": false,
    "requireNameOnCard": false,
    "requireZipCode": false,
    "requireShipping": false,
    "enableForceCapture": false,
    "requestProcessorToken": null,
    "enableCreateIdempotency": null,
    "processorProfiles": [ ],
    "screeningProviderProfiles": null,
    "autoSettlement": {
      "enable": false,
      "settlementTime": null,
      "sendMerchantEmail": false,
      "userNotificationType": "Primary",
      "additionalEmailNotifications": [ ],
      "currentBatchIds": { },
      "currentBatchId": null
    },
    "registers": [ ]
  },
  "features": {
    "enableGsaBinCheck": false,
    "enableAuthEdit": false,
    "configurationLimits": {
      "allowCustomFieldConfig": true,
      "allowHostedPaymentPageConfig": false,
      "allowOrderDataDefaultsConfig": false,
      "allowEmulatorConfig": false,
      "allowFraudControlConfig": false,
      "allowFraudLog": false,
      "allowQuickPayConfig": false,
      "allowPaymentTokenizationConfig": false
    },
    "merchantBilling": {
      "pricePlanId": null,
      "pricePlanVersion": null,
      "priceOverrides": null
    },
    "tenders": null,
    "enablePaymentTokenization": null,
    "hppTokenizeOnPaymentDefault": null
  },
  "customFields": [ ],
  "branding": null,
  "accountUpdater": null,
  "merchantFlowConfig": null,
  "billingAssignment": null,
  "notes": [ ],
  "digitalWallets": [ ]
}
```

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

Schema: `PhoeniXGateMerchantsMerchantCreateDto`

_Example: Create Sample Merchant_

Creates a sample merchant with a basic configuration

```json
{
  "name": "Sample Merchant",
  "isActive": true,
  "resellerId": "00000000-0000-0000-0000-000000000000",
  "customIdentifier": null,
  "dba": null,
  "mcc": "5411",
  "isTest": true,
  "environment": null,
  "processorMode": null,
  "contactDetail": {
    "primaryContactName": "Primary Contact",
    "emailAddress": "sample@winkpg.io",
    "phone": "555-555-5555",
    "fax": "",
    "companyUrl": "https://www.winkpg.io",
    "addresses": [
      {
        "id": "0f8b0806-4e04-4be5-9772-ef1660e80957",
        "address1": "22601 N. 19th Ave",
        "address2": "Suite 212",
        "city": "Phoenix",
        "state": "AZ",
        "province": "",
        "zip": "85027",
        "postalCode": "",
        "country": "USA",
        "isMailing": true,
        "isDefault": true
      }
    ]
  },
  "businessInfo": {
    "ownershipType": null,
    "federalTaxId": null,
    "stateTaxId": null,
    "salesTaxId": null,
    "yearlySalesAmount": null,
    "businessStartDate": null,
    "currency": "USD"
  },
  "virtualTerminal": {
    "cardBinPrompting": {
      "enableCommercial": true,
      "enableGsa": false,
      "enableFsa": false
    },
    "allowRepeatSales": true,
    "allowRefunds": true,
    "enableEmailReceipts": true,
    "fields": {
      "customer": {
        "allowAddNew": false,
        "fieldKey": "Customer",
        "enabled": false,
        "required": false
      },
      "invoiceNumber": {
        "fieldKey": "InvoiceNum",
        "enabled": false,
        "required": false
      },
      "purchaseOrderNumber": {
        "fieldKey": "PONum",
        "enabled": false,
        "required": false
      },
      "billingAddress": {
        "requireOnlyAvsFields": false,
        "fieldKey": "BillingAddress",
        "enabled": false,
        "required": false
      },
      "shippingAddress": {
        "defaultToSameAsBilling": true,
        "fieldKey": "ShippingAddress",
        "enabled": false,
        "required": false
      },
      "contactPhone": {
        "maskField": true,
        "maskExpression": "(000) 000-0000",
        "fieldKey": "Phone",
        "enabled": false,
        "required": false
      },
      "level3Amount": {
        "defaultAmount": null,
        "fieldKey": "Level3Amount",
        "enabled": false,
        "required": false
      },
      "shippingAmount": {
        "defaultAmount": null,
        "fieldKey": "ShippingAmount",
        "enabled": false,
        "required": false
      },
      "convenienceAmount": {
        "autoCalculate": false,
        "calculationPercentage": null,
        "mode": null,
        "percentage": null,
        "govEducationAttested": null,
        "govEducationAttestedBy": null,
        "govEducationAttestedOn": null,
        "visaServiceFeeRegistered": null,
        "visaServiceFeeRegisteredOn": null,
        "visaServiceFeeRegistrationRecordedBy": null,
        "visaServiceFeeRegistrationRecordedOn": null,
        "attestedCostOfAcceptanceRate": null,
        "costOfAcceptanceAttestedBy": null,
        "costOfAcceptanceAttestedOn": null,
        "exemptDebit": null,
        "exemptPrepaid": null,
        "legacyPercentageNeedsReview": null,
        "standardChannel": null,
        "alternativeChannel": null,
        "alternativeChannelAttested": null,
        "alternativeChannelAttestedBy": null,
        "alternativeChannelAttestedOn": null,
        "offlineChannelExceptionGranted": null,
        "offlineChannelExceptionGrantedBy": null,
        "offlineChannelExceptionGrantedOn": null,
        "offlineChannelExceptionReason": null,
        "customName": "Convenience Fee",
        "customDescription": null,
        "readOnly": false,
        "defaultAmount": null,
        "fieldKey": "ConvenienceFee",
        "enabled": false,
        "required": false
      },
      "dutyAmount": {
        "defaultAmount": null,
        "fieldKey": "DutyAmount",
        "enabled": false,
        "required": false
      },
      "tipAmount": {
        "defaultAmount": null,
        "fieldKey": "TipAmount",
        "enabled": false,
        "required": false
      },
      "taxAmount": {
        "autoCalculate": false,
        "defaultRate": null,
        "fieldKey": "TaxAmount",
        "enabled": false,
        "required": false
      },
      "emailAddress": {
        "validateFormat": false,
        "validationRegex": null,
        "placeholder": null,
        "fieldKey": "Email",
        "enabled": false,
        "required": false
      }
    },
    "allowPartialApprovals": true,
    "partialApprovalStrategy": null,
    "allowSplitTender": true,
    "allowTipAdjustmentOnPartialApproval": false,
    "splitTenderMaxTenders": 2,
    "partialApprovalAckTimeoutMinutes": 15
  },
  "processing": {
    "duplicateCheck": {
      "enable": true,
      "includeInvoiceNumber": false,
      "allowOverride": true
    },
    "orderDataDefaults": {
      "enable": false,
      "applyLevel2DefaultsToApi": true,
      "applyLevel3DefaultsToApi": true,
      "applyLevel2DefaultsToVt": true,
      "applyLevel3DefaultsToVt": true,
      "defaultMerchantZip": null,
      "defaultTaxRate": null,
      "defaultShipFromZip": null,
      "defaultDestinationCountryCode": null,
      "defaultDutyAmount": null,
      "defaultFreightAmount": null,
      "defaultDiscountAmount": null,
      "defaultLineItemValues": null,
      "defaultLineItem": null
    },
    "cardVerification": {
      "avNoMatch": true,
      "avPartialMatch": true,
      "avPartialMatchIntl": false,
      "avNoMatchIntl": false,
      "avMatchIntl": false,
      "avError": true,
      "avMatchUK": false,
      "avNotSupportedIntl": false,
      "avIntlNoMatch": false,
      "avMatchIntlBoth": false,
      "avZipMatchIntl": false,
      "avRetry": true,
      "avNotSupported": true,
      "avUnavailable": true,
      "avZipPartialMatch9Digit": true,
      "avZipMatch9Digit": true,
      "avZipMatch5Digit": true,
      "avZipPartialMatch5Digit": true,
      "cvvMatch": true,
      "cvvNoMatch": true,
      "cvvNotProcessed": true,
      "cvvNotProvided": true,
      "cvvIssuerNotCertified": true,
      "cvvUnableToProcess": true
    },
    "requireLevel2Data": false,
    "requireNameOnCard": false,
    "requireZipCode": false,
    "requireShipping": false,
    "enableForceCapture": false,
    "requestProcessorToken": null,
    "enableCreateIdempotency": null,
    "processorProfiles": [ ],
    "screeningProviderProfiles": null,
    "autoSettlement": {
      "enable": false,
      "settlementTime": null,
      "sendMerchantEmail": false,
      "userNotificationType": "Primary",
      "additionalEmailNotifications": [ ],
      "currentBatchIds": { },
      "currentBatchId": null
    },
    "registers": [ ]
  },
  "features": {
    "enableGsaBinCheck": false,
    "enableAuthEdit": false,
    "configurationLimits": {
      "allowCustomFieldConfig": true,
      "allowHostedPaymentPageConfig": false,
      "allowOrderDataDefaultsConfig": false,
      "allowEmulatorConfig": false,
      "allowFraudControlConfig": false,
      "allowFraudLog": false,
      "allowQuickPayConfig": false,
      "allowPaymentTokenizationConfig": false
    },
    "merchantBilling": {
      "pricePlanId": null,
      "pricePlanVersion": null,
      "priceOverrides": null
    },
    "tenders": null,
    "enablePaymentTokenization": null,
    "hppTokenizeOnPaymentDefault": null
  },
  "customFields": [ ],
  "branding": null,
  "accountUpdater": null,
  "merchantFlowConfig": null,
  "billingAssignment": null,
  "notes": [ ],
  "digitalWallets": [ ]
}
```

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoeniXGateMerchantsMerchantDto`

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

Schema: `PhoeniXGateMerchantsMerchantDto`

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

Schema: `PhoeniXGateMerchantsMerchantDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 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. See the error-code reference in this document's description for the values `error.code` can take.

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

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

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