Banked

The Banked Developer Hub

Welcome to Banked's developer hub. You'll find comprehensive guides and documentation to help you get going with Banked as quickly as possible, as well as support in case you get stuck. Let's jump right in!

Get Started    

Payment states

Understanding what the state field means in Banked's payment session

When you GET a payment session with a payment ID, or when you receive a webhook from Banked the JSON payload will contain a state field which will tell you about the state of the payment.

Payment session

State

Description

awaiting_provider

A Banked payment link has been generated, but the user has not selected a provider

awaiting_payment_consent

The user is in the authorisation process with their bank

pending

The users bank has accepted the payment and is processing it

sent

The payment has been sent, the money has left the users account, cannot be recalled and is within the Faster Payments network

failed

The payment has failed, see below

Batch payment session

State

Description

awaiting_payment_consent

A Banked batch payment has been generated, but has not been authorised yet

pending

The bank has accepted the batch payment and is processing it

accepted

The bank has processed the batch payment

failed

The batch payment has failed see below

sent

All payments in the batch payment have been confirmed as sent

sent_with_failures

Some payments in the batch payment have been confirmed as sent and others have failed

Individual batch payee

State

Description

awaiting_payment_consent

The batch payment session for this payee has been generated, but has not yet been authorised

pending

The batch payment session for this payee has been accepted by the bank, this individual payment is being processed

failed

This individual payment has failed

sent

This individual payment has been successfully processed

What can cause a 'failed' state?

There are several reasons why a payment could be in a failed state:

Individual & Batch Payments

  • The originating bank refused to send the payment (e.g. because there are some restrictions on that users account like anti money-laundering)
  • The originating bank cannot send the payment (e.g. because of some internal error)
  • The user's account has insufficient funds
  • The user refused consent during the authorisation flow
  • The account information in the payee field cannot receive payments (e.g. the sort code and account number are invalid or on a bank watch list)
  • There is something wrong with the Faster Payments network

Batch Payments only

  • For batch payments created with a linked account, payments will be marked as failed if the payment has not been seen in the account's transactions after seven days from batch payment creation

When will my account receive the funds after a 'sent' status?

When a payment enters the sent state it has been accepted into the The Faster Payments network, which processes interbank transfers in the UK; payments sent by Faster Payments 'usually arrive within minutes, although sometimes they can take up to two hours'. The Faster Payments network handles tens of billions of pounds a day.

It's important to note that once the payment is in the sent state it cannot be recalled by the sender and the Faster Payments network has an SLA that 100% of payments that enter its network will arrive at the receiving bank.

Updated 7 months ago

Payment states


Understanding what the state field means in Banked's payment session

Suggested Edits are limited on API Reference Pages

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