REST API for Oracle Banking Virtual Account Management

Get all valid bic directorys

get

/service/bicdirectorys

This endpoint is used to get all valid bic directorys maintenance records.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authStat(optional): string
bankAddress1(optional): string
bankName(optional): string
beIndicator(optional): string
bicCode(optional): string
checkerId(optional): string
customerNo(optional): string
includecloseandunauth(optional): boolean

includecloseandunauth need to be set to fetch summary record, defult value is false
limit(optional): integer

limit is maximum no of records to be fetched
makerId(optional): string
offset(optional): integer

offset is starting no of records to be fetched
recordStat(optional): string
relationship(optional): string
skArrangement(optional): string
sourceCode(optional): string

Response

Supported Media Types

application/json
text/csv
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

Root Schema : BICDirectorysCollection

Type: object

Collection of bicdirectory.

Show Source

data(optional): array data
paging(optional): object PagingDto

{
    "description":"Collection of bicdirectory.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BICDirectoryServiceDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object BICDirectoryServiceDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BICDirectoryServiceDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : BICDirectoryServiceDTO

Type: object

Match All

Show Source

allOf GenericDto
object BICDirectoryServiceDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "bicCode":{
                    "type":"string",
                    "description":"BIC Code or Bank Code",
                    "pattern":"[A-Za-z0-9_*-]+"
                },
                "bankName":{
                    "type":"string",
                    "description":"Name of the Bank",
                    "minLength":1,
                    "maxLength":35
                },
                "customerNo":{
                    "type":"string",
                    "description":"If the bank is a customer of your bank, you can select the Customer No assigned to the bank"
                },
                "skArrangement":{
                    "type":"string",
                    "description":"Indicate whether a SK arrangement exists between your bank and the BIC entity",
                    "pattern":"[Y,N]"
                },
                "bankAddress1":{
                    "type":"string",
                    "description":"Bank Address Line 1",
                    "minLength":0,
                    "maxLength":35
                },
                "bankAddress2":{
                    "type":"string",
                    "description":"Bank Address Line 2",
                    "minLength":0,
                    "maxLength":35
                },
                "bankAddress3":{
                    "type":"string",
                    "description":"Bank Address Line 3",
                    "minLength":0,
                    "maxLength":90
                },
                "relationship":{
                    "type":"string",
                    "description":"the kind of relationship that exists between your bank and the BIC entity. Options are N - No, K - Keys, M - Mail",
                    "pattern":"[N,K,M]"
                },
                "swiftKey":{
                    "type":"string",
                    "description":"If a SWIFT connectivity exists between your bank and the bank for which BIC details are maintained, relationship should be selected as Keys and SWIFT Key should be specified",
                    "minLength":0,
                    "maxLength":50
                },
                "telexKey":{
                    "type":"string",
                    "description":"If a Telex connectivity exists between your bank and the bank for which BIC details are maintained, relationship should be selected as Keys and Telex Key should be specified",
                    "minLength":0,
                    "maxLength":50
                },
                "uploadFlag":{
                    "type":"string",
                    "description":""
                },
                "uploadUpdate":{
                    "type":"string",
                    "description":"Indicates whether update is required during upload",
                    "pattern":"[Y,N]"
                },
                "genMt103":{
                    "type":"string",
                    "description":"",
                    "pattern":"[Y,N]"
                },
                "blacklisted":{
                    "type":"string",
                    "description":"Indicates that the BIC entity is also black listed",
                    "pattern":"[Y,N]"
                },
                "cugMember":{
                    "type":"string",
                    "description":"Indicates that the BIC entity is a Closed User Group member",
                    "pattern":"[Y,N]"
                },
                "genMt103p":{
                    "type":"string",
                    "description":"",
                    "pattern":"[Y,N]"
                },
                "multiCustTransfer":{
                    "type":"string",
                    "description":"Indicate whether or not a Multi Credit Transfer Feature [MT102 support] exists between your bank and the BIC entity",
                    "pattern":"[Y,N]"
                },
                "maxSize":{
                    "type":"number",
                    "description":"Indicate the maximum size in bytes, agreed upon between the two parties for transmitting a MT102 message. A null value in this field signifies that there is no limit set on the size of the message",
                    "pattern":"([0-9]+)?"
                },
                "remitMember":{
                    "type":"string",
                    "description":"Indicates that the customer is registered with MT 103 Extended Remittance Information Multi User Group",
                    "pattern":"[Y,N]"
                },
                "subTypeCode":{
                    "type":"string",
                    "description":"Select the appropriate sub-type code to be mapped to the BIC"
                },
                "genMt102p":{
                    "type":"string",
                    "description":"Check this box to process MT102+ messages. Selecting this check box also required the ?Multi Customer Credit Transfer? checkbox to be selected",
                    "pattern":"[Y,N]"
                },
                "genMt101":{
                    "type":"string",
                    "description":"Indicates whether an MT101 can be sent/received from this BIC. Select this option to generate MT101 message",
                    "pattern":"[Y,N]"
                },
                "transactionPerMsg":{
                    "type":"number",
                    "description":"Indicate the no of transactions to be included in an MT101 message. If you do not specify a value it will be defaulted to 10",
                    "pattern":"([0-9]+)?"
                },
                "adbMember":{
                    "type":"string",
                    "description":"Select a value to indicate membership of the specified BIC code in Asian Development Bank. Options are Y - Yes, N - No, X - Not Applicable",
                    "pattern":"[Y,N,X]"
                },
                "beIndicator":{
                    "type":"string",
                    "description":"Identifies whether the BEI status for the chosen sub-type code is Yes or No",
                    "pattern":"[Y,N]"
                }
            },
            "required":[
                "bicCode",
                "bankName"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]

Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : BICDirectoryServiceDTO-allOf[1]

