Learning Central

Client Services

North America

clientsupport@svb.com
1.800.774.7390 
5:00 AM – 5:30 PM PT M-F

United Kingdom

ukclientservice@svb.com
0800.023.1441 | +44.207.367.7881
8:00 AM – 1:30 AM GMT

SVB PPP Care Team

SVBPPPCare@svb.com
1.833.450.5444
5:00 AM – 5:30 PM PT M-F


Contact the SVB PPP Care Team
for all PPP application questions or
view instructions here.


Bill Pay Classic

1.866.321.6563
4:30 AM PT - 11:00 PM PT M-F

Card Services

Cards Issued in the U.S.

cardservices@svb.com
1.866.553.3481
001.408.654.1039 (international)

Cards Issued in the UK
Support, lost, or stolen

0800.023.1062
+44.0.207.367.7852 (international)

Elite Cards

1.866.940.5920 | 408.654.7720

Lost or Stolen Cards

1.844.274.0771
001.408.654.1039 (international)

FX Trade Desk

North America

1.888.313.4029
IntFXT@svb.com
5:00 AM PT – 4:00 PM PT

United Kingdom

+1.44.0.207.367.7880
ukfxtraders@svb.com
8:00 AM BST – 5:OO PM BST

SVB Asset Management

1.866.719.9117
samoperations@svb.com

SVB Cash Sweep

1.800.774.7390 
clientservice@svb.com

More Support Contacts

Counterparties

The SVB Counterparties API is currently in Beta.

This is the official reference documentation for the SVB Counterparties API. Please see the authentication documentation for access information.

The Counterparties API follows the same conventions as SVB’s other APIs. Please see the documentation on API conventions for more information.

Background 

The Counterparty object represents an entity on the other side of a transaction; this can be a person, business, government, or bank. For example, if you send a wire transfer to a vendor, that vendor is the counterparty for the wire.

Counterparties can be used to simplify an app and make it more secure. The recommended best practice is to store the Counterparty ID and use this ID in API calls instead of storing account credentials.

Counterparties Attributes

Attributes

NAME TYPE DESCRIPTION
id string Uniquely identifies each counterparty object.
account_number string The account number.
account_type enum(checking, savings) The type of account.
address_line1 string Mailing address street.
address_line2 string Mailing address apartment, suite, building, etc.
city string Mailing address city.
state string Mailing address state (if applicable).
country string Mailing address country (ISO 3166-1 alpha-2).
postal_code string Mailing address postal_code.
description string A description of the counterparty.
email_address string The counterparty’s email address.
metadata object Optional metadata to associate with the counterparty.
name string The counterparty’s name.
routing_number string The 9-digit ABA routing number.
wire_routing_number string An alternative routing number if required by the bank.

 

Example Counterparty object:

{
  "id": "123",
  "account_number": "123456789",
  "address_line1": "123 Parrot Street",
  "address_line2": "Apt. 311",
  "city": "San Francisco",
  "state": "CA",
  "country": "US",
  "postal_code": "94105",
  "description": "Important vendor",
  "email_address": "counterparty@svb.com",
  "name": "Counterparty Co.",
  "metadata": {"foo": "bar"},
  "routing_number": "121140399",
  "type": "counterparty",
  "wire_routing_Number": "121145145",
  "url": "/v1/counterparties/123"
}

 

Create a Counterparty

Request:

POST /v1/counterparties

Parameters:

NAME TYPE REQUIRED (?) DESCRIPTION
account_number string R The counterparty’s account number.  Note the combination of account_number, account_type and routing_number will always return the same id
account_type enum(checking, savings) R The type of account.
address_line1 string   Mailing address street.
address_line2 string   Mailing address apartment, suite, etc.
city string   Mailing address city.
state string   Mailing address state (if applicable).
country string   Mailing address country (ISO 3166-1 alpha-2).
postal_code string   Mailing address postal_code.
description string   A description of the counterparty.
email_address string   The counterparty’s email address.
metadata object   Optional metadata to associate with the counterparty.
name string R The counterparty’s name.
routing_number string R The 9-digit ABA routing number.
wire_routing_number string   An alternative routing number if required by the bank.

