POST api/attorneys/{userId}/referrers/{referrerId}/payments

Use this method to record a refund or referral payment to a referral attorney.

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	Id of the attorney (main)	integer	Required
referrerId	Id of the referral attorney	integer	Required

Body Parameters

Payment data

PaymentDataBindingModel

Name	Type	Additional information
Amount	decimal number	Required
Notes	string	Required
PaymentMethodId	integer	Required
CheckNumber	string	None.
PaymentTypeId	integer	Required
PaymentProviderToken	string	None.
PayeeName	string	Required
PaymentGatewayId	integer	None.
PaymentStatus	string	None.
PaymentDate	string	None.

Request Formats

application/json, text/json

Sample:

{
  "amount": 1.0,
  "notes": "sample string 2",
  "paymentMethodId": 3,
  "checkNumber": "sample string 4",
  "paymentTypeId": 5,
  "paymentProviderToken": "sample string 6",
  "payeeName": "sample string 7",
  "paymentGatewayId": 1,
  "paymentStatus": "sample string 8",
  "paymentDate": "sample string 9"
}

text/html

Sample:

{"amount":1.0,"notes":"sample string 2","paymentMethodId":3,"checkNumber":"sample string 4","paymentTypeId":5,"paymentProviderToken":"sample string 6","payeeName":"sample string 7","paymentGatewayId":1,"paymentStatus":"sample string 8","paymentDate":"sample string 9"}

application/xml, text/xml

Sample:

<PaymentDataBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.ReferrerBinding">
  <Amount>1</Amount>
  <CheckNumber>sample string 4</CheckNumber>
  <Notes>sample string 2</Notes>
  <PayeeName>sample string 7</PayeeName>
  <PaymentDate>sample string 9</PaymentDate>
  <PaymentGatewayId>1</PaymentGatewayId>
  <PaymentMethodId>3</PaymentMethodId>
  <PaymentProviderToken>sample string 6</PaymentProviderToken>
  <PaymentStatus>sample string 8</PaymentStatus>
  <PaymentTypeId>5</PaymentTypeId>
</PaymentDataBindingModel>

application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

Payment response model

PaymentResponseModel

Name	Description	Type	Additional information
IsSuccess		boolean	None.
ErrorMessage		string	None.

Response Formats

application/json, text/json

Sample:

{
  "isSuccess": true,
  "errorMessage": "sample string 2"
}

text/html

Sample:

{"isSuccess":true,"errorMessage":"sample string 2"}

application/xml, text/xml

Sample:

<PaymentResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.ReferrerBinding">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccess>true</IsSuccess>
</PaymentResponseModel>