Debt Positions API: Installments and Payment Options Manager

The Organization creates a debt Position.

Changed on

The Organization creates a debt Position.

post/organizations/{organizationfiscalcode}/debtpositions

Request

  • Base URL: https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3
  • URL: https://api.uat.platform.pagopa.it/gpd/debt-positions-service/v3/organizations/{organizationfiscalcode}/debtpositions
  • Auth: one of:
    • API key in header Ocp-Apim-Subscription-Key
    • API key in query parameter subscription-key

Path parameters

organizationfiscalcodestring required

Organization fiscal code, the fiscal code of the Organization.

Query parameters

toPublishboolean

Headers

X-Request-Idstring

This header identifies the call, if not passed it is self-generated. This ID is returned in the response.

Request body

iupdstring required
payStandInboolean

feature flag to enable a debt position in stand-in mode

companyNamestring required
officeNamestring
paymentDatestring date-time
status'DRAFT' | 'PUBLISHED' | 'VALID' | 'UNPAYABLE' | 'PARTIALLY_PAID' | 'PAID'

Example request

{
  "payStandIn": true,
  "paymentOption": [
    {
      "debtor": {
        "country": "IT",
        "email": "email@domain.com"
      },
      "installments": [
        {
          "transfer": [
            {
              "organizationFiscalCode": "00000000000",
              "iban": "IT0000000000000000000000000",
              "postalIban": "IT0000000000000000000000000",
              "stamp": {
                "provincialResidence": "RM"
              }
            }
          ]
        }
      ]
    }
  ]
}

Response

Request created.

iupdstring required
payStandInboolean

feature flag to enable a debt position in stand-in mode

companyNamestring required
officeNamestring
paymentDatestring date-time
status'DRAFT' | 'PUBLISHED' | 'VALID' | 'UNPAYABLE' | 'PARTIALLY_PAID' | 'PAID'

Example response

{
  "payStandIn": true,
  "paymentOption": [
    {
      "debtor": {
        "country": "IT",
        "email": "email@domain.com"
      },
      "installments": [
        {
          "transfer": [
            {
              "organizationFiscalCode": "00000000000",
              "iban": "IT0000000000000000000000000",
              "postalIban": "IT0000000000000000000000000",
              "stamp": {
                "provincialResidence": "RM"
              }
            }
          ]
        }
      ]
    }
  ]
}

Changes

  • v36f3db9e68367Revision changes
    • info

      the endpoint scheme security ApiKey was removed from the API

    • info

      added the new optional header request parameter X-Request-Id

    • info

      request body became optional

  • v393e168e2fe0eRevision changes
    • breaking

      request body became required

    • warning

      deleted the header request parameter X-Request-Id

    • info

      the endpoint scheme security ApiKey was added to the API

    • info

      added the new optional header request parameter X-Request-Id to all path's operations

    • info

      the request property default value changed from true to true

    • info

      the request property default value changed from false to false

    • info

      the response's property default value changed from true to true for the status

    • info

      the response's property default value changed from false to false for the status