Skip to content

Payment Invoice: Overview


There are three types of incoming transactions that occur in®:

  • Payment

    A Payment is a low-level operation that initiates a financial transaction in the defined payment provider using the specified payment method, it simply provides communication with an external provider and the mapping of statuses.

  • Request

    A Payment Request is an operation with rich functionality that initiates one or many payments depending on the conditions set in the routing and exchange rate schemes.

  • Invoice

    A Payment Invoice is a high-level operation that initiates accompanying Payment Request and Ledger account transactions.

The Payment Invoice includes information on the amount, currency, service, commission, exchange rate and other properties.


The full list of properties can be found in the API Reference launch .


Payment Invoice Flow

New UI


Below is a description of each status:

CodeFinalSleeping StateDescription
createdNoNoInitial status after a Payment Invoice is created, processing has not started.
If® will not return response 201 (Created) HTTP status code on your request, you should consider that the payment invoice was failed to be created
expiredYesNoMeans the Payment Invoice hit the lifetime limit (configurable in the 'Invoice lifetime' property) without being successfully processed, but also did not either cancelled or terminated, e.g. your customer has abandoned the payment
terminatedYesNoMeans that the payment process was terminated by a payer prior to the payment invoice lifetime limit
processingNoYesSignifies that the payment invoice is processing by® but its processing is not finished and there will be further status updates
process_pendingNoYesMeans that the result of the payment process still being unknown and may not be known for an extended period of time
processedNoNoConfirms the payment has been processed successfully.
This isn't a final status since the payment can be refunded for different reasons
partially_processedNoNoMeans that the amount paid is less than the payment invoice amount and that amount is successfully processed, e.g. your customer has entered an amount less than the invoice amount while making an online payment
process_failedYesNoSignifies that the Payment Invoice processing has failed, may be set when an error occurs and the corresponding payment request has failed.
This status is considered final due to the maximum number of attempts has been reached (default – 5 attempts)
refundingNoYes Means the payment invoice is refunding and the result of the payment invoice refunding still being unknown
refund_pendingNoYes Means that the result of the payment refunding still being unknown and may not be known for an extended period of time
partially_refundedYesNoMeans that the amount refunded is less than the payment invoice amount and that amount is successfully refunded.
refundedYesNoMeans the payment invoice is successfully refunded in full
refund_failedYesNoMeans that the payment invoice refunding has been failed or cannot be completed