Counterparties Bank Account Details

GET /api/v1/Counterparties/accounts/:id

Description

This endpoint is used to retrieve a specific bank account for a counterparty.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

• id: string, required

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/accounts/1234567890

Response:

• A CounterpartyBankAccountResponseResponse object containing the bank account details.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/accounts/1234567890

Response:

HTTP/1.1 200 OK
{
  "id": "0987654321",
  "accountNumber": "1234567890",
  "accountType": "Checking",
  "bankName": "Bank B",
  "branchCode": "54321",
  "countryCode": "US",
  "currencyCode": "USD",
  "accountHolderName": "Jane Doe"
}

Method: GET

/api/v1/Counterparties/accounts/:id

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "id": "<uuid>",
    "merchantId": "<uuid>",
    "counterpartyId": "<uuid>",
    "account": 4,
    "counterpartyType": 2,
    "accountType": 2,
    "bankCode": "<string>",
    "bankName": "<string>",
    "accountNumber": "<string>",
    "accountName": "<string>",
    "iban": "<string>",
    "swiftCode": "<string>",
    "bankAddress": "<string>",
    "routingNumber": "<string>"
  }
}