swift-bic-banks

Operations addressed under /swift-bic-banks — 11 operations.

get-swift-bICBank-list

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<SwiftBICBankDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BICCode`	`string`	no
`BankCode`	`string`	no
`CountryCode`	`string`	no
`LocationCode`	`string`	no
`BranchCode`	`string`	no
`BankName`	`string`	no
`BranchName`	`string`	no
`AddressCity`	`string`	no
`Address`	`string`	no
`AddressCountryCode`	`string`	no
`AddressCountryName`	`string`	no
`IsActive`	`bool`	no
`ApiUpdateDate`	`DateTime`	no
`BankAccountNumber`	`string`	no
`BankIBAN`	`string`	no
`BankCustomerId`	`object`	no
`Correspondents`	`List<SwiftBICBankCorrespondentDto>` (collection)	no

Member names are the service's declaration names.

get-swift-bICBank-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-swift-bICBank-list › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

create-swift-bICBank

POST

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`Guid`	no

Member names are the service's declaration names.

create-swift-bICBank › Request Body

address

string · required

addressCity

string · required

addressCountryCode

required

addressCountryName

string · required

bICCode

string · required

bankCode

required

bankName

string · required

branchCode

required

branchName

string · required

object[] · required

countryCode

string · required

isActive

boolean · required

locationCode

string · required

create-swift-bICBank › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/swift-bic-banks

curl https://dg-sandbox.dgpays.com/foreign-trade-service/swift-bic-banks \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "",
  "addressCity": "",
  "addressCountryCode": "",
  "addressCountryName": "",
  "bICCode": "",
  "bankCode": "",
  "bankName": "",
  "branchCode": "",
  "branchName": "",
  "correspondents": [
    {
      "apiUpdateDate": "",
      "bICCode": "",
      "correspondenceType": "",
      "correspondentBankBICCode": "",
      "currency": "",
      "isActive": false
    }
  ],
  "countryCode": "",
  "isActive": false,
  "locationCode": ""
}'

Example Request Body

{
  "address": "",
  "addressCity": "",
  "addressCountryCode": "",
  "addressCountryName": "",
  "bICCode": "",
  "bankCode": "",
  "bankName": "",
  "branchCode": "",
  "branchName": "",
  "correspondents": [
    {
      "apiUpdateDate": "",
      "bICCode": "",
      "correspondenceType": "",
      "correspondentBankBICCode": "",
      "currency": "",
      "isActive": false
    }
  ],
  "countryCode": "",
  "isActive": false,
  "locationCode": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-swift-bank-name-by-bank-code

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/by-bank-code/{bankCode}/name

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

get-swift-bank-name-by-bank-code › path Parameters

bankCode

integer · int32 · required

get-swift-bank-name-by-bank-code › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

get-swift-bICBank-by-code

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/by-bic-code/{bICCode}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as SwiftBICBankDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BICCode`	`string`	no
`BankCode`	`string`	no
`CountryCode`	`string`	no
`LocationCode`	`string`	no
`BranchCode`	`string`	no
`BankName`	`string`	no
`BranchName`	`string`	no
`AddressCity`	`string`	no
`Address`	`string`	no
`AddressCountryCode`	`string`	no
`AddressCountryName`	`string`	no
`IsActive`	`bool`	no
`ApiUpdateDate`	`DateTime`	no
`BankAccountNumber`	`string`	no
`BankIBAN`	`string`	no
`BankCustomerId`	`object`	no
`Correspondents`	`List<SwiftBICBankCorrespondentDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_9`	400	`ITEM_DOES_NOT_EXISTS`

get-swift-bICBank-by-code › path Parameters

bICCode

string · required

get-swift-bICBank-by-code › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-swift-bICBank-name-by-code

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/by-bic-code/{bICCode}/name

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route returns string, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_9`	400	`ITEM_DOES_NOT_EXISTS`

get-swift-bICBank-name-by-code › path Parameters

bICCode

string · required

get-swift-bICBank-name-by-code › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.

No data returned

get-swift-bic-banks-get-branch-name-by-branch-code

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/by-branch-code/{branchCode}/name

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_9`	400	`ITEM_DOES_NOT_EXISTS`

get-swift-bic-banks-get-branch-name-by-branch-code › path Parameters

branchCode

string · required

get-swift-bic-banks-get-branch-name-by-branch-code › Responses

No data returned

