Skip to main content
PATCH
/
clients
/
{id}
/
payment-methods
/
{paymentMethodId}
Update client payment method
curl --request PATCH \
  --url https://api.conduit.financial/clients/{id}/payment-methods/{paymentMethodId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "rail": [],
  "bankName": "<string>",
  "accountOwnerName": "<string>",
  "accountNumber": "<string>",
  "iban": "<string>",
  "pixKey": "<string>",
  "routingNumber": "<string>",
  "swiftCode": "<string>",
  "branchCode": "<string>",
  "bankCode": "<string>",
  "sortCode": "<string>"
}
'
{
  "id": "bank_1234",
  "type": "bank",
  "rail": [
    "fedwire"
  ],
  "bankName": "Bank of America",
  "accountOwnerName": "John Doe",
  "accountNumber": "1234567890",
  "currency": "USD",
  "routingNumber": "1234567890",
  "status": "enabled",
  "address": {
    "streetLine1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  },
  "entity": {
    "id": "cp_1234567890123456789012345",
    "name": "Mark Davis",
    "entityType": "individual",
    "complianceEntityType": "counterparty"
  }
}

Authorizations

​
X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

​
X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Path Parameters

​
id
string
required

A valid Client ID

Pattern: ^client_[a-zA-Z0-9]{27}$
Example:

"client_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
paymentMethodId
required

The ID of the payment method to retrieve

Pattern: ^bank_[a-zA-Z0-9]{27}$
Example:

"bank_2ofTA5mz0T91pBmD3tMTeLE7T4X"

Body

application/json
​
rail
enum<string>[]
Maximum array length: 1
Available options:
ach_colombia,
ach,
pix,
swift,
fedwire,
ted,
spei,
sepa,
pse,
rtgs,
ars_bank_transfer,
fps,
chaps,
fast,
international_wire,
bank_transfer
​
bankName
string
​
accountOwnerName
string
deprecated

DEPRECATED: This field is ignored for counterparties. The counterparty name is automatically used instead.

​
accountType
enum<string>
Available options:
savings,
checking,
electronic_deposit
​
accountNumber
string
​
iban
string
​
pixKey
string
​
routingNumber
string
​
swiftCode
string
​
branchCode
string
​
bankCode
string
​
sortCode
string
​
currency
enum<string>

The asset identifier. A fiat currency code.

Available options:
USD,
MXN,
BRL,
COP,
EUR,
NGN,
ARS,
GBP,
AED,
SGD,
HKD
​
address
object

Response

Payment method updated successfully

​
id
string
required

A valid Bank Account ID

Pattern: ^bank_[a-zA-Z0-9]{27}$
Example:

"bank_2ofTA5mz0T91pBmD3tMTeLE7T4X"

​
type
enum<string>
required
Available options:
bank
​
bankName
string
required
​
currency
enum<string>
required

The asset identifier. A fiat currency code.

Available options:
USD,
MXN,
BRL,
COP,
EUR,
NGN,
ARS,
GBP,
AED,
SGD,
HKD
​
accountOwnerName
string
required
​
status
enum<string>
required
Available options:
enabled,
disabled
​
accountNumber
string
​
iban
string
​
pixKey
string
​
routingNumber
string
​
swiftCode
string
​
branchCode
string
​
bankCode
string
​
sortCode
string
​
accountType
enum<string>
Available options:
savings,
checking,
electronic_deposit
​
address
object
​
rail
enum<string>[]
Available options:
ach_colombia,
ach,
fedwire,
pix,
ted,
sepa,
spei,
swift,
rtgs,
pse,
ars_bank_transfer,
fps,
chaps,
fast,
international_wire,
bank_transfer
​
entity
object