Documentation

Carte en cours du clonage...

Merci d'attendre la fin du clonage avant de modifier quoi que ce soit.

API ERRORS RESPONSES

API errors responses

Foxorder's API includes an error management system, this system allows users to have assistance in case of error.

Depending on the type of errors, the error message is often explicit (typing, null, format, etc.) otherwise, it indicates the source of the error and possibly the solution.

Logo
Endpoint Method Error code => message
/api/v2/payments/create
POST
  • 401
    => Access Denied
  • 400
    => Missing parameters
  • 404
    => Order not found
  • 400
    => Payment method not found
  • 404
    => Order can not be placed for anonymous customer
  • 400
    => Cashback disabled in this shop or customer not found
  • 400
    => Cashback disabled in this franchise
  • 400
    => Insufficient cashback balance
  • 404
    => Customer not found
  • 400
    => Request failed
  • 400
    => Cashback process error
  • 400
    => Currency not supported
  • 400
    => Order amount's null
  • 400
    => Stripe invalid configuration
  • 400
    => Payment creation failed
/api/v2/payments/result
POST
  • 401
    => Access Denied
  • 400
    => Missing parameters
  • 400
    => Invalid json
  • 404
    => Payment not found
/api/v2/payments/{external_id}/status
GET
  • 401
    => Access Denied
  • 400
    => Invalid parameter
  • 404
    => Resource not found
/api/v2/payments/{id}/payplug-apple-pay/complete
PATCH
  • 400
    => Invalid input
    • payment
      • => This field is required.
      • => This value should not be null.
      • => This value should be a valid array.
      • => The Apple Pay token schema is invalid.
      • => The payment ID is invalid.
      • => The external payment ID is invalid.
      • => The external payment ID does not match the provided ID.
  • 400
    => An error occured with Payplug Apple pay when completing payment
  • 404
    => Payment not found
Loading…
Loading the web debug toolbar…
Attempt #