---
title: "Validates an AutoPayInstruction"
method: POST
path: "/AutoPayInstruction/_validate"
tags: ["AutoPayInstruction"]
---

# Validates an AutoPayInstruction

`POST /AutoPayInstruction/_validate`

## Request

- Base URL: `https://yourorgsite.com/api`
- URL: `https://yourorgsite.com/api/AutoPayInstruction/_validate`
- Auth: OAuth 2
  - Implicit: `https://yourorgsite.com`

Validates an instance of AutoPayInstruction

## Request body

- AutoPayInstructionData
  - `$type` 'Asi.Soa.Commerce.DataContracts.AutoPayInstructionData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.AutoPayInstructionData, Asi.Contracts"
  - `Amount` object
  - `AutoPayAccount` AutoPayAccountData
    - `$type` 'Asi.Soa.Commerce.DataContracts.AutoPayAccountData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.AutoPayAccountData, Asi.Contracts"
    - `AccountData` PaymentTokenData
      - `$type` 'Asi.Services.DataVault.Contracts.PaymentTokenData, Asi.Contracts', required: The DataType must be "Asi.Services.DataVault.Contracts.PaymentTokenData, Asi.Contracts"
      - `CustomerId` string
      - `Description` string
      - `IsReadOnly` boolean
      - `Metadata` object
      - `OriginalPaymentToken` string
      - `PaymentTokenExpirationDate` string, date-time
    - `AccountType` 'Undefined' | 'CreditCard' | 'BankAccount' | 'BankAccountUk' | 'ExternalCreditCard' | 'ExternalBankAccount'
    - `ApplicationRestrictions` ApplicationRestrictionDataCollection
      - `$type` 'Asi.Soa.Commerce.DataContracts.ApplicationRestrictionDataCollection, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.ApplicationRestrictionDataCollection, Asi.Contracts"
      - `$values` ApplicationRestrictionData[], required: The values for the collection
        - `$type` 'Asi.Soa.Commerce.DataContracts.ApplicationRestrictionData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.ApplicationRestrictionData, Asi.Contracts"
        - `RestrictionType` 'Unspecified' | 'Order' | 'Subscription' | 'Donation' | 'EventRegistration' | 'Refund' | 'AutoPayInstruction' | 'Remittance' | 'ImportBatch' | 'StoredPaymentMethod'
        - `UniformId` string
    - `AutoPayAccountId` string
    - `DisableMessage` string
    - `IsAvailableToDisable` boolean
    - `IsDuplicateToken` boolean
    - `Payer` AccountPayerInformationData
      - `$type` 'Asi.Soa.Commerce.DataContracts.AccountPayerInformationData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.AccountPayerInformationData, Asi.Contracts"
      - `AccountName` string
      - `PayerAddress` AddressData
        - `$type` 'Asi.Soa.Membership.DataContracts.AddressData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.AddressData, Asi.Contracts"
        - `AddressId` string
        - `AddressLines` string[]
        - `AddressTokenId` string
        - `Barcode` string
        - `BarcodeSortPlanNumber` string
        - `CarrierRoute` string
        - `CityName` string
        - `CountryCode` string
        - `CountryName` string
        - `CountrySubEntityCode` string
        - `CountrySubEntityName` string
        - `CountyCode` string
        - `CountyName` string
        - `DeliveryPointCode` string
        - `FullAddress` string
        - `IsMarkedForDelete` boolean
        - `LocalGovernmentDistrict1` string
        - `LocalGovernmentDistrict2` string
        - `LocationCoordinate` LocationCoordinateData
          - `$type` 'Asi.Soa.Membership.DataContracts.LocationCoordinateData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.LocationCoordinateData, Asi.Contracts"
          - `Latitude` object
          - `Longitude` object
        - `NationalGovernmentDistrict` string
        - `PostalCode` string
        - `RegionName` string
        - `VerificationMessage` string
        - `VerificationStatus` 'Unknown' | 'Error' | 'VerifiedAsIs' | 'VerifiedAndCleaned' | 'SystemError'
        - `VerifiedOn` string, date-time
      - `PayerId` string
      - `PayerName` string
    - `PaymentMethodId` string
    - `PaymentMethodIsReadOnly` boolean
    - `PaymentMethodSummary` string
    - `PaymentTokenExpirationDate` string, date-time
    - `PaymentTokenId` string
    - `Status` string
  - `AutoPayAccountId` string
  - `BillingCycleName` string
  - `CancellationReason` string
  - `CancelledOn` string, date-time
  - `CollectionDay` integer
  - `Customer` PartyReferenceData
    - `$type` 'Asi.Soa.Membership.DataContracts.PartyReferenceData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.PartyReferenceData, Asi.Contracts"
    - `Id` string
    - `IsMarkedForDelete` boolean
    - `Name` string
    - `PartyId` string
    - `Sort` string
    - `Status` PartyStatusData
      - `$type` 'Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.PartyStatusData, Asi.Contracts"
      - `ActiveStatus` 'Active' | 'Inactive' | 'Suspended' | 'Delete'
      - `Description` string
      - `Name` string
      - `PartyStatusId` string
    - `UniformId` string
  - `EditMessage` string
  - `EndDate` string, date-time
  - `ExternalInstructionId` string
  - `ExternalToken` string
  - `GroupInformation` GroupInformationData
    - `$type` 'Asi.Soa.Commerce.DataContracts.GroupInformationData, Asi.Contracts', required: The DataType must be "Asi.Soa.Commerce.DataContracts.GroupInformationData, Asi.Contracts"
    - `Group` GroupSummaryData
      - `$type` 'Asi.Soa.Membership.DataContracts.GroupSummaryData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.GroupSummaryData, Asi.Contracts"
      - `Description` string
      - `GroupClass` GroupClassSummaryData
        - `$type` 'Asi.Soa.Membership.DataContracts.GroupClassSummaryData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.GroupClassSummaryData, Asi.Contracts"
        - `Description` string
        - `GroupClassId` string
        - `IsDateLimited` boolean
        - `IsReadOnly` boolean
        - `IsRelationshipGroup` boolean
        - `IsSimpleGroup` boolean
        - `IsSystem` boolean
        - `Name` string
      - `GroupId` string
      - `IsMemberGroup` boolean
      - `IsPrimaryGroup` boolean
      - `IsRelationshipGroup` boolean
      - `IsSimpleGroup` boolean
      - `IsSystem` boolean
      - `Name` string
      - `ParentIdentity` IdentityData
        - `$type` 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts"
        - `EntityTypeName` string
        - `Id` object
        - `IdentityElements` string[]
        - `Key` string
      - `StatusCode` string
    - `GroupMemberId` string
    - `GroupRole` GroupRoleSummaryData
      - `$type` 'Asi.Soa.Membership.DataContracts.GroupRoleSummaryData, Asi.Contracts', required: The DataType must be "Asi.Soa.Membership.DataContracts.GroupRoleSummaryData, Asi.Contracts"
      - `Description` string
      - `IsActive` boolean
      - `Name` string
      - `Priority` integer
      - `RoleId` string
    - `InitialTermIsPaid` boolean
  - `InstructionId` string
  - `InstructionType` 'Donation' | 'Membership' | 'Subscription'
  - `IntervalTypeCode` 'Yearly' | 'Quarterly' | 'Monthly' | 'Weekly' | 'Daily' | 'EventDriven' | 'Once' | 'Custom'
  - `IsInstructionEditable` boolean
  - `PaymentTermsKey` string
  - `ProcessingReference` string
  - `ProductCode` string
  - `SourceCode` string
  - `StartDate` string, date-time
  - `Status` string
  - `UpdateInformation` EntityUpdateInformationData
    - `$type` 'Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts', required: The DataType must be "Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts"
    - `CreatedBy` string
    - `CreatedOn` string, date-time
    - `UpdatedBy` string
    - `UpdatedOn` string, date-time

## Response `200`

The request was successful.

## Other responses

- `201`: The resource was successfully created.
- `202`: The resource was asynchronously created.

---

[API](https://skmtc.dev/imis/apis/payments.md) - [All operations](https://skmtc.dev/imis/apis/payments/llms.txt) - [OpenAPI document](https://skmtc.dev/imis/apis/payments/revisions/e0669f9d110b?raw)