​
Enrich creditor from bank identifier or BIC

You might want to expose additional information about the bank such as bank name, address, and logo.

POST /payments/enrichments

Request
{
  "creditorAgent": {
    "bic": "REVOGB21XXX"
  }
}
Response
{
  "enrichments": {
    "creditorAgent": {
      "name": "REVOLUT LTD",
      "address": {
        "streetName": "WESTFERRY CIRCUS",
        "buildingNumber": "7",
        "buildingName": "THE COLUMBUS BUILDING",
        "floor": "FLOOR 4",
        "postCode": "E14 4HD",
        "townName": "LONDON",
        "countrySubdivision": "GREATER LONDON",
        "country": "GB"
      },
      "bic": "REVOGB21XXX",
      "logo": "https://cdn.paysway.dev/assets/bank-logos/revolut.png"
    },
    "settlementInformation": {
      "settlementSystems": [
        "SCT",
        "SDD_B2B",
        "SDD_CORE"
      ]
    }  
  }
}

​
Enrich creditor from 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"
    }
  }
}