POST /payments/submitTransaction/{stopId}
Accept payment code details from payment service provider. Attached document to order history comment, index to
DocumentPower, and create wire transaction record.
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
|
| payeeId |
(Optional) The payeeId which will be associated with the wire transaction code. |
query
|
|
String
|
| paymentCode |
(REQUIRED) The Payment code provided by the payment vendor. |
query
|
|
String
|
| amount |
(REQUIRED) The amount of the wire to be posted in USD. |
query
|
|
BigDecimal
|
| internalCodeId |
(REQUIRED) The payment service provider internal code for support purposes. |
query
|
|
String
|
| transactionDateTime |
(REQUIRED) Date and time when transaction occurred. |
query
|
|
Date
|
| transactionWireCode |
(REQUIRED) The wire service code associated to be use on wire transaction record. |
query
|
|
String
|
| imageTypeId |
(REQUIRED) The id associated with the document type in DocumentPower. |
query
|
|
String
|
| image |
(REQUIRED) Image of the transaction receipt. |
body of type: image/jpeg image/gif image/tiff image/png image/bmp application/pdf
|
|
InputStream
|
Result
Response
of type:
text/plain
A response containing the payment code processed successfully or a failure.
Wire Transaction Record If an invalid wire transaction record is provided, an Order
History Comment will reflect that the wire transaction record was invalid and the customer has to create the
missing transaction manually.
Existing Transaction Record If wire transaction record exist, an Order History Comment
will reflect that the transaction appears to be a duplicate of a transaction previously processed. Unable to
create wire transaction record and the customer has to create the missing transaction manually.
-
payeeId is optional. If a valid payeeId supplied, it is placed on the wire transaction record.
-
payeeId is optional. If no payeeId is supplied or the supplied payeeId is invalid
- If the transaction wire code has
no validations enabled , create the transaction wire record and leave the payeeId blank
- If the wire service code has
no validations disabled , attempt to look up the payeeId on the movement for the supplied stop ID.
---- If it is an Asset Load , retrieve the payeeId associated with the driver currently assigned to the movement.
---- If it is a Brokerage Load, use the override_payee_id.
- If the payeeId is found, it is placed on the transaction wire record.
- If the payeeId cannot be found, do not create the transaction wire record but note on the order history record that the wire transaction was not created due to payeeId not found.
Try It Out
Request