Skip to content

    Errors

    Our API Endpoints use conventional HTTP response codes to indicate the success or failure of an API request.

    General error codes

    In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and codes in the 5xx range indicate an error with our backend (these are rare).

    Http Status CodeMessagePossible Payload
    200OkRequest was successful and contains the response content
    202AcceptedThe request has been accepted for processing, but the processing has not been completed
    203Non-Authoritative InformationRequest was successful but contains business errors
    400Bad RequestThe Request was incorrect (due to http protocol)
    401UnauthorizedNot authorized access to a endpoint
    403ForbiddenNot authorized access to a specific resource
    404Not FoundResource not found
    409ConflictResource already exists
    500Internal Server ErrorUnexpected Server Error
    501Not implementedMethod not implemented

    Specific error codes

    Not all errors map cleanly onto HTTP response codes, however. When a request is valid but does not complete successfully, we return a specific Error code.

    GroupTypeSubtypeCode range
    globalN/AN/A0 - 999
    globalgeneral errorsN/A0 - 499
    globalheader parameterN/A500 - 999
    globalnot definednot defined1000 - 1999
    queryN/AN/A200-3999

    __Group: query, Type: query parameters, Subtype: filtering __

    GroupRange
    global2000 - 2099
    customer2100 - 2199
    addresses2200 - 2299
    personas2300 - 2399
    payment-instruments2400 - 2499
    orders2500 - 2599
    not defined2600 - 2999

    Group: query, Type: query parameters, Subtype: ordering

    GroupRange
    global3000 - 3099
    customer3100 - 3199
    addresses3200 - 3299
    personas3300 - 3399
    payment-instruments3400 - 3499
    orders3500 - 3599
    not defined3600 - 3999

    customers

    GroupTypeSubtypeCode range
    customersgeneralN/A4000 - 4099
    customersuri parameterN/A4100 - 4199
    customersbody parametersN/A4200 - 4999
    customersnot definedN/A5000 - 5999

    addresses

    GroupTypeSubtypeCode range
    addressesgeneralN/A6000 - 6099
    addressesuri parameterN/A6100 - 6199
    addressesbody parametersN/A6200 - 6999
    addressesnot definedN/A7000 - 7999

    personas

    GroupTypeSubtypeCode range
    personasgeneralN/A8000 - 8099
    personasuri parameterN/A8100 - 8199
    personasbody parametersN/A8200 - 8999
    personasnot definedN/A9000 - 9999

    payment-instruments

    GroupTypeSubtypeCode range
    payment-instrumentsgeneralN/A10000 - 10099
    payment-instrumentsuri parameterN/A10100 - 10199
    payment-instrumentsbody parametersN/A10200 - 10999
    payment-instrumentsnot definedN/A11000 - 11999

    orders

    GroupTypeSubtypeRange
    ordersgeneralN/A12000 - 12099
    ordersuri parameterN/A12100 - 12199
    ordersbody parametersN/A12200 - 12999
    ordersnot definedN/A13000 - 13999

    transactions

    GroupTypeSubtypeCode range
    transactionsgeneralN/A14000 - 14099
    transactionsuri parameterN/A14100 - 14199
    transactionsbody parametersN/A14200 - 14999
    transactionsnot definedN/A15000 - 15999

    payment

    GroupTypeSubtypeCode Range
    paymentbody parametersN/A16000 - 16999