Create a new payment
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.
Query 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.
Indicates where in the payment lifecycle a payment is.
AUTO_PAYCANCELLEDCOMPLETEDIN_PROGRESSNONEOVER_RIDESCHEDULEDThe type of payment.
CURRENT_BALANCEMINIMUM_BALANCESTATEMENT_BALANCEOTHER_AMOUNTResponse
Payment information.
Response Attributes
HATEOAS links to payment-related resources
Show child attributes
Amount that will be processed for this payment.
Unique identifier for a payment.
Indicates where in the payment lifecycle a payment is.
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
403 (Forbidden)
Response Attributes
404 (Not Found)
Response Attributes
500 (Internal Server Error)