BObookingexperts
PaymentRequests

POST payment_request

Changed on

Create and initiate a payment request for a given invoice or booking using an API POS enabled managed payment method. Returns the payment request and the external redirect URL.

post/v3/administrations/{administration_id}/payment_requests

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

fields[payment_request]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_request",
    "attributes": {
      "price": {
        "currency": "EUR",
        "value": "10.00"
      },
      "billed_to": "guest or channel"
    },
    "relationships": {
      "payment_method": {
        "data": {
          "type": "payment_method"
        }
      },
      "invoice": {
        "data": {
          "type": "invoice"
        }
      },
      "booking": {
        "data": {
          "type": "booking"
        }
      },
      "register": {
        "data": {
          "type": "register"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "payment_method",
      "relationships": {
        "logos": {
          "data": [
            {
              "type": "logo"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        }
      }
    }
  ]
}

Response

PaymentRequestResponse

Example response

{
  "data": {
    "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"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "payment_method",
      "relationships": {
        "logos": {
          "data": [
            {
              "type": "logo"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        }
      }
    }
  ]
}

Changes