Payments

Create a new payment for an invoice. Note This should not be used by PSPs apps. Create a PaymentResult instead.

post/v3/administrations/{administration_id}/payments

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

fields[payment]string

Fieldset. Specify a comma separated list of attributes to return

includestring

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

send_notificationboolean

Send a notification to the customer after creation

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

Response

PaymentResponse

Example response

{
  "data": {
    "id": "1",
    "type": "payment",
    "relationships": {
      "payment_method": {
        "data": {
          "type": "payment_method"
        }
      },
      "booking": {
        "data": {
          "type": "booking"
        }
      },
      "invoice": {
        "data": {
          "type": "invoice"
        }
      },
      "register": {
        "data": {
          "type": "register"
        }
      },
      "administration": {
        "data": {
          "type": "administration"
        }
      },
      "receipt": {
        "data": {
          "type": "receipt"
        }
      },
      "settled_with": {
        "data": {
          "type": "payment"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "payment_method",
      "relationships": {
        "logos": {
          "data": [
            {
              "type": "logo"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        }
      }
    }
  ]
}

Changes

    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • 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 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 ///////

    • 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

    • info

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

    • info

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