POST api/ActionService/GetInvoicePaymentFailed

Documentation for 'GetInvoicePaymentFailed'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "StatusId": 2
}

application/xml, text/xml

Sample:

<PaymentIntentStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Payment">
  <StatusId>2</StatusId>
  <UserId>1</UserId>
</PaymentIntentStatusRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedMediaTypeFormatterTracer' to write type 'PaymentIntentStatusRequest'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "Message": [
    {
      "Id": 1,
      "InvoiceId": "sample string 2",
      "PaymentIntentId": "sample string 3",
      "PaymentMethodId": "sample string 4",
      "AmountDue": 5,
      "StripeCustomerId": "sample string 6",
      "CustomerEmail": "sample string 7",
      "SubscriptionId": "sample string 8",
      "UserId": 9,
      "FailedTimeStamp": "2026-01-11T19:31:57.4839973+00:00",
      "AttemptCount": 11,
      "StatusId": 12,
      "ArtistName": "sample string 13",
      "PackageID": 14,
      "PackageExpiryDate": "2026-01-11T19:31:57.4839973+00:00",
      "PhoneNumber": "sample string 16",
      "ProfileUrl": "sample string 17"
    },
    {
      "Id": 1,
      "InvoiceId": "sample string 2",
      "PaymentIntentId": "sample string 3",
      "PaymentMethodId": "sample string 4",
      "AmountDue": 5,
      "StripeCustomerId": "sample string 6",
      "CustomerEmail": "sample string 7",
      "SubscriptionId": "sample string 8",
      "UserId": 9,
      "FailedTimeStamp": "2026-01-11T19:31:57.4839973+00:00",
      "AttemptCount": 11,
      "StatusId": 12,
      "ArtistName": "sample string 13",
      "PackageID": 14,
      "PackageExpiryDate": "2026-01-11T19:31:57.4839973+00:00",
      "PhoneNumber": "sample string 16",
      "ProfileUrl": "sample string 17"
    },
    {
      "Id": 1,
      "InvoiceId": "sample string 2",
      "PaymentIntentId": "sample string 3",
      "PaymentMethodId": "sample string 4",
      "AmountDue": 5,
      "StripeCustomerId": "sample string 6",
      "CustomerEmail": "sample string 7",
      "SubscriptionId": "sample string 8",
      "UserId": 9,
      "FailedTimeStamp": "2026-01-11T19:31:57.4839973+00:00",
      "AttemptCount": 11,
      "StatusId": 12,
      "ArtistName": "sample string 13",
      "PackageID": 14,
      "PackageExpiryDate": "2026-01-11T19:31:57.4839973+00:00",
      "PhoneNumber": "sample string 16",
      "ProfileUrl": "sample string 17"
    }
  ]
}

application/xml, text/xml

Sample:

<ResponseBaseOfArrayOfPaymentIntentFailedYVxenrm_S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.MessageBase">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Payment">
    <d2p1:PaymentIntentFailed>
      <d2p1:AmountDue>5</d2p1:AmountDue>
      <d2p1:ArtistName>sample string 13</d2p1:ArtistName>
      <d2p1:AttemptCount>11</d2p1:AttemptCount>
      <d2p1:CustomerEmail>sample string 7</d2p1:CustomerEmail>
      <d2p1:FailedTimeStamp>2026-01-11T19:31:57.4839973+00:00</d2p1:FailedTimeStamp>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InvoiceId>sample string 2</d2p1:InvoiceId>
      <d2p1:PackageExpiryDate>2026-01-11T19:31:57.4839973+00:00</d2p1:PackageExpiryDate>
      <d2p1:PackageID>14</d2p1:PackageID>
      <d2p1:PaymentIntentId>sample string 3</d2p1:PaymentIntentId>
      <d2p1:PaymentMethodId>sample string 4</d2p1:PaymentMethodId>
      <d2p1:PhoneNumber>sample string 16</d2p1:PhoneNumber>
      <d2p1:ProfileUrl>sample string 17</d2p1:ProfileUrl>
      <d2p1:StatusId>12</d2p1:StatusId>
      <d2p1:StripeCustomerId>sample string 6</d2p1:StripeCustomerId>
      <d2p1:SubscriptionId>sample string 8</d2p1:SubscriptionId>
      <d2p1:UserId>9</d2p1:UserId>
    </d2p1:PaymentIntentFailed>
    <d2p1:PaymentIntentFailed>
      <d2p1:AmountDue>5</d2p1:AmountDue>
      <d2p1:ArtistName>sample string 13</d2p1:ArtistName>
      <d2p1:AttemptCount>11</d2p1:AttemptCount>
      <d2p1:CustomerEmail>sample string 7</d2p1:CustomerEmail>
      <d2p1:FailedTimeStamp>2026-01-11T19:31:57.4839973+00:00</d2p1:FailedTimeStamp>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InvoiceId>sample string 2</d2p1:InvoiceId>
      <d2p1:PackageExpiryDate>2026-01-11T19:31:57.4839973+00:00</d2p1:PackageExpiryDate>
      <d2p1:PackageID>14</d2p1:PackageID>
      <d2p1:PaymentIntentId>sample string 3</d2p1:PaymentIntentId>
      <d2p1:PaymentMethodId>sample string 4</d2p1:PaymentMethodId>
      <d2p1:PhoneNumber>sample string 16</d2p1:PhoneNumber>
      <d2p1:ProfileUrl>sample string 17</d2p1:ProfileUrl>
      <d2p1:StatusId>12</d2p1:StatusId>
      <d2p1:StripeCustomerId>sample string 6</d2p1:StripeCustomerId>
      <d2p1:SubscriptionId>sample string 8</d2p1:SubscriptionId>
      <d2p1:UserId>9</d2p1:UserId>
    </d2p1:PaymentIntentFailed>
    <d2p1:PaymentIntentFailed>
      <d2p1:AmountDue>5</d2p1:AmountDue>
      <d2p1:ArtistName>sample string 13</d2p1:ArtistName>
      <d2p1:AttemptCount>11</d2p1:AttemptCount>
      <d2p1:CustomerEmail>sample string 7</d2p1:CustomerEmail>
      <d2p1:FailedTimeStamp>2026-01-11T19:31:57.4839973+00:00</d2p1:FailedTimeStamp>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InvoiceId>sample string 2</d2p1:InvoiceId>
      <d2p1:PackageExpiryDate>2026-01-11T19:31:57.4839973+00:00</d2p1:PackageExpiryDate>
      <d2p1:PackageID>14</d2p1:PackageID>
      <d2p1:PaymentIntentId>sample string 3</d2p1:PaymentIntentId>
      <d2p1:PaymentMethodId>sample string 4</d2p1:PaymentMethodId>
      <d2p1:PhoneNumber>sample string 16</d2p1:PhoneNumber>
      <d2p1:ProfileUrl>sample string 17</d2p1:ProfileUrl>
      <d2p1:StatusId>12</d2p1:StatusId>
      <d2p1:StripeCustomerId>sample string 6</d2p1:StripeCustomerId>
      <d2p1:SubscriptionId>sample string 8</d2p1:SubscriptionId>
      <d2p1:UserId>9</d2p1:UserId>
    </d2p1:PaymentIntentFailed>
  </Message>
  <status>sample string 1</status>
</ResponseBaseOfArrayOfPaymentIntentFailedYVxenrm_S>