> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paysway.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Enrich payment
## 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](/api-reference/payment-preparation/enrich-payment-details)
```json Request theme={null}
{
"creditorAgent": {
"bic": "BARCUS33"
}
}
```
```json Response theme={null}
{
"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"
}
}
}
```
```json Request theme={null}
{
"country": "GB",
"creditorAgent": {
"clearingSystemMemberId": {
"memberId": "609242"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "JPMORGAN CHASE BANK, N.A.",
"address": {
"addressLine1": "HAMPSHIRE BUILDING, 1ST FLOOR",
"addressLine2": "CHASESIDE",
"addressLine3": "BOURNEMOUTH, BH7 7DA, DORSET GB",
"department": "EMEA TREASURY SERVICES OPER",
"streetName": "CHASESIDE",
"buildingName": "HAMPSHIRE BUILDING",
"floor": "1ST FLOOR",
"townName": "BOURNEMOUTH",
"postCode": "BH7 7DA",
"countrySubdivision": "DORSET",
"country": "GB"
},
"bic": "CHASGB2LXXX",
"logo": "https://cdn.paysway.dev/assets/bank-logos/GB_609242.png"
},
"settlementInformation": {
"settlementSystems": [
"GB_BACS_CR",
"GB_CCCC",
"GB_BACS_DR",
"GB_CHAPS",
"GB_FPS"
]
}
}
}
```
## 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](/api-reference/payment-preparation/enrich-payment-details)
```json Request theme={null}
{
"creditorAccount": {
"id": {
"value": "PT50002300004569522628094",
"type": "IBAN"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "BANCO ACTIVOBANK, SA",
"address": {
"addressLine1": "RUA AUGUSTA RC 84",
"addressLine3": "LISBON, LISBON, 1100-053",
"streetName": "RUA AUGUSTA RC",
"buildingNumber": "84",
"townName": "LISBON",
"postCode": "1100-053",
"countrySubdivision": "LISBON",
"country": "PT"
},
"bic": "ACTVPTPLXXX",
"logo": "https://cdn.paysway.dev/assets/bank-logos/ACTVPTPLXXX.png"
},
"settlementInformation": {
"settlementSystems": [
"SCT",
"SDD_CORE",
"SCT_INST"
]
}
}
}
```
```json Request theme={null}
{
"country": "HU",
"creditorAccount": {
"id": {
"value": "126000161707899601473248",
"type": "ACCOUNT_NUMBER"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "WISE EUROPE SA",
"address": {
"addressLine1": "TRONE RUE 100",
"addressLine3": "BRUSSELS, BRUXELLES-CAPITALE, 1050",
"streetName": "TRONE RUE",
"buildingNumber": "100",
"townName": "BRUSSELS",
"postCode": "1050",
"countrySubdivision": "BRUXELLES-CAPITALE",
"country": "BE"
},
"bic": "TRWIBEBBXXX",
"logo": "https://cdn.paysway.dev/assets/bank-logos/TRWIBEBBXXX.png"
},
"creditorAccount": {
"ids": [
{
"value": "126000161707899601473248",
"type": "ACCOUNT_NUMBER"
},
{
"value": "HU78126000161707899601473248",
"type": "IBAN"
}
]
}
}
}
```
```json Request theme={null}
{
"country": "SE",
"creditorAccount": {
"id": {
"value": "8937028383339",
"type": "ACCOUNT_NUMBER"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "SWEDBANK AB (PUBL)",
"address": {
"addressLine1": "LANDSVAGEN 40",
"addressLine2": "SUNDBYBERG",
"addressLine3": "STOCKHOLM, STOCKHOLM, 105 34",
"streetName": "LANDSVAGEN",
"buildingNumber": "40",
"townName": "STOCKHOLM",
"townLocationName": "SUNDBYBERG",
"postCode": "105 34",
"countrySubdivision": "STOCKHOLM",
"country": "SE"
},
"bic": "SWEDSESSXXX",
"clearingSystemMemberId": {
"memberId": "89370"
},
"logo": "https://cdn.paysway.dev/assets/bank-logos/swedbank.png"
},
"creditorAccount": {
"ids": [
{
"value": "28383339",
"type": "ACCOUNT_NUMBER"
},
{
"value": "SE9680000893700028383339",
"type": "IBAN"
}
]
}
}
}
```
## 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](/api-reference/payment-preparation/enrich-payment-details)
```json Request theme={null}
{
"creditorAgent": {
"bic": "CHASGB2L"
},
"currency": "NZD"
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "JPMORGAN CHASE BANK, N.A.",
"address": {
"addressLine1": "25 BANK STREET, CANARY WHARF",
"addressLine3": "LONDON, E14 5JP, GREATER LONDON GB",
"streetName": "BANK STREET",
"buildingNumber": "25",
"townName": "LONDON",
"townLocationName": "CANARY WHARF",
"postCode": "E14 5JP",
"countrySubdivision": "GREATER LONDON",
"country": "GB"
},
"bic": "CHASGB2LXXX"
},
"intermediaryAgent1": {
"bic": "ANZBNZ22XXX"
}
}
}
```
```json Request theme={null}
{
"creditorAgent": {
"bic": "MELNUS3P"
},
"currency": "GBP"
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "THE BANK OF NEW YORK MELLON",
"address": {
"addressLine1": "500 GRANT STREET",
"addressLine3": "PITTSBURGH PA 15258, US",
"streetName": "GRANT STREET",
"buildingNumber": "500",
"townName": "PITTSBURGH",
"postCode": "15258",
"countrySubdivision": "PENNSYLVANIA",
"country": "US"
},
"bic": "MELNUS3PXXX"
},
"intermediaryAgent1": {
"bic": "IRVTGB2XXXX"
},
"intermediaryAgent2": {
"bic": "IRVTUS3NXXX"
}
}
}
```
```json Request theme={null}
{
"creditorAgent": {
"bic": "ABKLCY2NLAR"
},
"currency": "AUD"
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "ALPHA BANK CYPRUS LTD",
"address": {
"addressLine1": "28 ARCH MACARIOS III AVENUE",
"addressLine3": "LARNACA, LARNACA, 2324",
"streetName": "ARCH MACARIOS III AVENUE",
"buildingNumber": "28",
"townName": "LARNACA",
"postBox": "POB 343",
"postCode": "2324",
"countrySubdivision": "LARNACA",
"country": "CY"
},
"bic": "ABKLCY2NLAR",
"logo": "https://cdn.paysway.dev/assets/bank-logos/ABKLCY2NXXX.png"
},
"intermediaryAgent1": {
"bic": "ANZBAU3MXXX"
},
"intermediaryAgent2": {
"bic": "CHASDEFXXXX"
},
"intermediaryAgent3": {
"bic": "CRBAGRAAXXX"
}
}
}
```
## 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](/api-reference/payment-preparation/enrich-payment-details)
The `settlementSystems` array contains standardized codes representing different payment clearing and settlement systems:
| Code | Country | Name | Description |
| ---------------- | -------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| **SCT** | SEPA countries | SEPA Credit Transfer | Standard euro credit transfers within SEPA zone |
| **SCT\_INST** | SEPA countries | SEPA Instant Credit Transfer | Near-instant euro credit transfers |
| **SDD\_CORE** | SEPA countries | SEPA Direct Debit Core\* | Consumer direct debit scheme for recurring payments |
| **SDD\_B2B** | SEPA countries | SEPA Direct Debit B2B\* | Business-to-business direct debit scheme |
| **US\_FEDWIRE** | United States | Fedwire Funds Service | Real-time gross settlement system for high-value USD transfers |
| **US\_FEDACH** | United States | Automated Clearing House System (ACH)\* | Batch processing system for low-value USD transfers |
| **GB\_CHAPS** | United Kingdom | Clearing House Automated Payment System (CHAPS) | High-value same-day GBP settlement system |
| **GB\_CCCC** | United Kingdom | Cheque and Credit Clearing Company | Paper-based clearing for cheques and credits |
| **GB\_FPS** | United Kingdom | Faster Payment System | Near-instant GBP transfers |
| **GB\_BACS\_CR** | United Kingdom | Bacs Direct Credit | Batch processing for GBP credit transfers |
| **GB\_BACS\_DR** | United Kingdom | Bacs Direct Debit\* | Batch processing for GBP direct debits |
| **CA\_ACSS** | Canada | Automated Clearing Settlement System\* | Settlement of cheques and electronic items, such as pre-authorized debits, direct deposits and Interac debit payments |
| **CA\_LYNX** | Canada | High Value Transfer System (Lynx) | Real-time settlement for high-value CAD transfers |
| **AU\_HVCS** | Australia | High Value Clearing System | Real-time settlement for high-value AUD transfers |
| **AU\_RITS** | Australia | Reserve Bank Information and Transfer System | Central bank settlement system for interbank transfers |
| **AU\_BECS** | Australia | Bulk Electronic Clearing System\* | Batch processing for direct debits, direct credits and one-off bank transfers |
| **AU\_PCS** | Australia | Paper Clearing System | Settlement of cheques and other paper-based payments |
\* indicates that direct debit mandates can be set up.
```json Request theme={null}
{
"creditorAccount": {
"id": {
"value": "ES2102390802941234566789",
"type": "IBAN"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "BANKINTER SA",
"address": {
"addressLine1": "DON RAMON DE LA CRUZ 84",
"addressLine3": "MADRID, MADRID, 28006",
"department": "BANCA INTERNET",
"streetName": "DON RAMON DE LA CRUZ",
"buildingNumber": "84",
"townName": "MADRID",
"postCode": "28006",
"countrySubdivision": "MADRID",
"country": "ES"
},
"bic": "BKBKESMMXXX",
"logo": "https://cdn.paysway.dev/assets/bank-logos/BKBKESMMXXX.png"
},
"settlementInformation": {
"settlementSystems": [
"SCT",
"SDD_CORE",
"SCT_INST",
"SDD_B2B"
]
}
}
}
```
```json Request theme={null}
{
"country": "US",
"creditorAgent": {
"clearingSystemMemberId": {
"memberId": "021000021"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "JPMORGAN CHASE BANK, NATIONAL ASSOCIATION",
"address": {
"addressLine1": "1111 POLARIS PARKWAY",
"addressLine3": "COLUMBUS OH 43240, US",
"department": "POLARIS PARKWAY",
"streetName": "POLARIS PARKWAY",
"buildingNumber": "1111",
"townName": "COLUMBUS",
"postCode": "43240",
"countrySubdivision": "OHIO",
"country": "US"
},
"bic": "CHASUS33XXX",
"logo": "https://cdn.paysway.dev/assets/bank-logos/US_021000021.png"
},
"settlementInformation": {
"settlementSystems": [
"US_FEDACH",
"US_FEDWIRE"
]
}
}
}
```
```json Request theme={null}
{
"country": "GB",
"creditorAgent": {
"clearingSystemMemberId": {
"memberId": "230505"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "STRIPE PAYMENTS UK LTD",
"address": {
"addressLine1": "THE BOWER, 7TH FLOOR",
"addressLine2": "211 OLD STREET",
"addressLine3": "LONDON, EC1V 9NR, GREATER LONDON GB",
"department": "STRIPE PAYMENTS UK LTD",
"streetName": "OLD STREET",
"buildingNumber": "211",
"buildingName": "THE BOWER",
"floor": "7TH FLOOR",
"townName": "LONDON",
"postCode": "EC1V 9NR",
"countrySubdivision": "GREATER LONDON",
"country": "GB"
},
"bic": "STYAGB2LXXX"
},
"settlementInformation": {
"settlementSystems": [
"GB_BACS_CR",
"GB_FPS"
]
}
}
}
```
```json Request theme={null}
{
"country": "AU",
"creditorAgent": {
"clearingSystemMemberId": {
"memberId": "034134"
}
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "WESTPAC BANKING CORPORATION",
"address": {
"addressLine1": "139 BOAT HARBOUR DRIVE",
"addressLine3": "HERVEY BAY, QUEENSLAND, 4655",
"department": "HERVEY BAY FINANCIAL CENTRE",
"streetName": "BOAT HARBOUR DRIVE",
"buildingNumber": "139",
"townName": "HERVEY BAY",
"postCode": "4655",
"countrySubdivision": "QUEENSLAND",
"country": "AU"
},
"bic": "WPACAU2SXXX"
},
"settlementInformation": {
"settlementSystems": [
"AU_PCS",
"AU_BECS",
"AU_HVCS"
]
}
}
}
```
```json Request theme={null}
{
"country": "CA",
"creditorAgent": {
"clearingSystemMemberId": {
"memberId": "001"
},
"branchId": "07810"
}
}
```
```json Response theme={null}
{
"enrichments": {
"creditorAgent": {
"name": "BANK OF MONTREAL",
"address": {
"addressLine1": "4729 MARINE AVE - POWELL RIVER",
"addressLine2": "BRITISH COLUMBIA, V8A 2L3",
"department": "WESTVIEW",
"streetName": "MARINE AVE",
"buildingNumber": "4729",
"townName": "POWELL RIVER",
"postCode": "V8A 2L3",
"countrySubdivision": "BRITISH COLUMBIA",
"country": "CA"
},
"bic": "BOFMCAM2XXX",
"logo": "https://cdn.paysway.dev/assets/bank-logos/bank_of_montreal.png"
},
"settlementInformation": {
"settlementSystems": [
"CA_ACSS",
"CA_LYNX"
]
}
}
}
```
## Bulk enrichment
If you need to enrich multiple payments at once, use the bulk enrichment endpoint.
Each item in the array follows the exact same schema as [POST /payments/enrichments](/api-reference/payment-preparation/enrich-payment-details).
The response returns enrichment results in the same order as the input.
The maximum number of items per request is **20**.
[**POST** /payments/bulk-enrichments](/api-reference/payment-preparation/bulk-enrich-payment-details)
```json Request theme={null}
{
"items": [
{
"creditorAgent": {
"bic": "BARCUS33"
}
},
{
"creditorAccount": {
"id": {
"value": "PT50002300004569522628094",
"type": "IBAN"
}
}
},
{
"creditorAgent": {
"bic": "CHASGB2L"
},
"currency": "NZD"
}
]
}
```
```json Response theme={null}
{
"items": [
{
"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"
}
}
},
{
"enrichments": {
"creditorAgent": {
"name": "BANCO ACTIVOBANK, SA",
"address": {
"addressLine1": "RUA AUGUSTA RC 84",
"addressLine3": "LISBON, LISBON, 1100-053",
"streetName": "RUA AUGUSTA RC",
"buildingNumber": "84",
"townName": "LISBON",
"postCode": "1100-053",
"countrySubdivision": "LISBON",
"country": "PT"
},
"bic": "ACTVPTPLXXX",
"logo": "https://cdn.paysway.dev/assets/bank-logos/ACTVPTPLXXX.png"
},
"settlementInformation": {
"settlementSystems": [
"SCT",
"SDD_CORE",
"SCT_INST"
]
}
}
},
{
"enrichments": {
"creditorAgent": {
"name": "JPMORGAN CHASE BANK, N.A.",
"address": {
"addressLine1": "25 BANK STREET, CANARY WHARF",
"addressLine3": "LONDON, E14 5JP, GREATER LONDON GB",
"streetName": "BANK STREET",
"buildingNumber": "25",
"townName": "LONDON",
"townLocationName": "CANARY WHARF",
"postCode": "E14 5JP",
"countrySubdivision": "GREATER LONDON",
"country": "GB"
},
"bic": "CHASGB2LXXX"
},
"intermediaryAgent1": {
"bic": "ANZBNZ22XXX"
}
}
}
]
}
```