POST /payments/codeDetails/{stopId}
Accept payment code information from payment service provider and update the provided stop with information
relevant to the payment code as well as set the stop's payment_code_reviewed field value to 'Y'.
Roles that can access this endpoint are Payment Service.
Parameters
| name |
description |
type |
default |
type |
| stopId |
(Required) The stop for which the payment code is being created or rejected. |
path
|
|
String
|
| paymentCode |
The value for the payment code which will be provided to the vendor accepting the
code as payment for their services.
Required if isCodeCreated = true |
query
|
|
String
|
| internalCodeId |
Any internal value for the payment code which can be used by support for
troubleshooting purposes, if applicable.
Required if isCodeCreated = true |
query
|
|
String
|
| referenceQualfierCode |
The reference qualifier code to assign to the stop reference note for the payment
code information.
Required if isCodeCreated = true |
query
|
|
String
|
| isCodeCreated |
(Required) A true/false value indicating whether the code request was accepted or
rejected by the payment service provider. |
query
|
|
Boolean
|
| rejectReason |
The explanation for why the code request is being rejected by the payment service
provider.
Required if isCodeCreated = false
There is no default value |
query
|
|
String
|
Result
Response
of type:
text/plain
A response containing the success or failure of the code details acceptance.
- If payment code is provided, an Order History Comment will be added to the stop's order indicating the payment code was created for this stop.
- If payment code is not provided, the Order History Comment will reflect that the payment code was not created for this stop and the rejectReason value will be appended.
- If a valid referenceQualifierCode is provided, the reference note will be added to the stop with the payment code information.
-
- If an invalid referenceQualifierCode is provided, no reference note will be added to the stop, but the Order History Comment will reflect that the reference note was not added due to an invalid qualifier code having been provided.
Try It Out
Request