Registrar Web Services

<back to all web services

R_RefundTransactionRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS, POST, GET/R_RefundTransaction
R_RefundTransactionRequest Parameters:
NameParameterData TypeRequiredDescription
TransactionIdbodylongNo
AmountToRefundbodydecimalNo
BaseAdminRequest Parameters:
NameParameterData TypeRequiredDescription
RequesterformstringNoIdentity of the caller
R_RefundTransactionResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionformR_TransactionNo
R_Transaction Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdformlongNo
GatewayTransactionIdformstringNo
TransactionTypeIdformlongNo
TransactionStatusIdformlongNo
AmountformdecimalNo
CardformstringNo
CurrencyIdformlongNo
CreateDateformDateTimeNo
InvoiceIdformlong?No
GatewayResponseformstringNo
TransactionNotificationStatusIdformlongNo
SettlementDateformDateTime?No
RelatedTransactionIdformlong?No
RelatedGatewayTransactionIdformstringNo
IdformlongNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/R_RefundTransactionRequest HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_RefundTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Billing">
  <Requester xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Interfaces">String</Requester>
  <AmountToRefund>0</AmountToRefund>
  <TransactionId>0</TransactionId>
</R_RefundTransactionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<R_RefundTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Transactions.Billing">
  <Transaction xmlns:d2p1="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:Card>String</d2p1:Card>
    <d2p1:CreateDate>0001-01-01T00:00:00</d2p1:CreateDate>
    <d2p1:CurrencyId>0</d2p1:CurrencyId>
    <d2p1:GatewayResponse>String</d2p1:GatewayResponse>
    <d2p1:GatewayTransactionId>String</d2p1:GatewayTransactionId>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:InvoiceId>0</d2p1:InvoiceId>
    <d2p1:RelatedGatewayTransactionId>String</d2p1:RelatedGatewayTransactionId>
    <d2p1:RelatedTransactionId>0</d2p1:RelatedTransactionId>
    <d2p1:SettlementDate>0001-01-01T00:00:00</d2p1:SettlementDate>
    <d2p1:SubscriptionId>0</d2p1:SubscriptionId>
    <d2p1:TransactionNotificationStatusId>0</d2p1:TransactionNotificationStatusId>
    <d2p1:TransactionStatusId>0</d2p1:TransactionStatusId>
    <d2p1:TransactionTypeId>0</d2p1:TransactionTypeId>
  </Transaction>
</R_RefundTransactionResponse>