Result Objects
Result objects are wrapper objects that indicate whether or not the API call was a success and, if successful, include the requested data.
Success results
If the API call was successful, the is_success
on the result will return True. The target object will be available as a member of the result object.
- Python
result.is_success
# True
transaction = result.transaction
Error results
If the API call was not successful, the success on the result will return False. An error may be due to:
- A validation error caused by invalid parameters
- A processor decline or gateway rejection
- Other exceptional conditions
- Python
result.is_success
# False
result.errors.deep_errors
The errors result object will only be populated if the error is due to a failed validation. In this case, the object will contain one or more validation errors indicating which parameters were invalid:
- Python
result = gateway.customer.create({
"email": "invalid_email",
"credit_card": {
"number": "not_numeric"
}
})
for error in result.errors.deep_errors:
print(error.attribute)
print(error.code)
print(error.message)
for error in result.errors.for_object("customer"):
print(error.attribute)
print(error.code)
print(error.message)
for error in result.errors.for_object("customer").for_object("credit_card"):
print(error.attribute)
print(error.code)
print(error.message)
For details on transaction error results, see the transaction response object .
Message
The message on the error result gives a human-readable description of what went wrong, regardless of the cause and nature of the error.
- Python
print(result.message)
# "Amount is required.
Credit card number is invalid."
The message can contain multiple error messages.
Params
Error results include the parameters that were submitted. This can be useful during Transparent Redirects to repopulate your form if validations fail.
- Python
print(result.params)
# {"transaction": {"amount": "1.00"}, {"credit_card": {"cardholder_name": "John Doe"}}}
For PCI compliance reasons, credit card number and cvv parameters are not included.