Creates an AutoPayInstruction

post https://yourorgsite.com/api/AutoPayInstruction

Creates an instance of AutoPayInstruction

Body Params

AutoPayInstruction to be Created

$type

string

required

Defaults to Asi.Soa.Commerce.DataContracts.AutoPayInstructionData, Asi.Contracts

The DataType must be "Asi.Soa.Commerce.DataContracts.AutoPayInstructionData, Asi.Contracts"

AutoPayAccount

object

AutoPayAccountId

string

BillingCycleName

string

CancellationReason

string

CancelledOn

date-time

CollectionDay

int32

Customer

object

EditMessage

string

EndDate

date-time

ExternalInstructionId

string

ExternalToken

string

GroupInformation

object

InstructionId

string

InstructionType

string

Defaults to Donation

IntervalTypeCode

string

Defaults to Yearly

IsInstructionEditable

boolean

Defaults to false

PaymentTermsKey

string

ProcessingReference

string

ProductCode

string

SourceCode

string

StartDate

date-time

Status

string

UpdateInformation

object

Responses

200

The request was successful.

201

The resource was successfully created.

202

The resource was asynchronously created.

Language

Credentials

OAuth2


xxxxxxxxxx
71
    UpdateInformation: {$type: 'Asi.Soa.Core.DataContracts.EntityUpdateInformationData, Asi.Contracts'}
1
const options = {
2
  method: 'POST',
3
  headers: {accept: 'application/json', 'content-type': 'application/json'},
4
  body: JSON.stringify({
5
    $type: 'Asi.Soa.Commerce.DataContracts.AutoPayInstructionData, Asi.Contracts',
6
    AutoPayAccount: {
7
      $type: 'Asi.Soa.Commerce.DataContracts.AutoPayAccountData, Asi.Contracts',
8
      AccountData: {
9
        $type: 'Asi.Services.DataVault.Contracts.PaymentTokenData, Asi.Contracts',
10
        IsReadOnly: false
11
      },
12
      AccountType: 'Undefined',
13
      ApplicationRestrictions: {
14
        $type: 'Asi.Soa.Commerce.DataContracts.ApplicationRestrictionDataCollection, Asi.Contracts'
15
      },
16
      IsAvailableToDisable: false,
17
      IsDuplicateToken: false,
18
      Payer: {
19
        $type: 'Asi.Soa.Commerce.DataContracts.AccountPayerInformationData, Asi.Contracts',
20
        PayerAddress: {
21
          $type: 'Asi.Soa.Membership.DataContracts.AddressData, Asi.Contracts',
22
          IsMarkedForDelete: false,
23
          LocationCoordinate: {
24
            $type: 'Asi.Soa.Membership.DataContracts.LocationCoordinateData, Asi.Contracts'
25
          },
26
          VerificationStatus: 'Unknown'
27
        }
28
      },
29
      PaymentMethodIsReadOnly: false

Click Try It! to start a request and see the response here!