Skip to main content

​
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.
There are two types of BICs typically associated with the IBAN: SEPA BIC (can be generalized as IBAN BIC for cases when the country is not in SEPA), for example, REVOGB21, and ROUTING BIC, like REVOGB2L.We default to the IBAN BIC in the Enrichment endpoint, unless there’s a linked BIC (ROUTING BIC) for the relevant record in the banking directory that has a better chance of payment success thanks to the explicit mention of the support of the selected currency through correspondents.
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 The settlementSystems array contains standardized codes representing different payment clearing and settlement systems:
CodeCountryNameDescription
SCTSEPA countriesSEPA Credit TransferStandard euro credit transfers within SEPA zone
SCT_INSTSEPA countriesSEPA Instant Credit TransferNear-instant euro credit transfers
SDD_CORESEPA countriesSEPA Direct Debit Core*Consumer direct debit scheme for recurring payments
SDD_B2BSEPA countriesSEPA Direct Debit B2B*Business-to-business direct debit scheme
US_FEDWIREUnited StatesFedwire Funds ServiceReal-time gross settlement system for high-value USD transfers
US_FEDACHUnited StatesAutomated Clearing House System (ACH)*Batch processing system for low-value USD transfers
GB_CHAPSUnited KingdomClearing House Automated Payment System (CHAPS)High-value same-day GBP settlement system
GB_CCCCUnited KingdomCheque and Credit Clearing CompanyPaper-based clearing for cheques and credits
GB_FPSUnited KingdomFaster Payment SystemNear-instant GBP transfers
GB_BACS_CRUnited KingdomBacs Direct CreditBatch processing for GBP credit transfers
GB_BACS_DRUnited KingdomBacs Direct Debit*Batch processing for GBP direct debits
CA_ACSSCanadaAutomated Clearing Settlement System*Settlement of cheques and electronic items, such as pre-authorized debits, direct deposits and Interac debit payments
CA_LYNXCanadaHigh Value Transfer System (Lynx)Real-time settlement for high-value CAD transfers
AU_HVCSAustraliaHigh Value Clearing SystemReal-time settlement for high-value AUD transfers
AU_RITSAustraliaReserve Bank Information and Transfer SystemCentral bank settlement system for interbank transfers
AU_BECSAustraliaBulk Electronic Clearing System*Batch processing for direct debits, direct credits and one-off bank transfers
AU_PCSAustraliaPaper Clearing SystemSettlement of cheques and other paper-based payments
* indicates that direct debit mandates can be set up.
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"
      ]
    }
  }
}