Type: object

Show Source

adbMember(optional): string

Pattern: [Y,N,X]

Select a value to indicate membership of the specified BIC code in Asian Development Bank. Options are Y - Yes, N - No, X - Not Applicable
bankAddress1(optional): string

Minimum Length: 0

Maximum Length: 35

Bank Address Line 1
bankAddress2(optional): string

Minimum Length: 0

Maximum Length: 35

Bank Address Line 2
bankAddress3(optional): string

Minimum Length: 0

Maximum Length: 90

Bank Address Line 3
bankName: string

Minimum Length: 1

Maximum Length: 35

Name of the Bank
beIndicator(optional): string

Pattern: [Y,N]

Identifies whether the BEI status for the chosen sub-type code is Yes or No
bicCode: string

Pattern: [A-Za-z0-9_*-]+

BIC Code or Bank Code
blacklisted(optional): string

Pattern: [Y,N]

Indicates that the BIC entity is also black listed
cugMember(optional): string

Pattern: [Y,N]

Indicates that the BIC entity is a Closed User Group member
customerNo(optional): string

If the bank is a customer of your bank, you can select the Customer No assigned to the bank
genMt101(optional): string

Pattern: [Y,N]

Indicates whether an MT101 can be sent/received from this BIC. Select this option to generate MT101 message
genMt102p(optional): string

Pattern: [Y,N]

Check this box to process MT102+ messages. Selecting this check box also required the ?Multi Customer Credit Transfer? checkbox to be selected
genMt103(optional): string

Pattern: [Y,N]
genMt103p(optional): string

Pattern: [Y,N]
maxSize(optional): number

Pattern: ([0-9]+)?

Indicate the maximum size in bytes, agreed upon between the two parties for transmitting a MT102 message. A null value in this field signifies that there is no limit set on the size of the message
multiCustTransfer(optional): string

Pattern: [Y,N]

Indicate whether or not a Multi Credit Transfer Feature [MT102 support] exists between your bank and the BIC entity
relationship(optional): string

Pattern: [N,K,M]

the kind of relationship that exists between your bank and the BIC entity. Options are N - No, K - Keys, M - Mail
remitMember(optional): string

Pattern: [Y,N]

Indicates that the customer is registered with MT 103 Extended Remittance Information Multi User Group
skArrangement(optional): string

Pattern: [Y,N]

Indicate whether a SK arrangement exists between your bank and the BIC entity
subTypeCode(optional): string

Select the appropriate sub-type code to be mapped to the BIC
swiftKey(optional): string

Minimum Length: 0

Maximum Length: 50

If a SWIFT connectivity exists between your bank and the bank for which BIC details are maintained, relationship should be selected as Keys and SWIFT Key should be specified
telexKey(optional): string

Minimum Length: 0

Maximum Length: 50

If a Telex connectivity exists between your bank and the bank for which BIC details are maintained, relationship should be selected as Keys and Telex Key should be specified
transactionPerMsg(optional): number

Pattern: ([0-9]+)?

Indicate the no of transactions to be included in an MT101 message. If you do not specify a value it will be defaulted to 10
uploadFlag(optional): string
uploadUpdate(optional): string

