Skip to main content

1. Check availability

Ask what GBP needs for your account. The answer lists the required fields per customer type and account type.

2. Create the customer

Required for a business: businessName, email. See Virtual account requirements for every combination.
The customer is created with kycStatus incomplete or pending. Anything missing for GBP can be added later with PATCH /customers/{uuid} before you request the account.

3. Request the account

You must have a webhook secret set up first, or the request returns 400 with webhook_secret_required. The response depends on the currency. For GBP, expect requires_action then pending then active: requires_action: The customer has to verify first. Send them nextStep.url.
pending: The account is still being issued or approved. Wait for virtual_account.created.
active: Ready. Show the bank details to your payer.
If the request is rejected straight away you get 422 with the reason in errors[0].reason and no account is created. If it is rejected later you receive virtual_account.failed with a reason. See Webhooks.

4. Show the details to your payer

Show these fields from bankDetails: How your payer sends the money:
  1. Add a new payee in their UK bank with the sort code and account number.
  2. Send by Faster Payments.

5. Receive the payment

When the payment arrives you receive virtual_account.payment.received. Amounts are decimal strings in GBP; destinationAmount is in USD, after any fees.
Verify the signature before you trust it, and use data.transaction.reference to ignore repeats. See Webhooks.

Things to handle

  • GBP accounts are only available to business customers. Requesting one for an individual returns 422 with type_unavailable from the API, and the dashboard marks the currency as not available for that customer.
  • The verification asks for business details, owners and directors, and supporting documents.
  • A payment can be held for review. You receive virtual_account.payment.manual_review with a review.reason, then received or rejected after a decision.
  • GET /virtual-accounts/{uuid} returns the current status at any time, and POST /virtual-accounts/{uuid}/deactivate stops the account accepting payments.