POST api/Eca/SettlePurchase
Request Information
URI Parameters
None.
Body Parameters
SettlePurchaseRequestName | Description | Type | Additional information |
---|---|---|---|
RequestAgentType | string |
None. |
|
RequestAgent | string |
None. |
|
Username | string |
None. |
|
Password | string |
None. |
|
SettlementTransactions | Collection of SettlementTransaction |
None. |
Request Formats
application/json, text/json
Sample:
{ "RequestAgentType": "sample string 1", "RequestAgent": "sample string 2", "Username": "sample string 3", "Password": "sample string 4", "SettlementTransactions": [ { "AccountNumber": "sample string 1", "ApplicationID": 2, "CardNumber": 3, "MerchantReferenceNumber": "sample string 4", "SettlementGUID": "sample string 5", "AuthorizationCode": "sample string 6", "TransactionAmount": 7.0, "PromoCode": "sample string 8", "MerchantNumber": 9, "TransactionType": "sample string 10", "ExtendedData": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "AccountNumber": "sample string 1", "ApplicationID": 2, "CardNumber": 3, "MerchantReferenceNumber": "sample string 4", "SettlementGUID": "sample string 5", "AuthorizationCode": "sample string 6", "TransactionAmount": 7.0, "PromoCode": "sample string 8", "MerchantNumber": 9, "TransactionType": "sample string 10", "ExtendedData": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ] }
application/xml, text/xml
Sample:
<SettlePurchaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.SettlePurchase"> <Password>sample string 4</Password> <RequestAgent>sample string 2</RequestAgent> <RequestAgentType>sample string 1</RequestAgentType> <SettlementTransactions> <SettlementTransaction> <AccountNumber>sample string 1</AccountNumber> <ApplicationID>2</ApplicationID> <AuthorizationCode>sample string 6</AuthorizationCode> <CardNumber>3</CardNumber> <ExtendedData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:KeyValueOfstringstring> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 3</d4p1:Key> <d4p1:Value>sample string 4</d4p1:Value> </d4p1:KeyValueOfstringstring> </ExtendedData> <MerchantNumber>9</MerchantNumber> <MerchantReferenceNumber>sample string 4</MerchantReferenceNumber> <PromoCode>sample string 8</PromoCode> <SettlementGUID>sample string 5</SettlementGUID> <TransactionAmount>7</TransactionAmount> <TransactionType>sample string 10</TransactionType> </SettlementTransaction> <SettlementTransaction> <AccountNumber>sample string 1</AccountNumber> <ApplicationID>2</ApplicationID> <AuthorizationCode>sample string 6</AuthorizationCode> <CardNumber>3</CardNumber> <ExtendedData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:KeyValueOfstringstring> <d4p1:KeyValueOfstringstring> <d4p1:Key>sample string 3</d4p1:Key> <d4p1:Value>sample string 4</d4p1:Value> </d4p1:KeyValueOfstringstring> </ExtendedData> <MerchantNumber>9</MerchantNumber> <MerchantReferenceNumber>sample string 4</MerchantReferenceNumber> <PromoCode>sample string 8</PromoCode> <SettlementGUID>sample string 5</SettlementGUID> <TransactionAmount>7</TransactionAmount> <TransactionType>sample string 10</TransactionType> </SettlementTransaction> </SettlementTransactions> <Username>sample string 3</Username> </SettlePurchaseRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SettlePurchaseResponseName | Description | Type | Additional information |
---|---|---|---|
SettlementDecisions | Collection of SettlementDecision |
None. |
Response Formats
application/json, text/json
Sample:
{ "SettlementDecisions": [ { "Status": "sample string 1", "TransactionID": "sample string 2", "SettlementGUID": "sample string 3", "Messages": [ "sample string 1", "sample string 2" ], "AvailableCredit": 4.0 }, { "Status": "sample string 1", "TransactionID": "sample string 2", "SettlementGUID": "sample string 3", "Messages": [ "sample string 1", "sample string 2" ], "AvailableCredit": 4.0 } ] }
application/xml, text/xml
Sample:
<SettlePurchaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Progressive.Web.Api.Library.Models.SettlePurchase"> <SettlementDecisions> <SettlementDecision> <AvailableCredit>4</AvailableCredit> <Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Messages> <SettlementGUID>sample string 3</SettlementGUID> <Status>sample string 1</Status> <TransactionID>sample string 2</TransactionID> </SettlementDecision> <SettlementDecision> <AvailableCredit>4</AvailableCredit> <Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Messages> <SettlementGUID>sample string 3</SettlementGUID> <Status>sample string 1</Status> <TransactionID>sample string 2</TransactionID> </SettlementDecision> </SettlementDecisions> </SettlePurchaseResponse>