Sale API Response Object
The description of the Sale API response object
The Sale API returns a response in standard JSON format. The following table lists the properties of a Sale API response:
Top-Level Properties
| Property | Description |
|---|---|
authorizationNumber | The gateway authorization number. |
batchNumber | The system-generated batch number. |
transactionNumber | The system-generated transaction number. |
approved | The transaction status. |
approvedMsg | Approved if the transaction was approved and null if it was not. |
logDate | The transaction timestamp. |
errors | The errors subobject array if any. |
warnings | The warnings subobject array if any. You should review them even though the gateway approved the transaction. |
errors Subobject (Array)
errors Subobject (Array)| Property | Description |
|---|---|
code | The error code. |
message | The error message. |
canOverride | Whether you can override the error. If true, you can override the error by resending the same exact transaction after approval from PPS. |
warnings Subobject (Array)
warnings Subobject (Array)| Property | Description |
|---|---|
code | The warning code. |
message | The warning message. |
You can find examples of this response object here.
Updated 5 months ago