POST api/v1/transactions
For clients that cannot send a body with a GET.
Request Information
URI Parameters
None.
Body Parameters
TransactionHistoryBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Authentication | AuthenticationModel |
Required |
|
| Request | TransactionHistoryRequestModel |
Required |
Request Formats
application/json, text/json
Sample:
{
"Authentication": {
"Id": "170200123",
"Key": "467512342123"
},
"Request": {
"Email": "larry@newmedia.com",
"PageSize": "20 - number of transactions per page",
"PageNumber": "1 - starts at page 1",
"TimeZone": null
}
}
application/xml, text/xml
Sample:
<TransactionHistoryBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
<Authentication>
<Id>170200123</Id>
<Key>467512342123</Key>
</Authentication>
<Request>
<Email>larry@newmedia.com</Email>
<PageNumber>1 - starts at page 1</PageNumber>
<PageSize>20 - number of transactions per page</PageSize>
<TimeZone i:nil="true" />
</Request>
</TransactionHistoryBindingModel>
Response Information
Resource Description
TransactionsOutgoingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | MessageModel |
None. |
|
| Response | TransactionsResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"Message": {
"Code": "(2 digit code reflecting result of request - 00 is good)",
"Description": "(Message response in text depending upon request/result of request)"
},
"Response": {
"Email": "larry@newmedia.com",
"PageSize": "20 - default is 20, can be overriden",
"MorePages": "true/false - depends upon how many transactions have been performed",
"PageNumber": "1",
"Transactions": [
{
"Amount": 20.5,
"AuthCode": "For credit cards - six alphanumeric value; null/blank for Bank Transfer/Decline/Error/Referred",
"CardType": "Visa/MasterCard/American Express/Discover/Diners Club/JCB/Bank Account",
"Description": "free form, could be anything",
"TransactionDate": "2025-11-15T12:22:42.344949+00:00",
"TransactionReference": "The reference front end supplied",
"TransactionType": "Authorization/Charge/Refund/Settlement/Validation/Void",
"Products": [
{
"Name": "Weekend Warrior Bundle",
"Quantity": "1"
}
],
"TransactionStatus": "Approved/Declined/Referred/Error",
"Email": null
}
]
}
}
application/xml, text/xml
Sample:
<TransactionsOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
<Message>
<Code>(2 digit code reflecting result of request - 00 is good)</Code>
<Description>(Message response in text depending upon request/result of request)</Description>
</Message>
<Response>
<Email>larry@newmedia.com</Email>
<MorePages>true/false - depends upon how many transactions have been performed</MorePages>
<PageNumber>1</PageNumber>
<PageSize>20 - default is 20, can be overriden</PageSize>
<Transactions>
<CustomerTransactions>
<Amount>20.50</Amount>
<AuthCode>For credit cards - six alphanumeric value; null/blank for Bank Transfer/Decline/Error/Referred</AuthCode>
<CardType>Visa/MasterCard/American Express/Discover/Diners Club/JCB/Bank Account</CardType>
<Description>free form, could be anything</Description>
<Email i:nil="true" />
<Products>
<Product>
<Name>Weekend Warrior Bundle</Name>
<Quantity>1</Quantity>
</Product>
</Products>
<TransactionDate>2025-11-15T12:22:42.344949+00:00</TransactionDate>
<TransactionReference>The reference front end supplied</TransactionReference>
<TransactionStatus>Approved/Declined/Referred/Error</TransactionStatus>
<TransactionType>Authorization/Charge/Refund/Settlement/Validation/Void</TransactionType>
</CustomerTransactions>
</Transactions>
</Response>
</TransactionsOutgoingModel>