Response:

200 OK The new counterparty resource.

Example request:

curl "https://api.svb.com/v1/counterparties" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
        "data": {
          "account_number": "123456777",
          "account_type": "checking",
          "address_line1": "789 Party Street",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "postal_code": "94105",
          "description": "Important vendor",
          "email_address": "staff@counterparty.co",
          "name": "Counterparty Co.",
          "routing_number": "121140399"
        }
      }'

Example response:

{
  "data": {
    "id": "123",
    "account_number": "123456777",
    "address_line1": "789 Party Street",
    "address_line2": null,
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105",
    "description": "Important vendor",
    "email_address": "staff@counterparty.co",
    "name": "Counterparty Co.",
    "metadata": null,
    "routing_number": "121140399",
    "type": "counterparty",
    "wire_routing_number": null,
    "url": "/v1/counterparties/123"
  }
}

 

Retrieve a Counterparty

Request:

GET /v1/counterparties/:id

Response:

200 OK The counterparty resource.

Example request:

curl "https://api.svb.com/v1/counterparties/123" \
    -H "Authorization: Bearer YOUR_API_KEY"

Example response:

{
  "data": {
    "id": "123",
    "account_number": "123456789",
    "address_line1": "123 Parrot Street",
    "address_line2": "Apt. 311",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105",
    "description": "Important vendor",
    "email_address": "counterparty@svb.com",
    "name": "Counterparty Co.",
    "metadata": {"foo": "bar"},
    "routing_number": "121140399",
    "type": "counterparty",
    "wire_routing_Number": "121145145",
    "url": "/v1/counterparties/123"
  }
}

 

Update a Counterparty

Request:

PATCH /v1/counterparties/:id

Parameters:

NAME TYPE REQUIRED (?) DESCRIPTION
address_line1 string   Mailing address street.
address_line2 string   Mailing address apartment number, suite, etc.
city string   Mailing address city.
state string   Mailing address state (if applicable).
country string   Mailing address country (ISO 3166-1 alpha-2).
postal_code string   Mailing address postal_code.
description string   A description of the counterparty.
email_address string   The counterparty’s email address.
metadata object   Optional metadata to associate with the counterparty.
name string   The counterparty’s name.
wire_routing_number string   An alternative routing number if required by the bank.

Response:

200 OK The updated counterparty resource.

Example request:

curl "https://api.svb.com/v1/counterparties/123" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -X PATCH \
    -d '{
          "data": {
            "name": "Partycounter Co."
          }
        }'

Example response:

{
  "data": {
    "id": "123",
    "account_number": "123456789",
    "address_line1": "123 Parrot Street",
    "address_line2": "Apt. 311",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "postal_code": "94105",
    "description": "Important vendor",
    "email_address": "counterparty@svb.com",
    "name": "Partycounter Co.",
    "metadata": {"foo": "bar"},
    "routing_number": "121140399",
    "type": "counterparty",
    "wire_routing_Number": "121145145",
    "url": "/v1/counterparties/123"
  }
}

 

List all Counterparties

Request:

GET /v1/counterparties

Response:

200 OK List of counterparty resources.

Example request:

curl "https://api.svb.com/v1/counterparties" \
    -H "Authorization: Bearer YOUR_API_KEY"

Example response:

{
  "data": [
    {
      "id": 123,
      "type": "counterparty",
      "url": "/v1/counterparties/123"
    },
    {
      "id": 122,
      "type": "counterparty",
      "url": "/v1/counterparties/122"
    },
    {
      "id": 121,
      "type": "counterparty",
      "url": "/v1/counterparties/121"
    }
  ],
  "links": {
    "first": "/v1/counterparties",
    "next": null
  }
}