POST api/RecurringPayDetails

Request Information

URI Parameters

None.

Body Parameters

RecurringPayDetail
NameDescriptionTypeAdditional information
DetailID

integer

None.

AuthorizationID

string

Required

String length: inclusive between 0 and 20

RecurringID

integer

None.

ExpID

integer

None.

ExpCode

string

String length: inclusive between 0 and 30

ExpAmt

decimal number

None.

NextPayDate

date

None.

BeenPaid

string

String length: inclusive between 0 and 1

VendorID

integer

None.

PaidTo

string

String length: inclusive between 0 and 2

BatchType

string

String length: inclusive between 0 and 20

Reference

string

String length: inclusive between 0 and 75

RouteTo

string

String length: inclusive between 0 and 20

RPIndex

string

String length: inclusive between 0 and 2

ReceiptCurrency

string

String length: inclusive between 0 and 10

PayInCurrency

string

String length: inclusive between 0 and 10

PayInMethod

string

String length: inclusive between 0 and 20

DueDate

date

None.

PayAddress

string

String length: inclusive between 0 and 200

EquivalentCurrency

string

String length: inclusive between 0 and 10

ID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "DetailID": 1,
  "AuthorizationID": "sample string 2",
  "RecurringID": 1,
  "ExpID": 1,
  "ExpCode": "sample string 3",
  "ExpAmt": 1.0,
  "NextPayDate": "2025-05-09T17:35:31.8050355+00:00",
  "BeenPaid": "sample string 4",
  "VendorID": 1,
  "PaidTo": "sample string 5",
  "BatchType": "sample string 6",
  "Reference": "sample string 7",
  "RouteTo": "sample string 8",
  "RPIndex": "sample string 9",
  "ReceiptCurrency": "sample string 10",
  "PayInCurrency": "sample string 11",
  "PayInMethod": "sample string 12",
  "DueDate": "2025-05-09T17:35:31.8050355+00:00",
  "PayAddress": "sample string 13",
  "EquivalentCurrency": "sample string 14",
  "ID": 15
}

application/xml, text/xml

Sample:
<RecurringPayDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric">
  <AuthorizationID>sample string 2</AuthorizationID>
  <BatchType>sample string 6</BatchType>
  <BeenPaid>sample string 4</BeenPaid>
  <DetailID>1</DetailID>
  <DueDate>2025-05-09T17:35:31.8050355+00:00</DueDate>
  <EquivalentCurrency>sample string 14</EquivalentCurrency>
  <ExpAmt>1</ExpAmt>
  <ExpCode>sample string 3</ExpCode>
  <ExpID>1</ExpID>
  <ID>15</ID>
  <NextPayDate>2025-05-09T17:35:31.8050355+00:00</NextPayDate>
  <PaidTo>sample string 5</PaidTo>
  <PayAddress>sample string 13</PayAddress>
  <PayInCurrency>sample string 11</PayInCurrency>
  <PayInMethod>sample string 12</PayInMethod>
  <RPIndex>sample string 9</RPIndex>
  <ReceiptCurrency>sample string 10</ReceiptCurrency>
  <RecurringID>1</RecurringID>
  <Reference>sample string 7</Reference>
  <RouteTo>sample string 8</RouteTo>
  <VendorID>1</VendorID>
</RecurringPayDetail>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RecurringPayDetail
NameDescriptionTypeAdditional information
DetailID

integer

None.

AuthorizationID

string

Required

String length: inclusive between 0 and 20

RecurringID

integer

None.

ExpID

integer

None.

ExpCode

string

String length: inclusive between 0 and 30

ExpAmt

decimal number

None.

NextPayDate

date

None.

BeenPaid

string

String length: inclusive between 0 and 1

VendorID

integer

None.

PaidTo

string

String length: inclusive between 0 and 2

BatchType

string

String length: inclusive between 0 and 20

Reference

string

String length: inclusive between 0 and 75

RouteTo

string

String length: inclusive between 0 and 20

RPIndex

string

String length: inclusive between 0 and 2

ReceiptCurrency

string

String length: inclusive between 0 and 10

PayInCurrency

string

String length: inclusive between 0 and 10

PayInMethod

string

String length: inclusive between 0 and 20

DueDate

date

None.

PayAddress

string

String length: inclusive between 0 and 200

EquivalentCurrency

string

String length: inclusive between 0 and 10

ID

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "DetailID": 1,
  "AuthorizationID": "sample string 2",
  "RecurringID": 1,
  "ExpID": 1,
  "ExpCode": "sample string 3",
  "ExpAmt": 1.0,
  "NextPayDate": "2025-05-09T17:35:31.821221+00:00",
  "BeenPaid": "sample string 4",
  "VendorID": 1,
  "PaidTo": "sample string 5",
  "BatchType": "sample string 6",
  "Reference": "sample string 7",
  "RouteTo": "sample string 8",
  "RPIndex": "sample string 9",
  "ReceiptCurrency": "sample string 10",
  "PayInCurrency": "sample string 11",
  "PayInMethod": "sample string 12",
  "DueDate": "2025-05-09T17:35:31.821221+00:00",
  "PayAddress": "sample string 13",
  "EquivalentCurrency": "sample string 14",
  "ID": 15
}

application/xml, text/xml

Sample:
<RecurringPayDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric">
  <AuthorizationID>sample string 2</AuthorizationID>
  <BatchType>sample string 6</BatchType>
  <BeenPaid>sample string 4</BeenPaid>
  <DetailID>1</DetailID>
  <DueDate>2025-05-09T17:35:31.821221+00:00</DueDate>
  <EquivalentCurrency>sample string 14</EquivalentCurrency>
  <ExpAmt>1</ExpAmt>
  <ExpCode>sample string 3</ExpCode>
  <ExpID>1</ExpID>
  <ID>15</ID>
  <NextPayDate>2025-05-09T17:35:31.821221+00:00</NextPayDate>
  <PaidTo>sample string 5</PaidTo>
  <PayAddress>sample string 13</PayAddress>
  <PayInCurrency>sample string 11</PayInCurrency>
  <PayInMethod>sample string 12</PayInMethod>
  <RPIndex>sample string 9</RPIndex>
  <ReceiptCurrency>sample string 10</ReceiptCurrency>
  <RecurringID>1</RecurringID>
  <Reference>sample string 7</Reference>
  <RouteTo>sample string 8</RouteTo>
  <VendorID>1</VendorID>
</RecurringPayDetail>