POST MobilePay/PaymentRequest

Create new MobilePay payment request

Request Information

URI Parameters

None.

Body Parameters

RequestMobilePayPaymentRequest
NameDescriptionTypeAdditional information
UserID

integer

None.

AgreementID

string

None.

Amount

decimal number

None.

DueDate

Format yyyymmdd - ie. 20191231

string

None.

NextPaymentDate

Format yyyymmdd - ie. 20191231

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserID": 1,
  "AgreementID": "sample string 2",
  "Amount": 3.0,
  "DueDate": "sample string 4",
  "NextPaymentDate": "sample string 5"
}

text/html

Sample:
{"UserID":1,"AgreementID":"sample string 2","Amount":3.0,"DueDate":"sample string 4","NextPaymentDate":"sample string 5"}

application/xml, text/xml

Sample:
<RequestMobilePayPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <AgreementID>sample string 2</AgreementID>
  <Amount>3</Amount>
  <DueDate>sample string 4</DueDate>
  <NextPaymentDate>sample string 5</NextPaymentDate>
  <UserID>1</UserID>
</RequestMobilePayPaymentRequest>

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 'RequestMobilePayPaymentRequest'.

Response Information

Resource Description

Success
NameDescriptionTypeAdditional information
success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true
}

text/html

Sample:
{"success":true}

application/xml, text/xml

Sample:
<Success xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <success>true</success>
</Success>