--- title: "POST payment_results" method: POST path: "/v3/administrations/{administration_id}/payment_results" tags: ["PaymentResults"] --- # POST payment_results `POST /v3/administrations/{administration_id}/payment_results` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/administrations/{administration_id}/payment_results` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Create a new payment result ## Path parameters - `administration_id` string, required ## Query parameters - `fields[payment_result]` string - `include` string ## Headers - `Accept-Language` string ## Request body - object - `data` object - `type` string: Type - `attributes` object: Attributes - `amount` object - `currency` string - `value` string - `result` 'success' | 'failure' | 'failure_final' | 'open' | 'waiting' | 'cancelled': Valid values are success, failure (it is unlikely, but possible that the payment succeeds at a later time), failure_final (payment has failed, and will never succeed), open (state is unknown, but will be known very soon), waiting (state is unknown, and it might take a long time, even days or weeks before it is known), cancelled (payment is cancelled by customer). - `enable_recurring_payments` boolean: Indicate that this payment also means a mandate for recurring payments has been given by the customer - `cardholder_receipt` string: Text blob with \n (newlines) that is printed in a fixed width font together with the sales receipt / invoice. This receipt should contain payment information for the cardholder. Mostly used for card payments. - `merchant_receipt` string: Text blob with \n (newlines) that is printed in a fixed width font together with the sales receipt / invoice. Used when a card payment is authenticated by signature. The receipt should contain a section for a signature from the cardholder. - `terminal_identifier` string: Identifier of the terminal that processed the payment. Optional, but if set, will be displayed on the invoice, and for fiscalization purposes. - `relationships` object: Relationships - `payment_request` object - `data` object - `id` string: payment_request ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` PaymentRequest[] - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `price` object - `currency` string - `value` string - `locale` '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': Locale used for communication - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK' | 'AN' | 'ZZ' | 'WW' - `description` string - `reference` string: A reference, for example a booking or invoice number. Its maximum length does not exceed 32 characters. - `finished` boolean: Indicates whether the payment request has been finished - `last_status` 'open' | 'waiting' | 'success' | 'open_but_confirmed' | 'cancelled' | 'failure' | 'failure_final' | 'expired': The last known status of the payment request - `links` object: Links - `redirect` string: Link to redirect - `relationships` object: Relationships - `payment_method` object: The payment method that should be used - `data` object - `id` string: payment_method ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `payment_handler` object - `data` object - `id` string: payment_handler ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `receipt` object: The concept receipt that needs to be paid. Can be queried separately to retrieve receipt items. - `data` object - `id` string: receipt ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `register` object: The register that was used to initiate the payment. - `data` object - `id` string: register ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `credit_card` object - `data` object - `id` string: credit_card ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `invoice` object - `data` object - `id` string: invoice ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `booking` object - `data` object - `id` string: booking ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `debtor` object - `data` object - `id` string: debtor ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `administration` object - `data` object - `id` string: administration ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `links` object - `related` string - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Response `204` Success ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 6 info - added the new optional request property `included/items/anyOf[#/components/schemas/PaymentRequest]/links` - added the new optional request property `included/items/anyOf[#/components/schemas/PaymentRequest]/relationships/booking` - added the new optional request property `included/items/anyOf[#/components/schemas/PaymentRequest]/relationships/invoice` - added the new `da-DK` enum value to the request property `included/items/anyOf[#/components/schemas/PaymentRequest]/attributes/locale` - …2 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/administrations/:administration_id/payment_results/post.md) --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)