API basics
      Back to home
      1. Knowledge base
      2. Integrations
      3. API basics

      Status codes

      Status codes

      FlipPay APIs will return standard HTTP status codes in responses, with additional content in the body of the response payload.

      Error responses

      Error responses provided by FlipPay APIs will include:

      • Message - a summary line confirming the issue in a more contextual statement
      • Details - a message against each field generating an error, confirming the issue

      Example "404 Not Found" response:

      {
         "message": "Object not found",
            "details": {
               "templateId": "templateId not found on this merchant account",
               "accountId": "accountId not found on this merchant account",
               "productId": "productId not enabled on this merchant account",
               "fieldId": "fieldId not found on this product"
            }
      }

      Success response

      Success responses provided by FlipPay APIs may include:

      • Warnings - a message against each field where there may be a non-critical, or automatically rectified, issue with your request

      Example "200 OK" response with warnings:

      {
         "message": "Payment request created",
         "paymentRequestId": "PR-1111-2222",
         "prStatus": "pending",
         "paymentRequestUrl": "https://demo.flippay.com.au/payments/60d5a0a2748f61254d199a25",
         "expiry": "DD-MM-YYY-HH-MM-SSZ",

         "warnings": {
            "smsMask": "Invalid entry, default value applied",
            "emailMask": "Invalid entry, default value applied",
            "expiryDays": "Invalid entry, default value applied"
         }
      }

      FlipPay APIs are designed to be flexible and forgiving on fields that are not "required" for payment requests to be generated, with the intent on ensuring payment requests are created with a minimal risk of error/failure for integrated systems.

      Where fields provided in a request are not "required" for the payment request to be generated, and invalid data is provided - instead of a hard failure, FlipPay will discard invalid data and apply default settings from the Merchant account (which are always available). Such instances are reported as a "warning" in the response.