POST api/Workflow/FinaliseMembership

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceId	globally unique identifier	None.
ProductId	globally unique identifier	None.
MemberId	string	None.
SubscriptionId	globally unique identifier	None.
ClassifiedItemId	globally unique identifier	None.
ClassifiedApplicationId	globally unique identifier	None.
PaymentSuccessful	boolean	None.
PaymentGatewayTransactionRef	string	None.
Result	ResponseResult	None.

Request Formats

application/json, text/json

Sample:

{
  "InvoiceId": "734bfacf-c5f6-4ddf-8027-3600cf233241",
  "ProductId": "f2c3aa73-157a-4efa-9aaa-b915c6e4dcc5",
  "MemberId": "sample string 1",
  "SubscriptionId": "5d0202a9-9a06-4c28-91e3-6fdbc41f8067",
  "ClassifiedItemId": "6eb4d9c3-2a1b-4d84-9231-6f77e66054bb",
  "ClassifiedApplicationId": "0d7019a8-3dff-40c1-bcbb-03522f6d38eb",
  "PaymentSuccessful": true,
  "PaymentGatewayTransactionRef": "sample string 2",
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Errors": [
      {
        "Message": "sample string 1"
      },
      {
        "Message": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<FinaliseMembershipResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response">
  <Result>
    <Errors>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
    </Errors>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </Result>
  <ClassifiedApplicationId>0d7019a8-3dff-40c1-bcbb-03522f6d38eb</ClassifiedApplicationId>
  <ClassifiedItemId>6eb4d9c3-2a1b-4d84-9231-6f77e66054bb</ClassifiedItemId>
  <InvoiceId i:nil="true" />
  <MemberId>sample string 1</MemberId>
  <PaymentGatewayTransactionRef>sample string 2</PaymentGatewayTransactionRef>
  <PaymentSuccessful>true</PaymentSuccessful>
  <ProductId i:nil="true" />
  <SubscriptionId>5d0202a9-9a06-4c28-91e3-6fdbc41f8067</SubscriptionId>
  <InvoiceId>734bfacf-c5f6-4ddf-8027-3600cf233241</InvoiceId>
  <ProductId>f2c3aa73-157a-4efa-9aaa-b915c6e4dcc5</ProductId>
</FinaliseMembershipResponseModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FinaliseMembershipResponseModel

Name	Type	Additional information
InvoiceId	globally unique identifier	None.
ProductId	globally unique identifier	None.
MemberId	string	None.
SubscriptionId	globally unique identifier	None.
ClassifiedItemId	globally unique identifier	None.
ClassifiedApplicationId	globally unique identifier	None.
PaymentSuccessful	boolean	None.
PaymentGatewayTransactionRef	string	None.
Result	ResponseResult	None.

Response Formats

application/json, text/json

Sample:

{
  "InvoiceId": "3b911b08-0685-45a6-9f01-916ee515c2e7",
  "ProductId": "2d8ca78c-c304-448d-8907-d7f31182ec8e",
  "MemberId": "sample string 1",
  "SubscriptionId": "bc7123e8-cb4f-44fb-8168-479a00165a9c",
  "ClassifiedItemId": "431a772c-a083-4cee-b569-9d39fa8327d0",
  "ClassifiedApplicationId": "57787732-7a72-4634-86a6-9a8dc0a89e0e",
  "PaymentSuccessful": true,
  "PaymentGatewayTransactionRef": "sample string 2",
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Errors": [
      {
        "Message": "sample string 1"
      },
      {
        "Message": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<FinaliseMembershipResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response">
  <Result>
    <Errors>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
    </Errors>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </Result>
  <ClassifiedApplicationId>57787732-7a72-4634-86a6-9a8dc0a89e0e</ClassifiedApplicationId>
  <ClassifiedItemId>431a772c-a083-4cee-b569-9d39fa8327d0</ClassifiedItemId>
  <InvoiceId i:nil="true" />
  <MemberId>sample string 1</MemberId>
  <PaymentGatewayTransactionRef>sample string 2</PaymentGatewayTransactionRef>
  <PaymentSuccessful>true</PaymentSuccessful>
  <ProductId i:nil="true" />
  <SubscriptionId>bc7123e8-cb4f-44fb-8168-479a00165a9c</SubscriptionId>
  <InvoiceId>3b911b08-0685-45a6-9f01-916ee515c2e7</InvoiceId>
  <ProductId>2d8ca78c-c304-448d-8907-d7f31182ec8e</ProductId>
</FinaliseMembershipResponseModel>