Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
ochatelain opened this issue Mar 21, 2024 · 10 comments · Fixed by #135
Closed

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

ochatelain opened this issue Mar 21, 2024 · 10 comments · Fixed by #135
Assignees
Labels
enhancement Issue requires improvements or additions to interface functionality
Milestone

Comments

@ochatelain
Copy link
Collaborator

IS

  • 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"
}
@svenbiellmann svenbiellmann added new Newly submitted issue enhancement Issue requires improvements or additions to interface functionality labels Mar 22, 2024
@vpusher
Copy link

vpusher commented Mar 26, 2024

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 svenbiellmann added this to the v5.0 milestone Apr 4, 2024
@svenbiellmann svenbiellmann removed the new Newly submitted issue label Apr 4, 2024
@svenbiellmann
Copy link
Contributor

svenbiellmann commented Apr 10, 2024

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
Copy link
Collaborator Author

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

@svenbiellmann
Copy link
Contributor

Meetin Notes 20.6.24

This issue will be discussed on 15th August.

@svenbiellmann
Copy link
Contributor

Meetin Notes 15.8.24

The pull request has to be generated and presented on 26th September by @ochatelain.

@svenbiellmann
Copy link
Contributor

svenbiellmann commented Oct 16, 2024

Meeting Notes 26.9.24

The update / Pull Request will be discussed on next meeting 31st October. The pull request will be generated and presented by @ochatelain.

@chatelao
Copy link
Contributor

@svenbiellmann svenbiellmann linked a pull request Oct 29, 2024 that will close this issue
@svenbiellmann
Copy link
Contributor

Meeting Notes 31.10.24

@ochatelain presented the issue and elaborated that submissionId in the response will be first added into the body for V5 and then for V6 removed from the header. Dominik M. (ZKB) and Roland (Finnova) will clarify what the change means effort-wise. An update is expected on next meeting.

@svenbiellmann
Copy link
Contributor

svenbiellmann commented Dec 17, 2024

Meeting Notes 12.12.24

Due to functional adjustments deriving from issue #141 the endpoint POST/payment need to be adapted. In the course of this adjustment the change of the submissionId can be taken up as well. The Pull Request has been approved and will be merged into V5.

svenbiellmann added a commit that referenced this issue Jan 16, 2025
Add the submissionId to standing-order, single-payments, payments.

---------

Co-authored-by: chatelao <[email protected]>
@svenbiellmann
Copy link
Contributor

Issue merged with respecting pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issue requires improvements or additions to interface functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants