Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
| Excerpt |
|---|
Returns details of the casual payment based on the payment reference supplied. |
Parameters
Name | Data Type | Length | Description | |
|---|---|---|---|---|
| User | ||||
| String | Required | Provided by Debitsuccess | |
| String | Required | Provided by Debitsuccess | |
| ContractPrefix | String | 6 | Required | Used for payment lookup and user access checks. |
| PaymentRef | String | 50 | Required | Payment reference that is used for generating casual payment token |
Response
Name | Data Type | Description |
|---|---|---|
Name | Data Type | Description |
DateCreated | DateTime | Date/time message was processed |
Id | String | Unique ID for message |
ResponseNotes () | Collection of validation messages | |
| String |
|
| String |
|
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
Payments () | Collection | |
| String | |
| String | Payment note |
| Decimal (10, 2) | |
| DateTime | |
| Integer | Unique identifier for the payment |
| Enum | Cleared, Pending, Failed, Settled, |
| Enum? | CasualCreditCard CasualCreditCardOther |
| String | Batch Number |
| Decimal (10, 2) | The amount of commission Debitsuccess charged on the Payment. |
If the payment is declined for any reason in the response CommissionAmount and PaymentID will be 0.
Error Messages
| Type | Error Code | Error Message |
|---|---|---|
| Error | 02 | Invalid user credentials |
| Error | 14120 | PaymentRef is required |
| Error | 13001 | Invalid Contract Prefix |
Related Pages
| Filter by label (Content by label) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Panel | |
|---|---|
On this page:
|