POST api/OmniPay/CreatePriceChangePayout

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PartnerPayoutId	integer	None.
PayoutAmount	decimal number	None.
BusinessId	integer	None.
IsPaid	integer	None.
DateCreated	date	None.
DateUpdated	date	None.
Balance	decimal number	None.
DatePaymentCompleted	date	None.
PaymentType	PriceChangePaymentType	None.
PriceChangePayments	Collection of PriceChangePayments	None.

Request Formats

application/json, text/json

Sample:

{
  "PartnerPayoutId": 1,
  "PayoutAmount": 2.0,
  "BusinessId": 3,
  "IsPaid": 4,
  "DateCreated": "2025-05-03T03:22:07.4677757+00:00",
  "DateUpdated": "2025-05-03T03:22:07.4677757+00:00",
  "Balance": 7.0,
  "DatePaymentCompleted": "2025-05-03T03:22:07.4677757+00:00",
  "PaymentType": 1,
  "PriceChangePayments": null
}

application/xml, text/xml

Sample:

<PriceChangePayout xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <Balance>7</Balance>
  <BusinessId>3</BusinessId>
  <DateCreated>2025-05-03T03:22:07.4677757+00:00</DateCreated>
  <DatePaymentCompleted>2025-05-03T03:22:07.4677757+00:00</DatePaymentCompleted>
  <DateUpdated>2025-05-03T03:22:07.4677757+00:00</DateUpdated>
  <IsPaid>4</IsPaid>
  <PartnerPayoutId>1</PartnerPayoutId>
  <PaymentType>Debit</PaymentType>
  <PayoutAmount>2</PayoutAmount>
  <PriceChangePayments i:nil="true" />
</PriceChangePayout>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/05/03 03:22:07",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>