PSS - POST /payments - Move "submissionId" from "Location"-Header to a JSON-body

swissfintechinnovations / ca-payment

Common APIs for AIS and PIS

https://www.common-api.ch

Apache License 2.0

0 stars 3 forks source link

PSS - POST /payments - Move "submissionId" from "Location"-Header to a JSON-body #88

Open ochatelain opened 3 months ago

ochatelain commented 3 months ago

The payment-id is returned in this strange format as (relative) URL in the response Header
```
Location: /payments/41341234
```

SHOULD

A simple body with one field would be way easier.

{
  "submissionId": "41341234"
}

vpusher commented 3 months ago

Considering RESTful design (POST /payments) and considering the former header (/payments/41341234), should we not call this new field paymentId ? I have no real preferences, I am just wondering what API standards do we follow here. Also, from ISO20022 (pain.001 and pain.002) does not mention any "submission" entity if I am not wrong.

svenbiellmann commented 3 months ago

Meeting Notes 4.4.24

The participants agreed that the community shall be asked to provide feedback on the proposed solution.

Proposed solution: Return the submission ID in request body instead of location header.

Task to all SFTI XS2A members: Please provide your feedback by 30th April if you would agree to implement the proposed solution in the next major version V5.

ochatelain commented 3 months ago

Agree with @vpusher: "paymentId" would be better
Transistion period (1): New field v5 mandatory for SP, header still supported for SU
Transistion period (2): Old header v6 removed

svenbiellmann commented 1 week ago

Meetin Notes 20.6.24

This issue will be discussed on 15th August.