Registrar Web Services

<back to all web services

R_Transaction

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST,OPTIONS/R_Transactions
PUT,OPTIONS/R_Transactions/{Id}
DELETE,OPTIONS/R_Transactions/{Id}
R_Transaction Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdbodylongNo
GatewayTransactionIdbodystringNo
TransactionTypeIdbodylongNo
TransactionStatusIdbodylongNo
AmountbodydecimalNo
CardbodystringNo
CurrencyIdbodylongNo
CreateDatebodyDateTimeNo
InvoiceIdbodylong?No
GatewayResponsebodystringNo
TransactionNotificationStatusIdbodylongNo
SettlementDatebodyDateTime?No
RelatedTransactionIdbodylong?No
RelatedGatewayTransactionIdbodystringNo
IdpathlongNo
R_Transaction Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdbodylongNo
GatewayTransactionIdbodystringNo
TransactionTypeIdbodylongNo
TransactionStatusIdbodylongNo
AmountbodydecimalNo
CardbodystringNo
CurrencyIdbodylongNo
CreateDatebodyDateTimeNo
InvoiceIdbodylong?No
GatewayResponsebodystringNo
TransactionNotificationStatusIdbodylongNo
SettlementDatebodyDateTime?No
RelatedTransactionIdbodylong?No
RelatedGatewayTransactionIdbodystringNo
IdpathlongNo

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_Transaction HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: application/xml
Content-Length: length

<R_Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Registrar.Model.Model.Data">
  <Amount>0</Amount>
  <Card>String</Card>
  <CreateDate>0001-01-01T00:00:00</CreateDate>
  <CurrencyId>0</CurrencyId>
  <GatewayResponse>String</GatewayResponse>
  <GatewayTransactionId>String</GatewayTransactionId>
  <Id>0</Id>
  <InvoiceId>0</InvoiceId>
  <RelatedGatewayTransactionId>String</RelatedGatewayTransactionId>
  <RelatedTransactionId>0</RelatedTransactionId>
  <SettlementDate>0001-01-01T00:00:00</SettlementDate>
  <SubscriptionId>0</SubscriptionId>
  <TransactionNotificationStatusId>0</TransactionNotificationStatusId>
  <TransactionStatusId>0</TransactionStatusId>
  <TransactionTypeId>0</TransactionTypeId>
</R_Transaction>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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