Risk Participation Instruction

This is a technical overview for Risk Participation Instruction. The file is used to set/clear risk participator on credit accounts.

Overview

The file is used to send instructions to PayEx to change the risk participator on account credits. Only predefined risk participators (agreed with PayEx) can be used.

The instructions are stored at PayEx and executed according to the agreed schedule.

If several instructions are sent against the same credit account before they have been executed, the most recent one will be used.

There are two different type of instructions. 

  • Clear - remove the current risk participator from the account
  • Set - set the desired risk participator on the account.

Name Convention

RISKPARTICIPATIONINSTRUCTION_<CompanyNumber>_<DatumTime>_<SerialNumber>.xml

Name componentsDescription
CompanyNumberThe company number in our ledger system
DateTimeThe date and time that the file was created. Uses ISO 8601 format, YYYYMMDDhhmmdd
SerialNumberShould follow an uninterrupted number series, 1, 2, 3 and so on.

E.g. RISKPARTICIPATIONINSTRUCTION_9999_20080923124422_1.xml

Receipt file

When the file is processed, a receipt will be created showing numbers of processed instructions, failed instructions etc.

Detailed description of the file can be found here

Error handling

If any error occurs during the process of the XML file, an errorlog file will be produced and returned consisting of:

  • detailed description of all the errors that occured (ResponseItems file)
  • the elements of the original file that failed (OriginItems file)

Depending of the type of error you can choose to correct the invalid elements and transfer it again in a new file (using the next serial number in the number series).

Detailed description of the file can be found here

Current XML schema description

A detailed description of the elements in the current version of the XML schema definition file (XSD) can be found here

Download current XML schema file

FileversionVersionReleasedateComment
RiskParticipationInstruction_[1.0].xsd1.02023-10-17 

Change Log

Version 1.0

September, 2023

RiskParticipationInstruction_[1.0].xsd

 Initial version (latest documented version)

Download sample file

RiskParticipationInstruction_123_20231003133452_1.xml

 

Created by David Persson on 2023/09/29 14:11