get-swift-bICBank-by-iban

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/by-iban/{iBan}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as SwiftBICBankDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BICCode`	`string`	no
`BankCode`	`string`	no
`CountryCode`	`string`	no
`LocationCode`	`string`	no
`BranchCode`	`string`	no
`BankName`	`string`	no
`BranchName`	`string`	no
`AddressCity`	`string`	no
`Address`	`string`	no
`AddressCountryCode`	`string`	no
`AddressCountryName`	`string`	no
`IsActive`	`bool`	no
`ApiUpdateDate`	`DateTime`	no
`BankAccountNumber`	`string`	no
`BankIBAN`	`string`	no
`BankCustomerId`	`object`	no
`Correspondents`	`List<SwiftBICBankCorrespondentDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_14`	400	`INVALID_IBAN_NUMBER`

get-swift-bICBank-by-iban › path Parameters

iBan

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

get-swift-bICBank-by-iban › query Parameters

iban

string

get-swift-bICBank-by-iban › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-swift-bICBank-by-id

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/by-id/{id}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as SwiftBICBankDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BICCode`	`string`	no
`BankCode`	`string`	no
`CountryCode`	`string`	no
`LocationCode`	`string`	no
`BranchCode`	`string`	no
`BankName`	`string`	no
`BranchName`	`string`	no
`AddressCity`	`string`	no
`Address`	`string`	no
`AddressCountryCode`	`string`	no
`AddressCountryName`	`string`	no
`IsActive`	`bool`	no
`ApiUpdateDate`	`DateTime`	no
`BankAccountNumber`	`string`	no
`BankIBAN`	`string`	no
`BankCustomerId`	`object`	no
`Correspondents`	`List<SwiftBICBankCorrespondentDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_TRD_9`	400	`ITEM_DOES_NOT_EXISTS`

get-swift-bICBank-by-id › path Parameters

id

string · uuid · required

get-swift-bICBank-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

get-swift-bICBank-correspondent

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/correspondents

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<SwiftBICBankCorrespondentDto>.

Field	Declared type	Nullable
`BICCode`	`string`	no
`BankName`	`string`	no
`CorrespondentBankBICCode`	`string`	no
`Currency`	`string`	no
`CorrespondenceType`	`string`	no
`IsActive`	`bool`	no
`ApiUpdateDate`	`DateTime`	no
`BankAccountNumber`	`string`	no
`BankIBAN`	`string`	no

Member names are the service's declaration names.

get-swift-bICBank-correspondent › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-swift-bICBank-correspondent › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

get-swift-bICBank

GET

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/{bICCode}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as SwiftBICBankDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BICCode`	`string`	no
`BankCode`	`string`	no
`CountryCode`	`string`	no
`LocationCode`	`string`	no
`BranchCode`	`string`	no
`BankName`	`string`	no
`BranchName`	`string`	no
`AddressCity`	`string`	no
`Address`	`string`	no
`AddressCountryCode`	`string`	no
`AddressCountryName`	`string`	no
`IsActive`	`bool`	no
`ApiUpdateDate`	`DateTime`	no
`BankAccountNumber`	`string`	no
`BankIBAN`	`string`	no
`BankCustomerId`	`object`	no
`Correspondents`	`List<SwiftBICBankCorrespondentDto>` (collection)	no

Member names are the service's declaration names.

get-swift-bICBank › path Parameters

bICCode

string · required

get-swift-bICBank › query Parameters

accountNumber

currency

string

get-swift-bICBank › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-swift-bICBank

PUT

https://dg-sandbox.dgpays.com/foreign-trade-service

/swift-bic-banks/{bICCode}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_FRGN_67`	400	`SWIFT_ALMANAC_BIC_CODE_NOT_FOUND`

update-swift-bICBank › path Parameters

bICCode

string · required

update-swift-bICBank › Request Body

address

string · required

addressCity

string · required

addressCountryCode

required

addressCountryName

string · required

bankCode

required

bankName

string · required

branchCode

required

branchName

string · required

object[] · required

countryCode

string · required

isActive

boolean · required

locationCode

string · required

update-swift-bICBank › Responses

No data returned

PUT/swift-bic-banks/{bICCode}

curl https://dg-sandbox.dgpays.com/foreign-trade-service/swift-bic-banks/:bICCode \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "address": "",
  "addressCity": "",
  "addressCountryCode": "",
  "addressCountryName": "",
  "bankCode": "",
  "bankName": "",
  "branchCode": "",
  "branchName": "",
  "correspondents": [
    {
      "apiUpdateDate": "",
      "bICCode": "",
      "correspondenceType": "",
      "correspondentBankBICCode": "",
      "currency": "",
      "isActive": false
    }
  ],
  "countryCode": "",
  "isActive": false,
  "locationCode": ""
}'

Example Request Body

{
  "address": "",
  "addressCity": "",
  "addressCountryCode": "",
  "addressCountryName": "",
  "bankCode": "",
  "bankName": "",
  "branchCode": "",
  "branchName": "",
  "correspondents": [
    {
      "apiUpdateDate": "",
      "bICCode": "",
      "correspondenceType": "",
      "correspondentBankBICCode": "",
      "currency": "",
      "isActive": false
    }
  ],
  "countryCode": "",
  "isActive": false,
  "locationCode": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

reference-numbers swift-incomings