Update a payment.
Authentication
Standard HTTP Bearer token. Enter the 'access_token' value.
Header Parameters
Optional audit field that indicates the User that performed a change. This field cannot be updated directly without appropriate permission - it is automatically set to the clientId of the authenticated User making the request.
This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.
Access Tokens have a lifespan of 15 minutes.
Requesting an access token
Parameters:
- client_id = my-client-id
- client_secret = my-client-secret
- [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...
Query Parameters
Path Parameters
Body Parameters
Amount that will be processed for this payment.
Id of the bank this payment is scheduled to be pulled from.
Day payment is scheduled to be processed.
C completed, I in progress, O over ride, R auto payment, S scheduled, X cancelled
AUTO_PAYCANCELLEDCOMPLETEDIN_PROGRESSNONEOVER_RIDESCHEDULEDThe type of payment.
CURRENT_BALANCEMINIMUM_BALANCESTATEMENT_BALANCEOTHER_AMOUNTResponse
200 (Ok)
Response Attributes
HATEOAS links to payment-related resources
Show child attributes
Amount that will be processed for this payment.
Unique identifier for a payment.
C completed, I in progress, O over ride, R auto payment, S scheduled, X cancelled
AUTO_PAYCANCELLEDCOMPLETEDIN_PROGRESSNONEOVER_RIDESCHEDULEDThe type of payment.
CURRENT_BALANCEMINIMUM_BALANCESTATEMENT_BALANCEOTHER_AMOUNTId of the bank this payment is scheduled to be pulled from.
Day payment is scheduled to be processed.
400 (Bad Request)
Response Attributes
401 (Unauthorized)
Response Attributes
404 (Not Found)
Response Attributes
500 (Internal Server Error)
Response Attributes
Response