namex: back end for refund feature

[severinbeauvais]

Description:

The Name Request API needs some development to support the refund feature.

This ticket is a sibling to UI ticket #4488.

The flow:

• under some conditions, a user may cancel their NR and request a refund (see table and link to spreadsheet below)
• the API will inform the UI to display the CANCEL AND REFUND button
• if the user requests to cancel and refund, the UI will make a PATCH REFUND call to the API
• the API will set the NR to a new state (cancelled and refund requested)
• the API will call the Pay API to request a refund
• if successful, return 200
• if not successful? TBD
• the API need to inform the UI about the new buttons to display (not upgrade, not refund)
• if the user searches for their NR before the refund is processed (about a week I think) then the status = cancelled, refund requested
• ~if the user searches for their NR after the refund is processed then the status = cancelled~ FUTURE
• for NRs that cannot be cancelled, the API needs to inform the UI to display a CANCELLED button
• if the user requests to cancel, the UI will make a PATCH CANCEL call to the API?
• etc

References:

• UI ticket: https://app.zenhub.com/workspaces/entity-5bf2f2164b5806bc2bf60531/issues/bcgov/entity/5291
• Spreadsheet: https://docs.google.com/spreadsheets/d/1SVmnnl-mpROjYICsD6nvHoFVrcAxaOHewdsDJXE1S74/edit#gid=0
• UI with Cancel and Refund button: https://preview.uxpin.com/9803451b0530363ac5043d6ce539aafa7140d99d#/pages/133214744/simulate/sitemap
• UI's Cancel and Refund dialog: https://projects.invisionapp.com/d/#/console/20760950/438394977/preview

Refund possible table:

Source of NR	User Role	Payment Type	Refund possible from name request?
NRO	Staff	FAS	No
NRO	Staff	BCOL	No
NRO	Staff	No Fee	No
NRO	BCOL	BCOL	No
NRO	Public	Credit Card	No
Name Request	Public	Pay BC Credit Card	Yes
Name Request	Public	BCOL	TBD

Pay endpoint details from @sumesh-aot :

Refund Endpoint : POST /api/v1/payment-requests/{id}/refunds Body :

{
'reason': 'Duplicate submission'
}

The endpoint is secured by system role, only service accounts can invoke this endpoint. Possible status codes. : 202 (Accepted, no response body),

[Kaineatthelab]

@bcdevlucas are you able to pick this one up next?

[bcdevlucas]

Something is up with Payments API... looking into it, this is basically done.

[severinbeauvais]

Something is up with Payments API... looking into it, this is basically done.

Awesome. Please let me know when it's deployed to Dev so we can test there.