Overview
This API offers fundamental access to view payment details in custom user portals, while ensuring secure handling of sensitive data.
SOAP Example
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
<soapenv:Header/>
<soapenv:Body>
<urn:GetPaymentsRequest>
<urn:AccountID>5522600</urn:AccountID>
<urn:IncludeInternal>true</urn:IncludeInternal>
<urn:Type>CREDITCARD</urn:Type>
<urn:SubType>MASTERCARD</urn:SubType>
<urn:Status>Successful</urn:Status>
<urn:DateReference>LastModified</urn:DateReference>
<urn:DateFrom>2024-01-01T00:00:00+00:00</urn:DateFrom>
<urn:DateTo>2024-05-01T00:00:00+00:00</urn:DateTo>
</urn:GetPaymentsRequest>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
<SOAP-ENV:Body>
<ns1:GetPaymentsResponse>
<ns1:PaymentID>6675684</ns1:PaymentID>
<ns1:PaymentType>CREDITCARD</ns1:PaymentType>
<ns1:PaymentSubType>MASTERCARD</ns1:PaymentSubType>
<ns1:Currency>USD</ns1:Currency>
<ns1:Amount>200</ns1:Amount>
<ns1:Status>Successful</ns1:Status>
<ns1:AccountID>5522600</ns1:AccountID>
<ns1:PaymentDate>2024-04-07T10:51:43+10:00</ns1:PaymentDate>
<ns1:InternalPayment>true</ns1:InternalPayment>
</ns1:GetPaymentsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Field Descriptions
All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information.
| Name | Description | Required? | Field Type | Character limit | Values |
|---|---|---|---|---|---|
AccountID | The unique identifier for the account. | No | Big Integer | 5522600 | |
IncludeInternal | A flag that indicates whether internal payments should be included. | No | Boolean | true, false | |
Type | The type of payment. | No | Enum | CASH, CREDITCARD, DIRECTDEBIT | |
SubType | The subtype of the payment. | No | Enum | MASTERCARD, VISA, AMEX | |
Status | The status of the payment. | No | Enum | Successful, Failed, Processing | |
DateReference | The reference date type used to filter payments. | Yes | Enum | PaymentDate, LastModified | |
DateFrom | The starting date for the payment search range. | Yes | DateTime | 2024-01-01T00:00:00+00:00 | |
DateTo | The ending date for the payment search range. | Yes | DateTime | 2024-05-01T00:00:00+00:00 |
Error Handling
| Error Message | Description |
|---|---|
Invalid account ID. | The account ID provided in the request is invalid and does not exist in the system. |
Payment type supplied is not in the list of acceptable values, please refer to the documentation. | The payment type given in the request is not among the valid payment types listed in the API documentation. Make sure that the payment type matches one of the mentioned values. |
The sub-type specified is not within the list of acceptable types, please refer to the documentation. | The payment subtype specified in the request is not recognised as a valid one. Check the API documentation for a list of allowed subtypes. |
Supplied Status does not exist. | The status value in the request is invalid or unrecognised. Refer to the API documentation for the list of valid values. |
A date reference was supplied, but it is not one of 'PaymentDate' or 'LastModified' - please correct your input and try again. | The date reference should be either 'PaymentDate' or 'LastModified'. The value provided does not match either of these enumerations. |
Could not parse the provided from date, please ensure it is valid. | The 'DateFrom' value in the request is not in the correct date format. Make sure that the date is formatted correctly according to the API standards. |
Could not parse the provided to date, please ensure it is valid. | The 'DateTo' value in the request is not in the correct date format. Make sure that the date is formatted correctly according to the API standards. |