PaymentMethods

POST payment_method

Changed on

Create a new payment method

post/v3/administrations/{administration_id}/payment_methods

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

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

Response

PaymentMethodResponse

Example response

{
  "data": {
    "id": "1",
    "type": "payment_method",
    "relationships": {
      "logos": {
        "data": [
          {
            "type": "logo"
          }
        ]
      },
      "administration": {
        "data": {
          "type": "administration"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "logo"
    }
  ]
}

Changes

    • warning

      added the new external_voucher enum value to the // response property for the response status

    • 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 external_voucher enum value to the request property //

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status