Action a payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint enables the client to manage a payment via a set of actions. There are currently three possible actions:

  • Accept a quote: When a payment quote is created that the client finds acceptable, you use this action to accept the payment. This moves the payment to the next phase of the Payment Lifecycle. If the quote is not accepted, the status of the payment will change to "Quote Expired".
  • Approve a payment: When a payment is created with the requireApprovalboolean as TRUE and accepted within 5 minutes, then the payment enters the status of "Awaiting Approval". In order to move the payment forward in the Payment Lifecycle, the "Approve" action needs to be provided.
  • Cancel a payment: If a payment is in the "Awaiting Approval" or "Awaiting Funds" stage and a client wants to cancel it, they can do it by calling this endpoint with this action. There are various situations where this can apply, such as when the client realizes the payment has incorrect information and needs to be re-created, or when the payment did not pass approval criteria.
Path Params
string
required

The uuid of the payment to update

Body Params

Action payment schema

string
string
required
Defaults to payment
string
enum
required
Defaults to accept_quote
Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json