Post paymentsfetch bank details

cURL

curl --request POST \
  --url https://api.dev.ecos.gcservices.io/payments/payment-order/v1/payments/fetch-bank-details \
  --header 'Content-Type: application/json' \
  --data '
{
  "identificationNumber": "12232",
  "identificationType": "ROUTING_NUMBER",
  "bankName": "Bank One",
  "branchCode": "Branch One",
  "country": "US",
  "customFields": {}
}
'

{
  "bankCode": "001",
  "federalReserveDistrict": "Boston",
  "address": {
    "country": "USA",
    "streetName": "1st Street",
    "townName": "New York",
    "phoneNumber": "+1-800-555-1234",
    "countrySubDivision": "Ontario",
    "postalCode": "10001",
    "buildingNumber": "123",
    "subDepartment": "Loan Processing",
    "type": "POSTAL",
    "department": "Retail Banking",
    "addressLine": "Main Office Tower",
    "primary": true
  },
  "serviceSupportType": [
    "CRDT",
    "ACK",
    "RMT"
  ],
  "customFields": {
    "key": "{}"
  },
  "bankName": "US Bank NA",
  "sortCode": "12-34-56",
  "network": [
    "Wire",
    "ACH",
    "FedNow"
  ],
  "branchCode": "Branch One",
  "identification": "123456789",
  "participantName": "Name One",
  "bic": "BOFA",
  "transferSupportType": [
    "ACH",
    "WIRE"
  ],
  "status": "ACTIVE"
}

POST

payments

fetch-bank-details

cURL

curl --request POST \
  --url https://api.dev.ecos.gcservices.io/payments/payment-order/v1/payments/fetch-bank-details \
  --header 'Content-Type: application/json' \
  --data '
{
  "identificationNumber": "12232",
  "identificationType": "ROUTING_NUMBER",
  "bankName": "Bank One",
  "branchCode": "Branch One",
  "country": "US",
  "customFields": {}
}
'

{
  "bankCode": "001",
  "federalReserveDistrict": "Boston",
  "address": {
    "country": "USA",
    "streetName": "1st Street",
    "townName": "New York",
    "phoneNumber": "+1-800-555-1234",
    "countrySubDivision": "Ontario",
    "postalCode": "10001",
    "buildingNumber": "123",
    "subDepartment": "Loan Processing",
    "type": "POSTAL",
    "department": "Retail Banking",
    "addressLine": "Main Office Tower",
    "primary": true
  },
  "serviceSupportType": [
    "CRDT",
    "ACK",
    "RMT"
  ],
  "customFields": {
    "key": "{}"
  },
  "bankName": "US Bank NA",
  "sortCode": "12-34-56",
  "network": [
    "Wire",
    "ACH",
    "FedNow"
  ],
  "branchCode": "Branch One",
  "identification": "123456789",
  "participantName": "Name One",
  "bic": "BOFA",
  "transferSupportType": [
    "ACH",
    "WIRE"
  ],
  "status": "ACTIVE"
}

Headers

Idempotent-Request-Key

string

Idempotent Request Key.

Timestamp

string<date-time>

Timestamp.

Used-Mechanism

string

Type of the payment.

api-key

string

API Key to authorize the api.

Body

application/json

identificationNumber

string

required

Unique identifier for the bank code of which the details are retreived.

Example:

"12232"

identificationType

enum<string>

required

Type of the bank code used to search for the bank's address.

Available options:

ROUTING_NUMBER,

IBAN,

SWIFT_CODE,

BANK_BRANCH_CODE,

BBAN,

OTHERS

bankName

string

Name of the financial institution.

Example:

"Bank One"

branchCode

string

Branch code of the financial institution.

Example:

"Branch One"

country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code)- https://www.iban.com/country-codes.

Example:

"US"

customFields

CustomField · object

Custom fields related to payments.

Show child attributes

customFields.{key}

object

Response

OK.

identification

string

Routing number of the participant.

Example:

"123456789"

bankName

string

Name of the financial institution.

Example:

"US Bank NA"

bankCode

string

Unique identifier of the financial institution.

Example:

"001"

branchCode

string

Branch code of the financial institution.

Example:

"Branch One"

sortCode

string

Unique identifier of the financial institution for routing the payment predominantly used in the UK.

Example:

"12-34-56"

bic

string

Unique identifier of the financial institution.

Example:

"BOFA"

transferSupportType

string[]

Retrieve either the ACH or wire transfer information from the bank. Default value is ACH.

Example:

["ACH", "WIRE"]

serviceSupportType

string[]

Services that are accepted by the financial instituion.

Example:

["CRDT", "ACK", "RMT"]

federalReserveDistrict

string

Any of the twelve unique Federal Reserve that officially identifies Districts by number and Reserve Bank city.

Example:

"Boston"

participantName

string

Name of the RTP Participant.

Example:

"Name One"

network

string[]

Network supportedt.

Example:

["Wire", "ACH", "FedNow"]

status

enum<string>

Status of the financial institution.

Available options:

ACTIVE,

INACTIVE

address

Bank address. · object

Show child attributes

address.type

enum<string>

Information that locates and identifies a specific address.

Available options:

POSTAL,

POBOX,

RESIDENTIAL,

PERMANENT,

TEMPORARY,

BUSINESS

address.primary

boolean

Flag denoting whether this is the primary postal address of the person/party.

Example:

true

address.department

string

Flag denoting whether this is the primary postal address of the person/party.

Example:

"Retail Banking"

address.subDepartment

string

Identification of a sub-division of a large organisation or building. ISO20022

Example:

"Loan Processing"

address.addressLine

string

Information that locates and identifies a specific address, as defined by postal services,presented in free format text. ISO20022

Example:

"Main Office Tower"

address.buildingNumber

string

Number that identifies the position of a building on a street. ISO20022

Example:

"123"

address.streetName

string

Name of a street or thoroughfare. ISO20022

Example:

"1st Street"

address.townName

string

Name of a built-up area, with defined boundaries, and a local government. ISO20022

Example:

"New York"

address.postalCode

string

Name of a built-up area, with defined boundaries, and a local government ISO20022

Example:

"10001"

address.countrySubDivision

string

Identifies the name of a country subdivision such as state, region, county.

Example:

"Ontario"

address.country

string

Country name that can be obtained from the United Nations (ISO 3166, Alpha-2 code).

Example:

"USA"

address.phoneNumber

string

Phone number of the financial institute.

Example:

"+1-800-555-1234"

Example:

{
  "country": "USA",
  "streetName": "1st Street",
  "townName": "New York",
  "phoneNumber": "+1-800-555-1234",
  "countrySubDivision": "Ontario",
  "postalCode": "10001",
  "buildingNumber": "123",
  "subDepartment": "Loan Processing",
  "type": "POSTAL",
  "department": "Retail Banking",
  "addressLine": "Main Office Tower",
  "primary": true
}

customFields

CustomField · object

Custom fields related to payments.

Show child attributes

customFields.{key}

object

⌘I

Payment APIs V2

Fraud APIs V1

Headers

Body

Response