payVyne Developers

Welcome to payVyne. Instant e-commerce payments. Here you will find the integration guides, API documentation, and much more to easily integrate with payVyne.

Documentation    API Reference

Payment statuses

When a Payment Initiation Request or Recurring Payment Initiation Request is created, the response payload will contain a status which reflects the current state of the payment. The payment status will update as the state of the payment changes. You can understand more about how to check the status of a payment here, or recurring payment here.

Status

Description

Experience

CREATED

The payment request has been created. Awaiting consumer interaction.

Redirect consumer to the hosted checkout or bank (when using integrated checkout).

PROCESSING

The payment request response is pending.

Inform the consumer that the payment is is being processed and they will receive more information shortly.

EXPIRED

The payment has timed out.

Inform the consumer that the payment has expired due to inactivity.

FAILED
F

The payment request has been rejected by the bank, or the consumer failed to confirm the transaction.

Inform the consumer that the payment failed and no funds were taken.

NO_CONSENT
F

The consumer did not give consent to set up the payment (by selecting decline at the hosted checkout).

Redirect the consumer to select a payment method again (restart the payment flow).

NO_CONFIRM
F

The consumer did not authorise the payment request in their bank (by cancelling or selecting do not authorise).

Redirect the consumer to select a payment method again (restart the payment flow) and inform them no funds were taken.

INITIATED
F

The payment has been acknowledged by the payer's bank and will be executed shortly - consider the payment complete.

Inform the consumer that the payment was successful.

SENT
F

The payment was sent to the payer's bank without acknowledgement, and will be executed shortly - consider the payment complete.

Inform the consumer that their payment was successful.

COMPLETED
F

The payment has been accepted by the payer's bank and will be executed shortly - consider the payment complete.

Inform the consumer that their payment was successful.

SETTLED
* F

The payment has executed and funds have arrived in the destination account.

Inform the consumer that their payment was successful.

PART_REFUNDED
*

A part of the original payment amount has been successfully refunded to the payer's bank account.

Inform the consumer that the refund was successful.

REFUNDED
*

The total original payment amount has been successfully refunded to the payer's bank account.

Inform the consumer that the refund was successful.

* Status is only available in enhanced payment initiation plans.
F Status is final and will not change (except for refunds).

๐Ÿ“˜

Helpful to know

Vyne will provide a COMPLETED status when the payment instruction has been accepted by the bank. In 99.78% of cases this will result in a successful transaction, however until the funds have reached the destination account it is possible that the transaction may not complete. Transactions can be subsequently delayed or rejected following a COMPLETED status due to further checks by the payerโ€™s bank after the bank has accepted the payment.

๐Ÿ‘

Try it out

For complete confidence that the funds have been received, Vyne will provide a SETTLED status as soon as the funds arrive in the account. Confirmation of funds is available in enhanced payment initiation plans. Contact support to find out more.

Updated 4 days ago


Payment statuses


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.