POST MobilePay/CapturePayment

Capture MobilePay OneOff payment

Request Information

URI Parameters

None.

Body Parameters

RequestMobilePayCapturePayment
NameDescriptionTypeAdditional information
AgreementID

string

None.

PaymentID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AgreementID": "sample string 1",
  "PaymentID": "sample string 2"
}

text/html

Sample:
{"AgreementID":"sample string 1","PaymentID":"sample string 2"}

application/xml, text/xml

Sample:
<RequestMobilePayCapturePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <AgreementID>sample string 1</AgreementID>
  <PaymentID>sample string 2</PaymentID>
</RequestMobilePayCapturePayment>

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

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>