POST api/commerce/admin/external-reversals
Request Information
URI Parameters
None.
Body Parameters
CommerceExternalReversalRecordDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PaymentID | globally unique identifier |
None. |
|
| ProviderEventKey | string |
None. |
|
| ExternalReference | string |
None. |
|
| OutcomeCode | string |
None. |
|
| ReversalAmount | decimal number |
None. |
|
| FeeAmount | decimal number |
None. |
|
| FeeBearer | string |
None. |
|
| EvidenceSummary | string |
None. |
|
| OperatorMemberID | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"PaymentID": "8a828ad0-2f1e-4246-b92a-828df56741df",
"ProviderEventKey": "sample string 2",
"ExternalReference": "sample string 3",
"OutcomeCode": "sample string 4",
"ReversalAmount": 5.0,
"FeeAmount": 6.0,
"FeeBearer": "sample string 7",
"EvidenceSummary": "sample string 8",
"OperatorMemberID": "fd84b10b-cf30-4f51-946e-f08ca0c54d80"
}
application/xml, text/xml
Sample:
<CommerceExternalReversalRecordDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIProject.API.Models.DTO"> <EvidenceSummary>sample string 8</EvidenceSummary> <ExternalReference>sample string 3</ExternalReference> <FeeAmount>6</FeeAmount> <FeeBearer>sample string 7</FeeBearer> <OperatorMemberID>fd84b10b-cf30-4f51-946e-f08ca0c54d80</OperatorMemberID> <OutcomeCode>sample string 4</OutcomeCode> <PaymentID>8a828ad0-2f1e-4246-b92a-828df56741df</PaymentID> <ProviderEventKey>sample string 2</ProviderEventKey> <ReversalAmount>5</ReversalAmount> </CommerceExternalReversalRecordDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.