Update merchant bank details for receiving payouts.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

id

string <uuid>

required

Merchant ID (UUID)

Body Params application/json

sortCode

string

required

accountNumber

string

required

accountHolderDetails

object

required

name

string

required

type

enum<string>

required

Allowed values:

individualcompany

Example

{
  "sortCode": "108800",
  "accountNumber": "00012345",
  "accountHolderDetails": {
    "name": "Sweet Shop Consortium Ltd",
    "type": "company"
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api.lopay.com/api/1/partner/merchant//bank-details' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sortCode": "108800",
    "accountNumber": "00012345",
    "accountHolderDetails": {
        "name": "Sweet Shop Consortium Ltd",
        "type": "company"
    }
}'

Responses

🟢200OK

application/json

OK response

Body

id

string <uuid>

required

Lopay unique identifier for merchant.

legalBusinessName

string

required

The legal business name for the entity. This is the name that appears within Companies House.

tradingName

string

required

The name used by a business to operate. This can differ from the legal business name.

country

enum<string>

required

Allowed values:

ATBEBGCACYCZDEDKEEESFIJEKWGRHRHUIEIMITLTLULVMTNLPOPTROSESISKGBUSGGGGY

owner

object

required

firstName

string

required

lastName

string

required

email

string <email> | null

optional

phoneNumber

string | null

optional

capabilities

object

required

paymentLinksEnabled

boolean

required

Once the merchant has completed the KYB process
and no other restrictions have been placed on their account, this value
will be set to true and then the merchant can start taking payments.

foreignCardsEnabled

boolean

required

By default, only cards from the same geography as the merchant
can be accepted. For example, a UK merchant can only accept UK cards. This is a
fraud protection mechanism. If the merchant needs to accept foreign cards, please
reach out to Lopay (support@lopay.com) to enable this feature.

payoutSchedule

object | null

optional

accountType

enum<string>

required

Please see https://lopay.com/pricing for differences in account types.

Allowed values:

essentialstandardinstantToBank

config

optional

paused

boolean

required

bankDetails

object | null

optional

sortCode

string

required

accountNumber

string

required

accountHolderDetails

object

required

createdAt

string

required

updatedAt

string

required

Example

{
  "id": "0d05445e-5283-4d63-b33d-185df8259415",
  "legalBusinessName": "Sweet Shop Consortium Ltd",
  "tradingName": "Pam's Sweet Shop",
  "country": "GB",
  "owner": {
    "firstName": "Pam",
    "lastName": "Sweeney",
    "email": "pam@sweetshopconsortium.co.uk",
    "phoneNumber": "+447927987641"
  },
  "capabilities": {
    "paymentLinksEnabled": true,
    "foreignCardsEnabled": false
  },
  "payoutSchedule": {
    "accountType": "essential",
    "config": {
      "type": "monthly",
      "monthlyAnchor": 1
    },
    "paused": false
  },
  "bankDetails": {
    "sortCode": "****00",
    "accountNumber": "****2345",
    "accountHolderDetails": {
      "name": "Sweet Shop Consortium Ltd",
      "type": "company"
    }
  },
  "createdAt": "2025-03-03T16:26:28.192Z",
  "updatedAt": "2025-03-03T16:26:28.192Z"
}

🟠400Bad Request

🟠401Unauthorized