Errors

Handle API errors and understand standard error codes

Errors are raised under the related HTTP 4xx Client Error or 5xx Server Error HTTP status codes. The body of the response includes more information.

Error Response Format

• Individual Object Error
• Multiple Objects Error

{
  "details": {
    "payment_method_id": "Required"
  },
  "error_description": "payment_method_id",
  "error_type": "InvalidAttributes",
  "object": "error"
}

{
  "details": {
    "object": "list",
    "values": [
      {
        "email": "Required"
      },
      {
        "name": "Required"
      }
    ]
  },
  "error_description": "[0][email], [1][name]",
  "error_type": "InvalidAttributes",
  "object": "error"
}

Error Handling in SDKs

• Handling Individual Errors
• Handling Multiple Object Errors

import payload
from payload.exceptions import InvalidAttributes, TransactionDeclined
 
pl = payload.Session('secret_key_3bW9...', api_version='v2')
 
# Handle errors when creating a payment
try:
    cust = pl.Account.get('your_customer_id')
    pl.Transaction.create(type='payment', sender={'account_id': cust.id}, amount=100)
except TransactionDeclined:
    print("Transaction declined")
except InvalidAttributes as e:
    print(e)

import payload
from payload.exceptions import InvalidAttributes
 
pl = payload.Session('secret_key_3bW9...', api_version='v2')
 
 
# Handle errors when creating multiple customers
try:
    pl.Account.create(
        [
            pl.Account(type="customer", name="John Doe"),
            pl.Account(
                type="customer",
                name="John Doe",
                contact_details={'email': "[email protected]"},
            ),
        ]
    )
except InvalidAttributes as e:
    print(e)

Standard Error Codes

Object Operation Validation Issues

Issues With Access & Permissions

Requesting Nonexistent Resources

API Rate Limit Reached

Internal Issues & Downtime