Payment states and modifications

A payment can have several States. It can change states when a Modification is made.

State	Description	Example
`CREATED`	The payment has been initiated. The user has not yet acted upon the payment.	The user has received a push message, but not yet opened it. Or: The user has been sent to the landing page, but has not done anything in the app.
`AUTHORIZED`	The user has accepted the payment in the app. This is a final state.	The payment has been reserved, (partially) captured or (partially) refunded. A payment that has been captured (either fully or with one or more partial captures), or that has been refunded, will have one or more events, but the state would be `AUTHORIZED`.
`ABORTED`	The payment has been actively stopped by the user. The user has aborted the payment before authorization. This is a final state.	The user cancelled instead of accepting the payment.
`EXPIRED`	The payment has expired. The user did not act on the payment within the payment expiration time. This is a final state.	The user received a push message, but did nothing before the payment request timed out. See Timeouts.
`TERMINATED`	The merchant has cancelled the payment before authorization. The merchant has terminated the payment via the cancel endpoint. This is a final state.	The merchant was not able to provide the product or service, and has cancelled the payment.

When a payment is initiated it has the state CREATED.

Once a payment is confirmed by the user the payment state is AUTHORIZED. Several modification actions can then be made:

info

While you can capture, cancel and refund a payment after authorization, this does not change the state of the payment. A payment will not change state after becoming AUTHORIZED. This is because a payment can be partially captured, and also partially refunded. It is therefore not practical to have states like "captured" or "refunded", since it is not possible to give all the information with just the state. To get all the details about the payment, including the captured and refunded amounts: Use GET:/v1/payments/{reference}, which will give you the aggregate:

"aggregate":{
   "authorizedAmount":{
      "currency":"NOK",
      "value":49900
   },
   "cancelledAmount":{
      "currency":"NOK",
      "value":0
   },
   "capturedAmount":{
      "currency":"NOK",
      "value":49900
   },
   "refundedAmount":{
      "currency":"NOK",
      "value":0
   }
}

This diagram shows all the states a payment can have:

Each modification action is defined as a separate endpoint in the API.

This more detailed diagram shows each state and modification actions for a payment, and these details are also returned by the GET:/v1/payments/{reference}/events endpoint.