Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
xml
xml
<Response>
     <Status>OK</Status>
     <StatusCode>5000</StatusCode>
     <FreeText language="en">OK</FreeText>
     <Content>
        <Group>
		<Value type="UsedSaldo">30512</Value>
        </Group>
     </Content>
</Response>

Payslip API

 

Delete

Delete requested payslip

 

URL: https://terminal.apix.fi/senderpayslip?TraID=<TransferID>&t=TimeStamp&hash=<ReceiverHash>&date=<DateID>&D=SHA-256:<Digest>
HTTP Method:
DELETE
Authentication:
Yes. The separate SHA-256 digest is calculated from all the parameters and addition with the TransferKey as the shared secret. The calculated digest is headed by string "SHA-256:".

Parameters:

TraIDUser transfer ID
TimeStamp

In the format CCYYMMDDHHMMSS. All times are in UTC

ReceiverHashMD5 hex value of person id  
DateIDPayslip date in the format of YYYYMMDD and payslip ID separated with "-" example: 20200515-7645849
DigestThe calculated SHA256 digest of the parameters and transferKey (TraID+ReceiverHash+DateID+TimeStamp+Tkey)
  

Example:

 

Response on succesful delete:

 
Code Block
xml
xml
<Response>
<Status>OK</Status>
<StatusCode>7PS00</StatusCode>
  <Content>
   <Group>
     <Value type="StorageQuota">9999999</Value>
   </Group>
  </Content>
</Response>

 

 

Payslip API

 

Delete

Delete requested payslip

 

URL: https://terminal.apix.fi/senderpayslip?TraID=<TransferID>&t=TimeStamp&hash=<ReceiverHash>&date=<DateID>&D=SHA-256:<Digest>
HTTP Method:
DELETE
Authentication:
Yes. The separate SHA-256 digest is calculated from all the parameters and addition with the TransferKey as the shared secret. The calculated digest is headed by string "SHA-256:".

Parameters:

TraIDUser transfer ID
TimeStamp

In the format CCYYMMDDHHMMSS. All times are in UTC

ReceiverHashMD5 hex value of person id  
DateIDPayslip date in the format of YYYYMMDD and payslip ID separated with "-" example: 20200515-7645849
DigestThe calculated SHA256 digest of the parameters and transferKey (TraID+ReceiverHash+DateID+TimeStamp+Tkey)
  

Example:

 

Response on succesful delete:

 
Code Block
xml
xml
<Response>
<Status>OK</Status>
<StatusCode>7PS00</StatusCode>
  <Content>
   <Group>
     <Value type="StorageQuota">9999999</Value>
   </Group>
  </Content>
</Response>