• Register

Bank

This API is used to synchronise bank master data — bank details and the related address — from the Stibo STEP MDM system into the target SAP system.

Request URI

Status codes:

Status codeMeaning
SRecord processed successfully
ERecord processed with errors

Request Structure

API field Type Mandatory Description Technical Details
BankRequestElement (0..∞)
STIBOBankID String N Stibo STEP bank identifier. Nillable
bankCountry String N Bank country key (ISO). Nillable
bankInternalId String N Bank key / internal ID within the country. Nillable
longBankName String N Bank name. Nillable
longBankBranch String N Bank branch name. Nillable
swiftCode String N SWIFT / BIC code. Nillable
bankNetworkGrouping String N Bank network grouping. Nillable
isMarkedForDeletion Boolean N Deletion flag. Nillable
bankNumber String N Bank number. Nillable
bankCategory String N Bank category. Nillable
bankAddress
bankCountry String N Bank country key (ISO). Nillable
bankInternalId String N Bank key / internal ID within the country. Nillable
streetName String N Street name. Nillable
houseNumber String N House number. Nillable
houseNumberSupplementText String N House Number Supplement Text Nillable
cityName String N City. Nillable
postalCode String N Postal code. Nillable
country String N Country key (ISO). Nillable
region String N Region / state. Nillable
correspondenceLanguage String N Correspondence language. Nillable
districtName String N District Name Nillable
villageName String N Village Name Nillable
companyPostalCode String N Company Postal Code Nillable
streetAddrNonDeliverableReason String N Street Address Non Deliverable Reason Nillable
streetPrefixName1 String N Street Prefix Name 1 Nillable
streetPrefixName2 String N Street Prefix Name 2 Nillable
streetSuffixName1 String N Street Suffix Name 1 Nillable
streetSuffixName2 String N Street Suffix Name 2 Nillable
building String N Building Nillable
floor String N Floor Nillable
roomNumber String N Room Number Nillable
formOfAddress String N Form Of Address Nillable
taxJurisdiction String N Tax Jurisdiction Nillable
transportZone String N Transport Zone Nillable
poBox String N PO Box Nillable
poBoxAddrNonDeliverableReason String N PO Box Address Non Deliverable Reason Nillable
poBoxIsWithoutNumber Boolean N PO Box Is Without Number Nillable
poBoxPostalCode String N PO Box Postal Code Nillable
poBoxLobbyName String N PO Box Lobby Name Nillable
poBoxDeviatingCityName String N PO Box Deviating City Name Nillable
poBoxDeviatingRegion String N PO Box Deviating Region Nillable
poBoxDeviatingCountry String N PO Box Deviating Country Nillable
careOfName String N Care Of Name Nillable
deliveryServiceTypeCode String N Delivery Service Type Code Nillable
deliveryServiceNumber String N Delivery Service Number Nillable
addressTimeZone String N Address Time Zone Nillable
secondaryRegionName String N Secondary Region Name Nillable
tertiaryRegionName String N Tertiary Region Name Nillable
bank String N Bank Nillable
bankAddress/bankScriptVariant (0..∞)
addressRepresentationCode String N Address Representation Code Nillable
longBankName String N Bank name. Nillable
longBankBranch String N Bank branch name. Nillable
streetName String N Street name. Nillable
houseNumber String N House number. Nillable
houseNumberSupplementText String N House Number Supplement Text Nillable
cityName String N City. Nillable
districtName String N District Name Nillable
villageName String N Village Name Nillable
streetPrefixName1 String N Street Prefix Name 1 Nillable
streetPrefixName2 String N Street Prefix Name 2 Nillable
streetSuffixName1 String N Street Suffix Name 1 Nillable
streetSuffixName2 String N Street Suffix Name 2 Nillable
building String N Building Nillable
floor String N Floor Nillable
roomNumber String N Room Number Nillable
formOfAddress String N Form Of Address Nillable
poBoxLobbyName String N PO Box Lobby Name Nillable
poBoxDeviatingCityName String N PO Box Deviating City Name Nillable
careOfName String N Care Of Name Nillable
secondaryRegionName String N Secondary Region Name Nillable
tertiaryRegionName String N Tertiary Region Name Nillable
bank String N Bank Nillable
bankAddress String N Bank Address Nillable

Request sample

Sample request

Response Structure

API field Type Description
CommonResponseElement
STIBOBankID String Stibo STEP bank identifier, echoed from the request (bank scenarios).
statusCode String Outcome of the record: "S" = success, "E" = error.
errorMessage String Error detail when the record could not be processed; empty on success.
message String Human-readable outcome message.

Response Examples

1) Success scenarios:

HTTP Status code 200 — record(s) successfully processed

2) Error scenarios:

HTTP Status code 500 — record processed with errors

HTTP Status code 400 — invalid request

version 8 as of 2 weeks ago by Stefano.Gallo

0 Comments

Please sign in to post a comment.

Docs Navigation