POST
api/MPOSPayment/CapturePayment?custGuid={custGuid}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| custGuid | globally unique identifier |
Required |
Body Parameters
paymentcaptureRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| amount | decimal number |
None. |
|
| currency | decimal number |
None. |
Request Formats
application/json, text/json
{
"amount": 1.1,
"currency": 2.1
}
text/html
{"amount":1.1,"currency":2.1}
application/xml, text/xml
<paymentcaptureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Payment"> <amount>1.1</amount> <currency>2.1</currency> </paymentcaptureRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Description:
Return type: CapturePayment
Response Formats
application/json, text/json
{
"id": "sample string 1",
"entity": "sample string 2",
"amount": 3,
"currency": "sample string 4",
"status": "sample string 5",
"order_id": "sample string 6",
"invoice_id": {},
"international": true,
"method": "sample string 9",
"amount_refunded": 10,
"refund_status": {},
"captured": true,
"description": "sample string 13",
"card_id": "sample string 14",
"bank": {},
"wallet": {},
"vpa": {},
"email": "sample string 18",
"contact": "sample string 19",
"customer_id": "sample string 20",
"token_id": "sample string 21",
"notes": [
{},
{}
],
"fee": 22,
"tax": 23,
"error_code": {},
"error_description": {},
"error_source": {},
"error_step": {},
"error_reason": {},
"acquirer_data": {
"authentication_reference_number": "sample string 1"
},
"created_at": 29
}
text/html
{"id":"sample string 1","entity":"sample string 2","amount":3,"currency":"sample string 4","status":"sample string 5","order_id":"sample string 6","invoice_id":{},"international":true,"method":"sample string 9","amount_refunded":10,"refund_status":{},"captured":true,"description":"sample string 13","card_id":"sample string 14","bank":{},"wallet":{},"vpa":{},"email":"sample string 18","contact":"sample string 19","customer_id":"sample string 20","token_id":"sample string 21","notes":[{},{}],"fee":22,"tax":23,"error_code":{},"error_description":{},"error_source":{},"error_step":{},"error_reason":{},"acquirer_data":{"authentication_reference_number":"sample string 1"},"created_at":29}
application/xml, text/xml
<CapturePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Payment">
<acquirer_data>
<authentication_reference_number>sample string 1</authentication_reference_number>
</acquirer_data>
<amount>3</amount>
<amount_refunded>10</amount_refunded>
<bank />
<captured>true</captured>
<card_id>sample string 14</card_id>
<contact>sample string 19</contact>
<created_at>29</created_at>
<currency>sample string 4</currency>
<customer_id>sample string 20</customer_id>
<description>sample string 13</description>
<email>sample string 18</email>
<entity>sample string 2</entity>
<error_code />
<error_description />
<error_reason />
<error_source />
<error_step />
<fee>22</fee>
<id>sample string 1</id>
<international>true</international>
<invoice_id />
<method>sample string 9</method>
<notes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:anyType />
<d2p1:anyType />
</notes>
<order_id>sample string 6</order_id>
<refund_status />
<status>sample string 5</status>
<tax>23</tax>
<token_id>sample string 21</token_id>
<vpa />
<wallet />
</CapturePayment>
