API Explorer

obp.getCounterparties

Get Counterparties

Format March2019 Group Core Suggested order 1

Outbound message (OBP to adapter)
{
  "outboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj",
    "outboundAdapterAuthInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    },
    "outboundAdapterConsenterInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    }
  },
  "thisBankId": {
    "value": ""
  },
  "thisAccountId": {
    "value": ""
  },
  "viewId": {
    "value": "owner"
  }
}
Inbound message (adapter to OBP)
{
  "inboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj"
  },
  "status": {
    "errorCode": "Status errorCode",
    "backendMessages": [
      {
        "source": "",
        "status": "",
        "errorCode": "",
        "text": "",
        "duration": "5.123"
      }
    ]
  },
  "data": [
    {
      "createdByUserId": "",
      "name": "ACCOUNT_MANAGEMENT_FEE",
      "description": "Description of the object. Maximum length is 2000. It can be any characters here.",
      "currency": "EUR",
      "thisBankId": "",
      "thisAccountId": "",
      "thisViewId": "",
      "counterpartyId": "9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "otherAccountRoutingScheme": "IBAN",
      "otherAccountRoutingAddress": "DE89370400440532013000",
      "otherAccountSecondaryRoutingScheme": "",
      "otherAccountSecondaryRoutingAddress": "",
      "otherBankRoutingScheme": "",
      "otherBankRoutingAddress": "",
      "otherBranchRoutingScheme": "",
      "otherBranchRoutingAddress": "",
      "isBeneficiary": false,
      "bespoke": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ]
    }
  ]
}