DPA Configuration - AltScore Docs

The DpaSettings Object

The DpaSettings object represents the DPA configuration for a specific partner.

{
  "partnerId": "6457c3ce-3887-45d6-92ca-299219ea96db",
  "defaults": {
    "currency": "MXN",
    "flowExpirationMinutes": 15,
    "closingBalanceThreshold": "1.00",
    "productId": "e4341b4b-ce1c-4692-bb75-9f438b29dec4",
    "segmentationId": "e4341b4b-ce1c-4692-bb75-9f438b29dec4",
    "excludeDefaultProductFromSegmentation": false,
    "calendarType": "BusinessDays"
  },
  "timezone": "America/Argentina/Buenos_Aires",
  "onApproveFlowReserveAllAssignedAmount": true,
  "invoiceOverLimit": 12.5,
  "reserveOnStart": true
}

Attributes

Attribute	Description	Type
`partnerId`	Unique identifier of the partner	String (UUID)
`defaults`	Default configuration for the DPA flow	Object
`timezone`	Partner's timezone	String
`onApproveFlowReserveAllAssignedAmount`	Indicates whether to reserve the entire assigned amount upon flow approval	Boolean
`invoiceOverLimit`	Allowed percentage over the invoice limit	Number
`reserveOnStart`	Indicates whether to reserve the amount when starting a DPA flow	Boolean

Defaults Object

Attribute	Description	Type
`currency`	Default currency for the DPA flow	String
`flowExpirationMinutes`	Flow expiration time in minutes	Integer
`closingBalanceThreshold`	Closing balance threshold	String
`excludeDefaultProductFromSegmentation`	Allows excluding the default product from advanced simulations	boolean
`productId`	Identifier of the default credit product for simple simulations	uuid
`segmentationId`	Identifier of the default segmentation used for simple simulations	uuid
`calendarType`	Calendar type for date calculations	String ("Custom", "BusinessDays", "NaturalDays")

Endpoints

Get DPA Configuration for a Partner

Retrieves the DPA configuration for a specific partner.

GET /v2/partners/:partnerId/settings/dpa

Path Parameters:

Parameter	Description
`partnerId`	ID of the partner to retrieve the configuration

Successful Response:

{
  "partnerId": "6457c3ce-3887-45d6-92ca-299219ea96db",
  "defaults": {
    "currency": "MXN",
    "excludeDefaultProductFromSegmentation": true,
    "flowExpirationMinutes": 15,
    "productId": "e4341b4b-ce1c-4692-bb75-9f438b29dec4",
    "segmentationId": "e4341b4b-ce1c-4692-bb75-9f438b29dec4",
    "closingBalanceThreshold": "1.00",
    "calendarType": "BusinessDays"
  },
  "timezone": "America/Argentina/Buenos_Aires",
  "onApproveFlowReserveAllAssignedAmount": true,
  "invoiceOverLimit": 12.5,
  "reserveOnStart": true
}

Update DPA Configuration for a Partner

Updates the DPA configuration for a specific partner.

PATCH /v2/partners/:partnerId/settings/dpa

Path Parameters:

Parameter	Description
`partnerId`	ID of the partner to update the configuration

Input Parameters:

Parameter	Description	Type	Required
`defaults`	New default values	Object	No
`timezone`	New timezone	String	No
`onApproveFlowReserveAllAssignedAmount`	New value for reserve on approval	Boolean	No
`invoiceOverLimit`	New value for invoice limit	Number	No
`reserveOnStart`	New value for reserve on start	Boolean	No

Example Request:

{
  "defaults": {
    "currency": "USD",
    "flowExpirationMinutes": 30,
    "calendarType": "BusinessDays"
  },
  "timezone": "America/New_York",
  "invoiceOverLimit": 15.0
}

Successful Response:

The response will be the updated DpaSettings object.

Error Handling

The API may return the following error codes:

Code	Description
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Errors will include a descriptive message in the response body.