​
Enrich by BIC or bank identifier

You might want to expose additional information about the bank such as bank name, address, and logo. POST /payments/enrichments
Request
{
  "creditorAgent": {
    "bic": "BARCUS33"
  }
}
Response
{
  "enrichments": {
    "creditorAgent": {
      "name": "BARCLAYS BANK PLC",
      "address": {
        "addressLine1": "745 SEVENTH AVENUE",
        "addressLine3": "NEW YORK NY 10019, US",
        "streetName": "SEVENTH AVENUE",
        "buildingNumber": "745",
        "townName": "NEW YORK",
        "postCode": "10019",
        "countrySubdivision": "NEW YORK",
        "country": "US"
      },
      "bic": "BARCUS33XXX",
      "logo": "https://cdn.paysway.dev/assets/bank-logos/barclays.png"
    }
  }
}

​
Enrich by IBAN or account number

You don’t have to populate the BIC when you have the IBAN and rely on enrichment instead. It’s particularly relevant for SEPA transfers and local currency transfers in countries like CZ, DK, NO.
POST /payments/enrichments
Request
{
  "creditorAccount": {
    "id": {
      "value": "PT50002300004569522628094",
      "type": "IBAN"
    }
  }
}
Response
{
  "enrichments": {
    "creditorAgent": {
      "name": "BANCO ACTIVOBANK S.A.",
      "address": {
        "streetName": "RUA AUGUSTA  RC",
        "buildingNumber": "84",
        "postCode": "1100-053",
        "townName": "LISBON",
        "countrySubdivision": "LISBON",
        "country": "PT"
      },
      "bic": "ACTVPTPLXXX",
      "logo": "https://cdn.paysway.dev/assets/bank-logos/ACTVPTPLXXX.png"
    },
    "settlementInformation": {
      "settlementSystems": [
        "SCT",
        "SCT_INST",
        "SDD_CORE"
      ]
    }
  }
}

​
Enrich chain of intermediaries

You can completely avoid asking your users for intermediary BICs and rely on our API instead. Just populate the currency to get the intermediary banks accurately. You should typically indicate the last intermediary BIC (out of 3) in your payment instructions to partners. POST /payments/enrichments
Request
{
  "creditorAgent": {
    "bic": "CHASGB2L"
  },
  "currency": "NZD"
}
Response
{
  "enrichments": {
    "creditorAgent": {
      "name": "JPMORGAN CHASE BANK, N.A.",
      "address": {
        "streetName": "BANK STREET",
        "buildingNumber": "25",
        "postCode": "E14 5JP",
        "townName": "LONDON",
        "townLocationName": "CANARY WHARF",
        "countrySubdivision": "GREATER LONDON",
        "country": "GB"
      },
      "bic": "CHASGB2LXXX"
    },
    "intermediaryAgent1": {
      "bic": "ANZBNZ22XXX"
    }
  }
}

​
Enrich settlement schemes

You can enrich bank identifiers with information about their supported settlement systems. This helps you understand which schemes are available for a specific bank, enabling better routing decisions and user experience. POST /payments/enrichments
Request
{
  "creditorAccount": {
    "id": {
      "value": "ES2102390802941234566789",
      "type": "IBAN"
    }
  }
}
Response
{
  "enrichments": {
    "creditorAgent": {
      "name": "BANKINTER, S.A.",
      "address": {
        "addressLine1": "PASEO DE LA CASTELLANA 29",
        "addressLine3": "MADRID, MADRID, 28046",
        "streetName": "PASEO DE LA CASTELLANA",
        "buildingNumber": "29",
        "townName": "MADRID",
        "postCode": "28046",
        "countrySubdivision": "MADRID",
        "country": "ES"
      },
      "bic": "BKBKESMMXXX",
      "logo": "https://cdn.paysway.dev/assets/bank-logos/BKBKESMMXXX.png"
    },
    "settlementInformation": {
      "settlementSystems": [
        "SDD_CORE",
        "SCT",
        "SDD_B2B",
        "SCT_INST"
      ]
    }
  }
}