BObookingexperts
PaymentResults

POST payment_results

Changed on

Create a new payment result

post/v3/administrations/{administration_id}/payment_results

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

fields[payment_result]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Request body

Example request

{
  "data": {
    "type": "payment_result",
    "attributes": {
      "result": "success"
    },
    "relationships": {
      "payment_request": {
        "data": {
          "type": "payment_request"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "payment_request",
      "attributes": {
        "locale": "cs",
        "country_code": "NL"
      },
      "relationships": {
        "payment_method": {
          "data": {
            "type": "payment_method"
          }
        },
        "payment_handler": {
          "data": {
            "type": "payment_handler"
          }
        },
        "receipt": {
          "data": {
            "type": "receipt"
          }
        },
        "register": {
          "data": {
            "type": "register"
          }
        },
        "credit_card": {
          "data": {
            "type": "credit_card"
          }
        },
        "invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "booking": {
          "data": {
            "type": "booking"
          }
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        }
      }
    }
  ]
}

Response

Success

Changes

  • ff81bc4fefa9Revision changes
    • info

      added the new optional request property //////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property ///////

    • info

      added the new da-DK enum value to the request property ///////

    • info

      added the new en-GB enum value to the request property ///////

    • info

      added the new en-US enum value to the request property ///////