Manual Bank Transfer

Manual Bank Transfer (MBT) lets a customer send funds from their bank using payment details you display. Augustus reconciles the incoming transfer against the order by reference and fires an order_updated webhook.

Manual Bank Transfers are available only in the 2023-01-01 API.

Flow

Create an order

The response includes payment details to display.

Display payment details

Show them to the customer as instructions.

Track the order

Order moves from processing to paid when funds arrive. See Status flow.

Create an order

2023-01-01

import Ivy from '@getivy/node-sdk'

const client = new Ivy()
const order = await client.orders.create({
  amount: 1.23,
  currency: 'EUR',
  referenceId: 'your-internal-reference',
  customer: {
    email: 'customer@example.com',
  },
})

POST /api/service/order/create in the API Reference →

Display the payment details

The order’s destination field contains the payment details. The shape varies by currency.

EUR (IBAN)
GBP (Sort Code)

{
  "destination": {
    "bankAccount": {
      "iban": {
        "iban": "DE34817329488882190",
        "accountHolderName": "Test Merchant",
        "bic": "BCIRLLLL"
      }
    },
    "bankStatementReference": "ir4d23bcd816e89ef"
  }
}

{
  "destination": {
    "bankAccount": {
      "sortCode": {
        "sortCode": "123456",
        "accountNumber": "1234567890",
        "accountHolderName": "John Doe"
      }
    },
    "bankStatementReference": "irf1234556679"
  }
}

The bankStatementReference is how Augustus matches the incoming transfer to your order. The customer must copy it exactly.

Track the order

Orders start in processing. Once funds arrive and reconcile, the order moves to paid. If nothing arrives or reconciliation fails, the order stays processing for 6 days, then moves to failed. Subscribe to order_updated or poll:

2023-01-01

import Ivy from '@getivy/node-sdk'

const client = new Ivy()
const order = await client.orders.retrieve({ id: 'your-internal-reference' })

POST /api/service/order/details in the API Reference →

Payments received with the wrong amount or reference are auto-returned. Instruct the customer to copy details exactly.

See Status flow for the full lifecycle and Webhooks for setup.

Basics

Accounts

Payments

Conversions

Loans

Legacy (2023-01-01)

Flow

Create an order

Display the payment details

Track the order

​Flow

​Create an order

​Display the payment details

​Track the order

Flow

Create an order

Display the payment details

Track the order