Create US Counterparty

This endpoint creates a counterparty for the United States using ACH or Wire transfer protocols.

Authorization:

bearer

HTTP: bearer

HTTP Authorization Scheme: bearer

Headers:
  Authorization: APIKey {YOUR_API_KEY}

Endpoint

POST

/api/v2/banking/counterparties

Request Body Sample

ACH Counterparty

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "US-VENDOR-001",
  "counterpartyName": "John Smith",
  "address": {
    "address1": "123 Main Street",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "accountNumber": "123456789",
  "routingNumber": "021000021",
  "bankName": "Chase Bank",
  "type": "individual",
  "instrumentType": "ach",
  "accountType": "checking",
  "bankAddress": {
    "address1": "270 Park Avenue",
    "city": "New York",
    "state": "NY",
    "postalCode": "10017",
    "country": "US"
  }
}

International Wire Counterparty

{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "INTL-VENDOR-001",
  "counterpartyName": "Global Corp",
  "address": {
    "address1": "10 Downing Street",
    "city": "London",
    "postalCode": "SW1A 2AA",
    "country": "GB"
  },
  "routingNumber": "021000021",
  "swiftCode": "CHASUS33",
  "iban": "GB29NWBK60161331926819",
  "bankName": "National Westminster Bank",
  "type": "business",
  "instrumentType": "wire",
  "wireType": "international",
  "bankAddress": {
    "address1": "250 Bishopsgate",
    "city": "London",
    "postalCode": "EC2M 4AA",
    "country": "GB"
  }
}

Request Body Schema

Field	Type	Description
accountId	string (uuid)	Required. The account ID to associate with this counterparty.
reference	string	Required. A unique user-defined reference. Min 1, max 255 characters.
counterpartyName	string	Required. Counterparty name. Min 2, max 255 characters.
address	object	Required. Counterparty's address.
instrumentType	string	Required. Payment instrument type. Values: ach, wire.
accountType	string	Required when instrumentType is ach. Bank account type. Values: checking, savings.
wireType	string	Required when instrumentType is wire. Values: domestic, international.
accountNumber	string	Bank account number. 4-17 characters. Required for ACH and domestic wire. Required for international wire if iban is not provided.
routingNumber	string	Bank routing number. Exactly 9 characters. Required for all payment types.
swiftCode	string	SWIFT/BIC code. 8-11 characters. Required for international wire.
iban	string	IBAN. 15-34 characters. Required for international wire if accountNumber is not provided.
bankName	string	Required. Bank name. Min 2, max 255 characters.
type	string	Optional. Counterparty type. Values: individual, business.
bankAddress	object	Optional. Bank's address. Same schema as address.

Payment Type Requirements

Type	Required Fields
ACH (instrumentType: "ach")	routingNumber + accountNumber + accountType
Domestic Wire (instrumentType: "wire", wireType: "domestic")	routingNumber + accountNumber
International Wire (instrumentType: "wire", wireType: "international")	routingNumber + swiftCode + (accountNumber or iban)

Response Sample

{
  "id": "00000000-0000-0000-0000-000000000000",
  "accountId": "00000000-0000-0000-0000-000000000000",
  "reference": "US-VENDOR-001",
  "currency": "USD",
  "counterpartyName": "John Smith",
  "address": {
    "address1": "123 Main Street",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "US"
  },
  "accountNumber": "123456789",
  "routingNumber": "021000021",
  "swiftCode": "",
  "iban": "",
  "bankName": "Chase Bank",
  "type": "individual",
  "instrumentType": "ach",
  "accountType": "checking",
  "bankAddress": {
    "address1": "270 Park Avenue",
    "city": "New York",
    "state": "NY",
    "postalCode": "10017",
    "country": "US"
  },
  "status": "active",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}

Support and Resources

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

• Instagram: BlockWyre Instagram
• Twitter: BlockWyre Twitter
• Facebook: BlockWyre Facebook
• LinkedIn: BlockWyre LinkedIn

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!