Pattern: [Y,N]

Indicates whether update is required during upload

{
    "type":"object",
    "properties":{
        "bicCode":{
            "type":"string",
            "description":"BIC Code or Bank Code",
            "pattern":"[A-Za-z0-9_*-]+"
        },
        "bankName":{
            "type":"string",
            "description":"Name of the Bank",
            "minLength":1,
            "maxLength":35
        },
        "customerNo":{
            "type":"string",
            "description":"If the bank is a customer of your bank, you can select the Customer No assigned to the bank"
        },
        "skArrangement":{
            "type":"string",
            "description":"Indicate whether a SK arrangement exists between your bank and the BIC entity",
            "pattern":"[Y,N]"
        },
        "bankAddress1":{
            "type":"string",
            "description":"Bank Address Line 1",
            "minLength":0,
            "maxLength":35
        },
        "bankAddress2":{
            "type":"string",
            "description":"Bank Address Line 2",
            "minLength":0,
            "maxLength":35
        },
        "bankAddress3":{
            "type":"string",
            "description":"Bank Address Line 3",
            "minLength":0,
            "maxLength":90
        },
        "relationship":{
            "type":"string",
            "description":"the kind of relationship that exists between your bank and the BIC entity. Options are N - No, K - Keys, M - Mail",
            "pattern":"[N,K,M]"
        },
        "swiftKey":{
            "type":"string",
            "description":"If a SWIFT connectivity exists between your bank and the bank for which BIC details are maintained, relationship should be selected as Keys and SWIFT Key should be specified",
            "minLength":0,
            "maxLength":50
        },
        "telexKey":{
            "type":"string",
            "description":"If a Telex connectivity exists between your bank and the bank for which BIC details are maintained, relationship should be selected as Keys and Telex Key should be specified",
            "minLength":0,
            "maxLength":50
        },
        "uploadFlag":{
            "type":"string",
            "description":""
        },
        "uploadUpdate":{
            "type":"string",
            "description":"Indicates whether update is required during upload",
            "pattern":"[Y,N]"
        },
        "genMt103":{
            "type":"string",
            "description":"",
            "pattern":"[Y,N]"
        },
        "blacklisted":{
            "type":"string",
            "description":"Indicates that the BIC entity is also black listed",
            "pattern":"[Y,N]"
        },
        "cugMember":{
            "type":"string",
            "description":"Indicates that the BIC entity is a Closed User Group member",
            "pattern":"[Y,N]"
        },
        "genMt103p":{
            "type":"string",
            "description":"",
            "pattern":"[Y,N]"
        },
        "multiCustTransfer":{
            "type":"string",
            "description":"Indicate whether or not a Multi Credit Transfer Feature [MT102 support] exists between your bank and the BIC entity",
            "pattern":"[Y,N]"
        },
        "maxSize":{
            "type":"number",
            "description":"Indicate the maximum size in bytes, agreed upon between the two parties for transmitting a MT102 message. A null value in this field signifies that there is no limit set on the size of the message",
            "pattern":"([0-9]+)?"
        },
        "remitMember":{
            "type":"string",
            "description":"Indicates that the customer is registered with MT 103 Extended Remittance Information Multi User Group",
            "pattern":"[Y,N]"
        },
        "subTypeCode":{
            "type":"string",
            "description":"Select the appropriate sub-type code to be mapped to the BIC"
        },
        "genMt102p":{
            "type":"string",
            "description":"Check this box to process MT102+ messages. Selecting this check box also required the ?Multi Customer Credit Transfer? checkbox to be selected",
            "pattern":"[Y,N]"
        },
        "genMt101":{
            "type":"string",
            "description":"Indicates whether an MT101 can be sent/received from this BIC. Select this option to generate MT101 message",
            "pattern":"[Y,N]"
        },
        "transactionPerMsg":{
            "type":"number",
            "description":"Indicate the no of transactions to be included in an MT101 message. If you do not specify a value it will be defaulted to 10",
            "pattern":"([0-9]+)?"
        },
        "adbMember":{
            "type":"string",
            "description":"Select a value to indicate membership of the specified BIC code in Asian Development Bank. Options are Y - Yes, N - No, X - Not Applicable",
            "pattern":"[Y,N,X]"
        },
        "beIndicator":{
            "type":"string",
            "description":"Identifies whether the BEI status for the chosen sub-type code is Yes or No",
            "pattern":"[Y,N]"
        }
    },
    "required":[
        "bicCode",
        "bankName"
    ]
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error