Skip to main content
API docs by Redocly

PortX ORCA Payments (0.13.1)

Download OpenAPI specification:Download

E-mail: betiana.darderes@portx.io

PortX ORCA Payments

Credit Transfers

Credit Transfer Management

Retrieves a list of credit transfers matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
paymentId.eq
string (Id) [ 1 .. 300 ] characters
Example: paymentId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
paymentMethod.eq
string
debtorAccountId.eq
string
creditorAccountNumber.eq
string (AccountNumber) <= 30 characters
Example: creditorAccountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

creditorAccountId.eq
string (Id) [ 1 .. 300 ] characters
Example: creditorAccountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
checkType.eq
string
checkNumber.eq
string
amount.lte
string (Amount) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.lte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

amount.gte
string (Amount) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.gte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

checkDate.lte
string <date> (Date)
Example: checkDate.lte=2022-04-17

Check date less than or equal

checkDate.gte
string <date> (Date)
Example: checkDate.gte=2022-04-17

Check date greater than or equal

checkNumber.lte
string

Check number less than or equal

checkNumber.gte
string

Check number greater than or equal

cursor
string

Specifies an opaque string value ( "no meaning" string value) at which start retrieving transactions. For instance, limit=5&cursor=62aef884fbe3470ce7d9a92140b09b17

limit
string

Specifies the number of resources to return in one request, specified as an integer from 1 to 100.

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Credit Transfer Initiation

Instruction to pay an amount of money to an ultimate beneficiary, on behalf of an originator.

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

Array of objects (GenericTransactionCode)

Additional transaction codes.

Array
codeType
string [ 1 .. 50 ] characters
Example: "DetailBAI"

Code type in PascalCase form. Possible values are: DetailBAI, SummaryBAI, TransactionCode, BatchNumber, MICRAccountNumber, CustomerTransferCode, WireTransferScope, WireTransferDirection, CoreTransactionCode

name
string

Name of the code in PascalCase. Possible values: ResponseCode, PromotionCode, Domain, Family, Subfamily, MT940, SourceCode, TaxDeferredContributionCode, International, Domestic, Incoming, Outgoing.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
paymentMethod
required
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

amount
required
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

paymentReasons
Array of strings (PaymentPurpose) [ items [ 1 .. 60 ] characters ]
Example: ["CashManagementTransfer"]
debtorAccountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

creditorAccountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PaymentProcessingDetail)

Provides further details of the type of payment.

instructionPriority
string (InstructionPriority) [ 1 .. 35 ] characters
Example: "123456789"

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. Possible values are: High, Normal.

serviceLevel
string (ServiceLevel) [ 1 .. 35 ] characters
Example: "BookTransaction"

Specifies a pre-agreed service between the parties. Some ISO compliant values from ExternalServiceLevel1Code are: BookTransaction, TrackedCustomerCreditTransfer, TrackedStopAndRecall, TrackedOutboundCorporateTransfer, TrackedFinancialInstitutionTransfe, NonurgentPriorityPayment, NonurgentPayment, EBAPriorityService, SameDayValue, DomesticChequeClearingAndSettlement, UrgentPayment, UrgentPaymentNetSettlement, InstantCreditTransferOrInstantDirectDebit, ServiceRequestToPay, ScheckVerarbeitungAustria, TrackedCaseManagement, TrackedInboundCustomerCreditTransfer, TrackedInstantCustomerCreditTransfer, TrackedLowValueCrossBorderCustomerCreditTransfer.

clearingChannel
string (ClearingSystem) [ 1 .. 35 ] characters
Example: "ACH"

Specifies the clearing system identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: USFedACH, USFedNow, USFedwireFunds, ACH, EBAEuro1Step1, CanadaACSS, Albania, Austrian, NewZealand, Azerbaijan, BosniaHerzegovina, SwedenBGC, Ecuador, Barbados, Belgium, Bulgaria, Bahamas, Botswana, Finland, BankOfJapanNet, Italy, Philippines, CanadaCAD, SpainCAM, CentralBankOfArubaCSM, CentraleBankVanCuraçaoEnSintMaartenCSM, Ireland, Peru, USTCHChips,UnitedKingdom, China, CentralInteroperabilityService, ColumbiaCEDEC, ColumbiaCENIT, ColumbiaCUD, DenmarkDDK,Denmark, EBAEuro1, GermanyELS, Germany, ECB, USTCHEPN, EBAStep1, ForeignExchangeYenClearing, FasterPaymentsServices, Ghana, HongKongCHAT, HongKongFPS, Croatia, Greece, Hungary, SpainIberpayInstantPayments, DEandNLEquens, IndiaImmediatePaymentService, Jordan, Kenya, Luxemburg, SriLanka, Latvia, CanadaLVTS, LynxCanada, Singapore, SouthAfrica, MacaoRTGS, Malta, Mauritius, Namibia, Norway, NorwayNICSReal, AustraliaNPP, USNSS, NewZealandRTGS, Switzerland, AustraliaPDS, Egypt, FrancePNS, AustrianCSM, Angola, Venezuela, RomaniaEPO, RomaniaGSRS, RTGS, GermanyRTGSPlus, RTRCanada, RPSAndSEPAClearer, Chili, SwedenSEC, euroSIC, SIC, SICIP, Slovania, SpainES, Portugal, SwedenSSK, EBAClearingSTEP2, UnitedKingdomGBP, FranceFR, USTCHRealTime, Target, Thailand, Thailand-NITMX, Tanzania, Netherlands, TrinidadAndTobago, CanadaUSBE, Uganda, IndiaUnifiedPaymentsInterface, VocaLink, EBASTEP2XCT, Zengin, Zimbabwe, Zambia, Iceland, NorwayRTGS, NGInterswitch, P27RealTime, P27, UnitedKingdomUKD, SingaporeSCRIPS, RIXRTGSSverigesRiksbank

localInstrument
string (LocalInstrument) [ 1 .. 35 ] characters
Example: "CCD"

This element is used to specify a local clearing option and/or qualify the service or service level. For ACH service Level offers more detailed information about the authorization method of the ACH transaction. Posible values for ACH Entry Class or SEC code: PPD, CCD, CTX

categoryPurpose
string (CategoryPurpose) [ 1 .. 35 ] characters
Example: "SalaryPayment"

Specifies the high level purpose of the instruction based on a set of pre-defined categories. Usage: This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain. Some ISO compliant values are from ExternalCategoryPurpose1Code: BonusPayment, CashManagementTransfer, CardBulkClearing, CreditCardPayment, TradeSettlementPayment, DebitCardPayment, Dividend, DeliverAgainstPayment, EPayment,FeeCollectionAndInterest, FeeCollection,PersontoPersonPayment, GovernmentPayment, Hedging, IrrevocableCreditCardPayment, IrrevocableDebitCardPayment, IntraCompanyPayment, Interest, LockboxTransactions, Loan, Commercial, Consumer, PensionPayment, Represented, ReimbursementReceivedCreditTransfer, ReceiveAgainstPayment, SalaryPayment, Securities, SocialSecurityBenefit, SupplierPayment, TaxPayment, Trade, TreasuryPayment, ValueAddedTaxPayment, WithHolding, CashManagementSweepAccount, CashManagementTopAccount, CashManagementZeroBalanceAccount

chargeBearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Specifies the currency of the amount to be transferred which may be different from the currency of the debtor's account.

object (Exchange)
currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Currency in which the rate of exchange is expressed in a currency exchange.

exchangeFactor
string (BaseOneRate) [ 1 .. 35 ] characters
Example: "0.7"

Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. total number of digits: 11 number of digits in fractional part: 10 base value: 1

object (Check)

Characteristics of a check

checkType
string

Specifies the type of the check. Possible values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

amount
string <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Check amount

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Check currency

checkNumber
string <= 35 characters

The number on the face of the check indicating the id of that check in a series.

issuer
string
Example: "Jhon Smith"

Party that issued the check.

availabilityDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Indicates when the amount of money will become available. Usage: This type of information is used in the US and is linked to particular instruments such as cheques. Example: When a cheque is deposited, it will be booked on the deposit day, but the amount of money will only be accessible as of the indicated availability day (according to national banking regulations).

availabilityFloat
string

It refers to the time delay between when a check is deposited and when the funds become available for withdrawal. Possible Values: ImmediateWithdrawal, LocalCheck, NonLocalCheck

Array of objects (GenericIdentification)

Check identifiers. Possible scheme names: Reference.

Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification.

schemeName
required
string [ 1 .. 35 ] characters

Name of the identification scheme.

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

imageSequence
Array of strings (FileName) [ items <= 255 characters ^[a-zA-Z0-9_\- ]+\.[a-zA-Z0-9]+$ ]
Example: ["image003.png"]

Series of images that are related and sequentially ordered.

Array of objects (GenericCode)

Codes to classify the check. Possible code names: AccountCode

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
printer
string

Check printer used.

valueDate
string <date>
Example: "2022-04-17"

Date on which a payment must be executed

dueDate
string <date>
Example: "2022-04-17"

The final deadline to make a payment to avoid penalties.

object (PartyIdentification)
name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

object (PaymentAccount)
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

accountBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (AccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

routingNumber
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

Array of objects (AccountIdentification)
paymentReference
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

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

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

object (FinancialInstitution)
Array of objects (OrganizationIdentification)
clearingSystemMemberIdentification
string (ClearingSystemIdentification) [ 1 .. 60 ] characters
Example: "UnitedStatesRoutingNumberFedwireNACHA"

Specifies the clearing system member identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: UnitedStatesRoutingNumberFedwireNACHA, AustrianBankleitzahl, AustralianBankStateBranchCodeBSB,CanadianPaymentsAssociationPaymentRoutingNumber,SwissFinancialInstitutionIdentificationShort,SwissFinancialInstitutionIdentificationLong,CNAPSIdentifier, GermanBankleitzahl, SpanishDomesticInterbankingCode, UKDomesticSortCode, HellenicBankIdentificationCode, HongKongBankCode, IrishNationalClearingCode, IndianFinancialSystemCode, ItalianDomesticIdentificationCode, JapanZenginClearingCode, NewZealandNationalClearingCode, PolishNationalClearingCode, PortugueseNationalClearingCode, RussianCentralBankIdentificationCode, SwedenBankgiroClearingCode, IBGSortCode, ThaiCentralBankIdentificationCode, FinancialInstitutionCode, CHIPSParticipantIdentifier, SouthAfricanNationalClearingCode, NewZealandRTGSClearingCode

memberIdentification
string [ 1 .. 35 ] characters
name
string [ 1 .. 35 ] characters
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

birthDate
string <date>
Example: "2022-04-17"

Date on which a person is born.

object (PaymentPartyContactDetails)

Specifies the contact details of a person.

Array of objects (GenericContact)
preferredMethod
string [ 1 .. 35 ] characters
Example: "Email"

Preferred method used to reach the contact, in PascalCase form. Possible values are:
Letter, Email, Phone, Fax, MobileOrCellPhone.

preferredLanguage
string (PreferredLanguage) [ 1 .. 35 ] characters
Example: "English"

Language of the contact person. Names according to the language list provided in the ISO 639-1 codes. Some possible values: Chinese, Spanish, French, English, Japanese, Italian, German, Default.

Array of objects (PartyGenericIdentification)
Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of an organization.

schemeName
required
string (PartySchemeName) [ 1 .. 35 ] characters
Example: "TaxIdentificationNumber"

Name of the identification scheme, in PascalCase form. Possible values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET BusinessDomainIdentifier BusinessOtherIdentification AlienRegistrationNumber ResidentAlienCard PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification LEIIdentifier BICIdentifier PermanentAccountNumberCard

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

notifyPartyIndicator
boolean
object (PartyIdentification)
name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

object (PaymentAccount)
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

accountBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (AccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

routingNumber
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

Array of objects (AccountIdentification)
paymentReference
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

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

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

object (FinancialInstitution)
Array of objects (OrganizationIdentification)
clearingSystemMemberIdentification
string (ClearingSystemIdentification) [ 1 .. 60 ] characters
Example: "UnitedStatesRoutingNumberFedwireNACHA"

Specifies the clearing system member identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: UnitedStatesRoutingNumberFedwireNACHA, AustrianBankleitzahl, AustralianBankStateBranchCodeBSB,CanadianPaymentsAssociationPaymentRoutingNumber,SwissFinancialInstitutionIdentificationShort,SwissFinancialInstitutionIdentificationLong,CNAPSIdentifier, GermanBankleitzahl, SpanishDomesticInterbankingCode, UKDomesticSortCode, HellenicBankIdentificationCode, HongKongBankCode, IrishNationalClearingCode, IndianFinancialSystemCode, ItalianDomesticIdentificationCode, JapanZenginClearingCode, NewZealandNationalClearingCode, PolishNationalClearingCode, PortugueseNationalClearingCode, RussianCentralBankIdentificationCode, SwedenBankgiroClearingCode, IBGSortCode, ThaiCentralBankIdentificationCode, FinancialInstitutionCode, CHIPSParticipantIdentifier, SouthAfricanNationalClearingCode, NewZealandRTGSClearingCode

memberIdentification
string [ 1 .. 35 ] characters
name
string [ 1 .. 35 ] characters
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

birthDate
string <date>
Example: "2022-04-17"

Date on which a person is born.

object (PaymentPartyContactDetails)

Specifies the contact details of a person.

Array of objects (GenericContact)
preferredMethod
string [ 1 .. 35 ] characters
Example: "Email"

Preferred method used to reach the contact, in PascalCase form. Possible values are:
Letter, Email, Phone, Fax, MobileOrCellPhone.

preferredLanguage
string (PreferredLanguage) [ 1 .. 35 ] characters
Example: "English"

Language of the contact person. Names according to the language list provided in the ISO 639-1 codes. Some possible values: Chinese, Spanish, French, English, Japanese, Italian, German, Default.

Array of objects (PartyGenericIdentification)
Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of an organization.

schemeName
required
string (PartySchemeName) [ 1 .. 35 ] characters
Example: "TaxIdentificationNumber"

Name of the identification scheme, in PascalCase form. Possible values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET BusinessDomainIdentifier BusinessOtherIdentification AlienRegistrationNumber ResidentAlienCard PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification LEIIdentifier BICIdentifier PermanentAccountNumberCard

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

notifyPartyIndicator
boolean
object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

remittanceNumber
required
string [ 1 .. 60 ] characters

Unique and unambiguous identification of the remittance document

documentType
required
string [ 1 .. 60 ] characters

Specifies a type of financial or commercial document. Possible values are: MeteredServiceInvoice, CreditNoteRelatedToFinancialAdjustment, DebitNoteRelatedToFinancialAdjustment, CommercialInvoice, CreditNote, DebitNote, HireInvoice, SelfBilledInvoice, CommercialContract, StatementOfAccount, DispatchAdvice, BillOfLading, Voucher, AccountReceivableOpenItem, TradeServicesUtilityTransaction, PurchaseOrder

object (Document)

General information related to a physical document, such as identification number and issue date time.

documentReference
string [ 1 .. 35 ] characters

Document location.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 100 ] characters

Specifies the function of the document.

object (CreditTransferSettlement)

Transfer settlement information.

postingType
string (PostingType) [ 1 .. 60 ] characters
Example: "HardPosted"

Indicates the type of posting. Possible values: MemoPosted, HardPosted, ForcePost, PostAuthorizationSucceeds, AuthorizationOnly.

object

Time of the day of the posting date.

hour
string <time-hour>
Example: "12"
timeZone
string (TimeZone) [ 1 .. 30 ] characters
Example: "Pacific"

A time zone is an area which observes a uniform standard time for legal, commercial and social purposes. Some possible values: Pacific, Mountain, Central, Eastern, GreenwichMean

timeOfTheDay
string

Time of the day. Possible Values: AfterMidnight, after midnight and before business day; AfterBusinessDay, after business day and before midnight.

object (Frequency)

Specifies an event frequency

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

memopostedIndicator
boolean

Indicates whether the internal transfer has been memoposted.

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchange": {
    },
  • "check": {
    },
  • "valueDate": "2022-04-17",
  • "dueDate": "2022-04-17",
  • "creditor": {
    },
  • "debtor": {
    },
  • "remittanceInformation": {
    },
  • "settlement": {
    }
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchange": {
    },
  • "check": {
    },
  • "valueDate": "2022-04-17",
  • "dueDate": "2022-04-17",
  • "creditor": {
    },
  • "debtor": {
    },
  • "remittanceInformation": {
    },
  • "settlement": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "date": "2022-04-17T08:00:00Z"
}

Credit Transfer Status

Returns the status report of a credit transfer initiation, process and excecution.

Authorizations:
jwtopenIdConnect
path Parameters
paymentId
required
string (PaymentId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Identification of the Payment.

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchange": {
    },
  • "check": {
    },
  • "valueDate": "2022-04-17",
  • "dueDate": "2022-04-17",
  • "creditor": {
    },
  • "debtor": {
    },
  • "remittanceInformation": {
    },
  • "settlement": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "date": "2022-04-17T08:00:00Z"
}

Credit Transfer Cancellation

Request a payment cancellation.

Authorizations:
jwtopenIdConnect
path Parameters
paymentId
required
string (PaymentId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Identification of the Payment.

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
cancellationReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."

Responses

Request samples

Content type
application/json
{
  • "cancellationReason": "This is a description."
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchange": {
    },
  • "check": {
    },
  • "valueDate": "2022-04-17",
  • "dueDate": "2022-04-17",
  • "creditor": {
    },
  • "debtor": {
    },
  • "remittanceInformation": {
    },
  • "settlement": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "date": "2022-04-17T08:00:00Z"
}

Direct Debits

Direct Debit Management

Retrieves a list of direct debits matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
paymentId.eq
string (Id) [ 1 .. 300 ] characters
Example: paymentId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
paymentMethod.eq
string
debtorAccountId.eq
string
creditorAccountNumber.eq
string (AccountNumber) <= 30 characters
Example: creditorAccountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

creditorAccountId.eq
string (Id) [ 1 .. 300 ] characters
Example: creditorAccountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
amount.lte
string (Amount) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.lte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

amount.gte
string (Amount) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.gte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

cursor
string

Specifies an opaque string value ( "no meaning" string value) at which start retrieving transactions. For instance, limit=5&cursor=62aef884fbe3470ce7d9a92140b09b17

limit
string

Specifies the number of resources to return in one request, specified as an integer from 1 to 100.

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Direct Debit Initiation

Instruction to collect funds from a debitor.

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

Array of objects (GenericTransactionCode)

Additional transaction codes.

Array
codeType
string [ 1 .. 50 ] characters
Example: "DetailBAI"

Code type in PascalCase form. Possible values are: DetailBAI, SummaryBAI, TransactionCode, BatchNumber, MICRAccountNumber, CustomerTransferCode, WireTransferScope, WireTransferDirection, CoreTransactionCode

name
string

Name of the code in PascalCase. Possible values: ResponseCode, PromotionCode, Domain, Family, Subfamily, MT940, SourceCode, TaxDeferredContributionCode, International, Domestic, Incoming, Outgoing.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
paymentMethod
required
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

amount
required
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

paymentReasons
Array of strings (PaymentPurpose) [ items [ 1 .. 60 ] characters ]
Example: ["CashManagementTransfer"]
debtorAccountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

creditorAccountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PaymentProcessingDetail)

Provides further details of the type of payment.

instructionPriority
string (InstructionPriority) [ 1 .. 35 ] characters
Example: "123456789"

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. Possible values are: High, Normal.

serviceLevel
string (ServiceLevel) [ 1 .. 35 ] characters
Example: "BookTransaction"

Specifies a pre-agreed service between the parties. Some ISO compliant values from ExternalServiceLevel1Code are: BookTransaction, TrackedCustomerCreditTransfer, TrackedStopAndRecall, TrackedOutboundCorporateTransfer, TrackedFinancialInstitutionTransfe, NonurgentPriorityPayment, NonurgentPayment, EBAPriorityService, SameDayValue, DomesticChequeClearingAndSettlement, UrgentPayment, UrgentPaymentNetSettlement, InstantCreditTransferOrInstantDirectDebit, ServiceRequestToPay, ScheckVerarbeitungAustria, TrackedCaseManagement, TrackedInboundCustomerCreditTransfer, TrackedInstantCustomerCreditTransfer, TrackedLowValueCrossBorderCustomerCreditTransfer.

clearingChannel
string (ClearingSystem) [ 1 .. 35 ] characters
Example: "ACH"

Specifies the clearing system identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: USFedACH, USFedNow, USFedwireFunds, ACH, EBAEuro1Step1, CanadaACSS, Albania, Austrian, NewZealand, Azerbaijan, BosniaHerzegovina, SwedenBGC, Ecuador, Barbados, Belgium, Bulgaria, Bahamas, Botswana, Finland, BankOfJapanNet, Italy, Philippines, CanadaCAD, SpainCAM, CentralBankOfArubaCSM, CentraleBankVanCuraçaoEnSintMaartenCSM, Ireland, Peru, USTCHChips,UnitedKingdom, China, CentralInteroperabilityService, ColumbiaCEDEC, ColumbiaCENIT, ColumbiaCUD, DenmarkDDK,Denmark, EBAEuro1, GermanyELS, Germany, ECB, USTCHEPN, EBAStep1, ForeignExchangeYenClearing, FasterPaymentsServices, Ghana, HongKongCHAT, HongKongFPS, Croatia, Greece, Hungary, SpainIberpayInstantPayments, DEandNLEquens, IndiaImmediatePaymentService, Jordan, Kenya, Luxemburg, SriLanka, Latvia, CanadaLVTS, LynxCanada, Singapore, SouthAfrica, MacaoRTGS, Malta, Mauritius, Namibia, Norway, NorwayNICSReal, AustraliaNPP, USNSS, NewZealandRTGS, Switzerland, AustraliaPDS, Egypt, FrancePNS, AustrianCSM, Angola, Venezuela, RomaniaEPO, RomaniaGSRS, RTGS, GermanyRTGSPlus, RTRCanada, RPSAndSEPAClearer, Chili, SwedenSEC, euroSIC, SIC, SICIP, Slovania, SpainES, Portugal, SwedenSSK, EBAClearingSTEP2, UnitedKingdomGBP, FranceFR, USTCHRealTime, Target, Thailand, Thailand-NITMX, Tanzania, Netherlands, TrinidadAndTobago, CanadaUSBE, Uganda, IndiaUnifiedPaymentsInterface, VocaLink, EBASTEP2XCT, Zengin, Zimbabwe, Zambia, Iceland, NorwayRTGS, NGInterswitch, P27RealTime, P27, UnitedKingdomUKD, SingaporeSCRIPS, RIXRTGSSverigesRiksbank

localInstrument
string (LocalInstrument) [ 1 .. 35 ] characters
Example: "CCD"

This element is used to specify a local clearing option and/or qualify the service or service level. For ACH service Level offers more detailed information about the authorization method of the ACH transaction. Posible values for ACH Entry Class or SEC code: PPD, CCD, CTX

categoryPurpose
string (CategoryPurpose) [ 1 .. 35 ] characters
Example: "SalaryPayment"

Specifies the high level purpose of the instruction based on a set of pre-defined categories. Usage: This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain. Some ISO compliant values are from ExternalCategoryPurpose1Code: BonusPayment, CashManagementTransfer, CardBulkClearing, CreditCardPayment, TradeSettlementPayment, DebitCardPayment, Dividend, DeliverAgainstPayment, EPayment,FeeCollectionAndInterest, FeeCollection,PersontoPersonPayment, GovernmentPayment, Hedging, IrrevocableCreditCardPayment, IrrevocableDebitCardPayment, IntraCompanyPayment, Interest, LockboxTransactions, Loan, Commercial, Consumer, PensionPayment, Represented, ReimbursementReceivedCreditTransfer, ReceiveAgainstPayment, SalaryPayment, Securities, SocialSecurityBenefit, SupplierPayment, TaxPayment, Trade, TreasuryPayment, ValueAddedTaxPayment, WithHolding, CashManagementSweepAccount, CashManagementTopAccount, CashManagementZeroBalanceAccount

chargeBearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

object (DirectDebitMandate)

Authorization in favour of the creditor given by the debtor to debit its own account. Provides details related to a direct debit mandate signed between the creditor and the debtor.

mandateId
string (Id) [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
dateOfSignature
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

digitalSignature
string <byte> (DigitalSignature) [ 1 .. 13654 ] characters
Example: {"0":83,"1":109,"2":70,"3":117,"4":90,"5":83,"6":66,"7":67,"8":97,"9":88,"10":74,"11":114,"12":97,"13":87,"14":52,"15":61}

Binary data of 10K maximum, base64 encoded.

firstCollectionDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

finalCollectionDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

object (Frequency)

Specifies an event frequency

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

trackingDays
integer (Day) <= 31
Example: 30

Specifies the date in a month.

requestedCollectionDate
string <date>
Example: "2022-04-17"

Date and time at which the creditor requests that the amount of money is to be collected from the debtor.

object (PartyIdentification)
name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

object (PaymentAccount)
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

accountBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (AccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

routingNumber
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

Array of objects (AccountIdentification)
paymentReference
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

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

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

object (FinancialInstitution)
Array of objects (OrganizationIdentification)
clearingSystemMemberIdentification
string (ClearingSystemIdentification) [ 1 .. 60 ] characters
Example: "UnitedStatesRoutingNumberFedwireNACHA"

Specifies the clearing system member identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: UnitedStatesRoutingNumberFedwireNACHA, AustrianBankleitzahl, AustralianBankStateBranchCodeBSB,CanadianPaymentsAssociationPaymentRoutingNumber,SwissFinancialInstitutionIdentificationShort,SwissFinancialInstitutionIdentificationLong,CNAPSIdentifier, GermanBankleitzahl, SpanishDomesticInterbankingCode, UKDomesticSortCode, HellenicBankIdentificationCode, HongKongBankCode, IrishNationalClearingCode, IndianFinancialSystemCode, ItalianDomesticIdentificationCode, JapanZenginClearingCode, NewZealandNationalClearingCode, PolishNationalClearingCode, PortugueseNationalClearingCode, RussianCentralBankIdentificationCode, SwedenBankgiroClearingCode, IBGSortCode, ThaiCentralBankIdentificationCode, FinancialInstitutionCode, CHIPSParticipantIdentifier, SouthAfricanNationalClearingCode, NewZealandRTGSClearingCode

memberIdentification
string [ 1 .. 35 ] characters
name
string [ 1 .. 35 ] characters
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

birthDate
string <date>
Example: "2022-04-17"

Date on which a person is born.

object (PaymentPartyContactDetails)

Specifies the contact details of a person.

Array of objects (GenericContact)
preferredMethod
string [ 1 .. 35 ] characters
Example: "Email"

Preferred method used to reach the contact, in PascalCase form. Possible values are:
Letter, Email, Phone, Fax, MobileOrCellPhone.

preferredLanguage
string (PreferredLanguage) [ 1 .. 35 ] characters
Example: "English"

Language of the contact person. Names according to the language list provided in the ISO 639-1 codes. Some possible values: Chinese, Spanish, French, English, Japanese, Italian, German, Default.

Array of objects (PartyGenericIdentification)
Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of an organization.

schemeName
required
string (PartySchemeName) [ 1 .. 35 ] characters
Example: "TaxIdentificationNumber"

Name of the identification scheme, in PascalCase form. Possible values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET BusinessDomainIdentifier BusinessOtherIdentification AlienRegistrationNumber ResidentAlienCard PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification LEIIdentifier BICIdentifier PermanentAccountNumberCard

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

notifyPartyIndicator
boolean

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "mandate": {
    },
  • "requestedCollectionDate": "2022-04-17",
  • "debtor": {
    }
}

Response samples

Content type
application/json
{
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "mandate": {
    },
  • "requestedCollectionDate": "2022-04-17",
  • "debtor": {
    }
}

Direct Debit Status

Returns the status report of a direct debit initiation, process and excecution.

Authorizations:
jwtopenIdConnect
path Parameters
paymentId
required
string (PaymentId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Identification of the Payment.

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "mandate": {
    },
  • "requestedCollectionDate": "2022-04-17",
  • "debtor": {
    }
}

Direct Debit Cancellation

Requests direct debit cancellation.

Authorizations:
jwtopenIdConnect
path Parameters
paymentId
required
string (PaymentId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Identification of the Payment.

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
cancellationReason
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."

Responses

Request samples

Content type
application/json
{
  • "cancellationReason": "This is a description."
}

Response samples

Content type
application/json
{
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "mandate": {
    },
  • "requestedCollectionDate": "2022-04-17",
  • "debtor": {
    }
}

Creditor Payments

Retrieves a list of payments matching the parameters.

Authorizations:
jwtopenIdConnect
query Parameters
paymentId.eq
string (Id) [ 1 .. 300 ] characters
Example: paymentId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
paymentMethod.eq
string
debtorAccountId.eq
string
creditorAccountNumber.eq
string (AccountNumber) <= 30 characters
Example: creditorAccountNumber.eq=012345678

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

creditorAccountId.eq
string (Id) [ 1 .. 300 ] characters
Example: creditorAccountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
checkType.eq
string
checkNumber.eq
string
amount.lte
string (Amount) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.lte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

amount.gte
string (Amount) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: amount.gte=100

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

checkDate.lte
string <date> (Date)
Example: checkDate.lte=2022-04-17

Check date less than or equal

checkDate.gte
string <date> (Date)
Example: checkDate.gte=2022-04-17

Check date greater than or equal

checkNumber.lte
string

Check number less than or equal

checkNumber.gte
string

Check number greater than or equal

cursor
string

Specifies an opaque string value ( "no meaning" string value) at which start retrieving transactions. For instance, limit=5&cursor=62aef884fbe3470ce7d9a92140b09b17

limit
string

Specifies the number of resources to return in one request, specified as an integer from 1 to 100.

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creditor Payment Activation Request

It is used by a Creditor to request movement of funds from the debtor account to a creditor.

Authorizations:
jwtopenIdConnect
header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

Array of objects (GenericTransactionCode)

Additional transaction codes.

Array
codeType
string [ 1 .. 50 ] characters
Example: "DetailBAI"

Code type in PascalCase form. Possible values are: DetailBAI, SummaryBAI, TransactionCode, BatchNumber, MICRAccountNumber, CustomerTransferCode, WireTransferScope, WireTransferDirection, CoreTransactionCode

name
string

Name of the code in PascalCase. Possible values: ResponseCode, PromotionCode, Domain, Family, Subfamily, MT940, SourceCode, TaxDeferredContributionCode, International, Domestic, Incoming, Outgoing.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
paymentMethod
required
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

amount
required
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

paymentReasons
Array of strings (PaymentPurpose) [ items [ 1 .. 60 ] characters ]
Example: ["CashManagementTransfer"]
debtorAccountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

creditorAccountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

purpose
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PaymentProcessingDetail)

Provides further details of the type of payment.

instructionPriority
string (InstructionPriority) [ 1 .. 35 ] characters
Example: "123456789"

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. Possible values are: High, Normal.

serviceLevel
string (ServiceLevel) [ 1 .. 35 ] characters
Example: "BookTransaction"

Specifies a pre-agreed service between the parties. Some ISO compliant values from ExternalServiceLevel1Code are: BookTransaction, TrackedCustomerCreditTransfer, TrackedStopAndRecall, TrackedOutboundCorporateTransfer, TrackedFinancialInstitutionTransfe, NonurgentPriorityPayment, NonurgentPayment, EBAPriorityService, SameDayValue, DomesticChequeClearingAndSettlement, UrgentPayment, UrgentPaymentNetSettlement, InstantCreditTransferOrInstantDirectDebit, ServiceRequestToPay, ScheckVerarbeitungAustria, TrackedCaseManagement, TrackedInboundCustomerCreditTransfer, TrackedInstantCustomerCreditTransfer, TrackedLowValueCrossBorderCustomerCreditTransfer.

clearingChannel
string (ClearingSystem) [ 1 .. 35 ] characters
Example: "ACH"

Specifies the clearing system identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: USFedACH, USFedNow, USFedwireFunds, ACH, EBAEuro1Step1, CanadaACSS, Albania, Austrian, NewZealand, Azerbaijan, BosniaHerzegovina, SwedenBGC, Ecuador, Barbados, Belgium, Bulgaria, Bahamas, Botswana, Finland, BankOfJapanNet, Italy, Philippines, CanadaCAD, SpainCAM, CentralBankOfArubaCSM, CentraleBankVanCuraçaoEnSintMaartenCSM, Ireland, Peru, USTCHChips,UnitedKingdom, China, CentralInteroperabilityService, ColumbiaCEDEC, ColumbiaCENIT, ColumbiaCUD, DenmarkDDK,Denmark, EBAEuro1, GermanyELS, Germany, ECB, USTCHEPN, EBAStep1, ForeignExchangeYenClearing, FasterPaymentsServices, Ghana, HongKongCHAT, HongKongFPS, Croatia, Greece, Hungary, SpainIberpayInstantPayments, DEandNLEquens, IndiaImmediatePaymentService, Jordan, Kenya, Luxemburg, SriLanka, Latvia, CanadaLVTS, LynxCanada, Singapore, SouthAfrica, MacaoRTGS, Malta, Mauritius, Namibia, Norway, NorwayNICSReal, AustraliaNPP, USNSS, NewZealandRTGS, Switzerland, AustraliaPDS, Egypt, FrancePNS, AustrianCSM, Angola, Venezuela, RomaniaEPO, RomaniaGSRS, RTGS, GermanyRTGSPlus, RTRCanada, RPSAndSEPAClearer, Chili, SwedenSEC, euroSIC, SIC, SICIP, Slovania, SpainES, Portugal, SwedenSSK, EBAClearingSTEP2, UnitedKingdomGBP, FranceFR, USTCHRealTime, Target, Thailand, Thailand-NITMX, Tanzania, Netherlands, TrinidadAndTobago, CanadaUSBE, Uganda, IndiaUnifiedPaymentsInterface, VocaLink, EBASTEP2XCT, Zengin, Zimbabwe, Zambia, Iceland, NorwayRTGS, NGInterswitch, P27RealTime, P27, UnitedKingdomUKD, SingaporeSCRIPS, RIXRTGSSverigesRiksbank

localInstrument
string (LocalInstrument) [ 1 .. 35 ] characters
Example: "CCD"

This element is used to specify a local clearing option and/or qualify the service or service level. For ACH service Level offers more detailed information about the authorization method of the ACH transaction. Posible values for ACH Entry Class or SEC code: PPD, CCD, CTX

categoryPurpose
string (CategoryPurpose) [ 1 .. 35 ] characters
Example: "SalaryPayment"

Specifies the high level purpose of the instruction based on a set of pre-defined categories. Usage: This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain. Some ISO compliant values are from ExternalCategoryPurpose1Code: BonusPayment, CashManagementTransfer, CardBulkClearing, CreditCardPayment, TradeSettlementPayment, DebitCardPayment, Dividend, DeliverAgainstPayment, EPayment,FeeCollectionAndInterest, FeeCollection,PersontoPersonPayment, GovernmentPayment, Hedging, IrrevocableCreditCardPayment, IrrevocableDebitCardPayment, IntraCompanyPayment, Interest, LockboxTransactions, Loan, Commercial, Consumer, PensionPayment, Represented, ReimbursementReceivedCreditTransfer, ReceiveAgainstPayment, SalaryPayment, Securities, SocialSecurityBenefit, SupplierPayment, TaxPayment, Trade, TreasuryPayment, ValueAddedTaxPayment, WithHolding, CashManagementSweepAccount, CashManagementTopAccount, CashManagementZeroBalanceAccount

chargeBearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Specifies the currency of the amount to be transferred which may be different from the currency of the debtor's account.

object (Exchange)
currency
string = 3 characters ^([A-Z]{3})?$
Example: "USD"

Currency in which the rate of exchange is expressed in a currency exchange.

exchangeFactor
string (BaseOneRate) [ 1 .. 35 ] characters
Example: "0.7"

Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. total number of digits: 11 number of digits in fractional part: 10 base value: 1

valueDate
string <date>
Example: "2022-04-17"

Date on which a payment must be executed.

expirationDate
string <date>
Example: "2022-04-17"

Date by which the debtor must have accepted or rejected the request. Beyond this date, the request becomes void and cannot be processed anymore.

object (PartyIdentification)
name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

object (PaymentAccount)
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

accountBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (AccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

routingNumber
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

Array of objects (AccountIdentification)
paymentReference
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

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

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

object (FinancialInstitution)
Array of objects (OrganizationIdentification)
clearingSystemMemberIdentification
string (ClearingSystemIdentification) [ 1 .. 60 ] characters
Example: "UnitedStatesRoutingNumberFedwireNACHA"

Specifies the clearing system member identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: UnitedStatesRoutingNumberFedwireNACHA, AustrianBankleitzahl, AustralianBankStateBranchCodeBSB,CanadianPaymentsAssociationPaymentRoutingNumber,SwissFinancialInstitutionIdentificationShort,SwissFinancialInstitutionIdentificationLong,CNAPSIdentifier, GermanBankleitzahl, SpanishDomesticInterbankingCode, UKDomesticSortCode, HellenicBankIdentificationCode, HongKongBankCode, IrishNationalClearingCode, IndianFinancialSystemCode, ItalianDomesticIdentificationCode, JapanZenginClearingCode, NewZealandNationalClearingCode, PolishNationalClearingCode, PortugueseNationalClearingCode, RussianCentralBankIdentificationCode, SwedenBankgiroClearingCode, IBGSortCode, ThaiCentralBankIdentificationCode, FinancialInstitutionCode, CHIPSParticipantIdentifier, SouthAfricanNationalClearingCode, NewZealandRTGSClearingCode

memberIdentification
string [ 1 .. 35 ] characters
name
string [ 1 .. 35 ] characters
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

birthDate
string <date>
Example: "2022-04-17"

Date on which a person is born.

object (PaymentPartyContactDetails)

Specifies the contact details of a person.

Array of objects (GenericContact)
preferredMethod
string [ 1 .. 35 ] characters
Example: "Email"

Preferred method used to reach the contact, in PascalCase form. Possible values are:
Letter, Email, Phone, Fax, MobileOrCellPhone.

preferredLanguage
string (PreferredLanguage) [ 1 .. 35 ] characters
Example: "English"

Language of the contact person. Names according to the language list provided in the ISO 639-1 codes. Some possible values: Chinese, Spanish, French, English, Japanese, Italian, German, Default.

Array of objects (PartyGenericIdentification)
Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of an organization.

schemeName
required
string (PartySchemeName) [ 1 .. 35 ] characters
Example: "TaxIdentificationNumber"

Name of the identification scheme, in PascalCase form. Possible values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET BusinessDomainIdentifier BusinessOtherIdentification AlienRegistrationNumber ResidentAlienCard PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification LEIIdentifier BICIdentifier PermanentAccountNumberCard

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

notifyPartyIndicator
boolean
object (PartyIdentification)
name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

object (PaymentAccount)
name
string (AccountName) [ 1 .. 70 ] characters
Example: "Hermes PD_CA 0002"

Name of the account. It provides an additional means of identification, and is designated by the account servicer in agreement with the account owner.

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

accountBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (AccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

routingNumber
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

Array of objects (AccountIdentification)
paymentReference
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

addressCode
string

This code is used to identify parties that share the same address or to associate an existing address with a specific party. Providing this code eliminates the need to separately enter the address details.

addressBookIndicator
string

If true, the address is kept in the system even if the person is no longer a customer.

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible values are: PhysicalAddress, Postal, POBox, Residential, Permanent, Temporary, Alternative, Previous.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible values are: MailTo, DeliveryTo, Billing, Tax, ForeignTaxRecipient PlaceOfOperation, PlaceOfRegistration, placeOfFormation, Marketing, Statements, Business, Administrative, PreviousPlace, Headquarter, BranchStore, Branch, Property, Military, Secondary, Personal, Annex, Inquiry.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

careOf
string [ 1 .. 100 ] characters
Example: "C/O Company Name"

Identifies an addressee that is accepting the correspondence for the intended recipient. Using care of ensures the correspondence reaches the right recipient rather than getting returned to the sender.

department
string [ 1 .. 70 ] characters
Example: "A"

Identification of a division of a large Organization or building.

subDepartment
string [ 1 .. 70 ] characters
Example: "B"

Identification of a sub-division of a large Organization or building.

streetName
string [ 1 .. 70 ] characters
Example: "First Street"

Name of a street or thoroughfare.

firstCrossStreetName
string [ 1 .. 70 ] characters

Name of a the first cross street.

secondCrossStreetName
string [ 1 .. 70 ] characters
Example: "Second Street"

Name of a the second cross street.

buildingNumber
string [ 1 .. 16 ] characters
Example: "11407"

Number that identifies the position of a building or house on a street.

buildingName
string [ 1 .. 35 ] characters
Example: "Tall Tower"

Name of the building or house.

floor
string [ 1 .. 70 ] characters
Example: "20"

Floor or storey within a building.

postBox
string [ 1 .. 16 ] characters
Example: "MY779"

Numbered box in a post office, assigned to a person or Organization, where letters are kept until called for.

room
string [ 1 .. 70 ] characters
Example: "22"

Building room number.

postCode
string (PostCode) [ 1 .. 16 ] characters
Example: "97062-6884"

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. In US may consists of two parts: the five-digit ZIP Code '97062' and the ZIP+4 Code '6884'.

carrierRoute
string (CarrierRoute) [ 1 .. 4 ] characters
Example: "C001"

A Carrier Route is a designated geographic area assigned to individual postal carriers by the United States Postal Service (USPS) to facilitate efficient mail delivery within specific regions.

censusTract
string (CensusTract) = 5 characters
Example: "12345"

A census tract, census area, census district or meshblock is a geographic region defined for the purpose of taking a census

censusBlock
string (CensusBlock) = 4 characters
Example: "1234"

Census blocks are used to partition counties into smaller areas for the purpose of collecting and presenting census data.

cBSACode
string (CBSACode) = 5 characters
Example: "49780"

Core-based statistical area. Metropolitan statistical area (MSA) is the formal definition of a region that consists of a city and surrounding communities that are linked by social and economic factors. Micropolitan Statistical Areas (MISA) are CBSAs associated with at least one urban cluster that has a population of at least 10,000, but less than 50,000. The micropolitan statistical area comprises the central county or counties or equivalent entities containing the core, plus adjacent outlying counties having a high degree of social and economic integration with the central county as measured through commuting.

cBSAType
string (CBSAType) [ 1 .. 10 ] characters
Example: "MSA"

Type of Core-based statistical area. Possible values: MSA, MISA

foreignIndicator
boolean

Indicates whether the postal address is from a foreign country.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

townLocationName
string [ 1 .. 35 ] characters
Example: "Clackamas"

Specific location name within the town.

districtName
string [ 1 .. 35 ] characters
Example: "Columbia"

Identifies a subdivision within a country sub-division.

countyName
string [ 1 .. 35 ] characters
Example: "Cook"

Identifies a county within a country sub-division.

countrySubDivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

countrySubDivisionCode
string (CountrySubdivisionCode) ^[A-Z]{2,2}\-[0-9A-Z]{1,3}
Example: "AR-B"

Code to identify a name of a unit resulting from the division of a country, dependency, or other area of special geopolitical interest contained in ISO 3166-1, on the basis of country names obtained from the United Nations (ISO 3166-2: Country subdivision code).

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

addressLine
Array of strings[ items [ 1 .. 70 ] characters ]
Example: ["11407 Sw Amu st, Suite MY777"]

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

temporaryIndicator
boolean
Example: true

Indicates whether the address is temporary or not.

object

The period of use of the address information. Could be also used as a recurring anual period.

Array of objects (GenericCode)

Codes related to postal address or internal handling codes associated with the address. Possible Values: HandlingCode, HandlingCodeOption, AddressFormat.

Array of objects (GenericIdentification)

Postal address identifiers are used to identify parties that share the same address or to associate an existing address with a specific party. Possible scheme name values: AddressIdentifier.

object (FinancialInstitution)
Array of objects (OrganizationIdentification)
clearingSystemMemberIdentification
string (ClearingSystemIdentification) [ 1 .. 60 ] characters
Example: "UnitedStatesRoutingNumberFedwireNACHA"

Specifies the clearing system member identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: UnitedStatesRoutingNumberFedwireNACHA, AustrianBankleitzahl, AustralianBankStateBranchCodeBSB,CanadianPaymentsAssociationPaymentRoutingNumber,SwissFinancialInstitutionIdentificationShort,SwissFinancialInstitutionIdentificationLong,CNAPSIdentifier, GermanBankleitzahl, SpanishDomesticInterbankingCode, UKDomesticSortCode, HellenicBankIdentificationCode, HongKongBankCode, IrishNationalClearingCode, IndianFinancialSystemCode, ItalianDomesticIdentificationCode, JapanZenginClearingCode, NewZealandNationalClearingCode, PolishNationalClearingCode, PortugueseNationalClearingCode, RussianCentralBankIdentificationCode, SwedenBankgiroClearingCode, IBGSortCode, ThaiCentralBankIdentificationCode, FinancialInstitutionCode, CHIPSParticipantIdentifier, SouthAfricanNationalClearingCode, NewZealandRTGSClearingCode

memberIdentification
string [ 1 .. 35 ] characters
name
string [ 1 .. 35 ] characters
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string (CountrySubdivision) [ 1 .. 35 ] characters
Example: "Oregon"

Name of a country subdivision such as state, region, county.

townName
string (TownName) [ 1 .. 35 ] characters
Example: "San Diego"

Name of a built-up area, with defined boundaries, and a local government. Also city name.

country
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

birthDate
string <date>
Example: "2022-04-17"

Date on which a person is born.

object (PaymentPartyContactDetails)

Specifies the contact details of a person.

Array of objects (GenericContact)
preferredMethod
string [ 1 .. 35 ] characters
Example: "Email"

Preferred method used to reach the contact, in PascalCase form. Possible values are:
Letter, Email, Phone, Fax, MobileOrCellPhone.

preferredLanguage
string (PreferredLanguage) [ 1 .. 35 ] characters
Example: "English"

Language of the contact person. Names according to the language list provided in the ISO 639-1 codes. Some possible values: Chinese, Spanish, French, English, Japanese, Italian, German, Default.

Array of objects (PartyGenericIdentification)
Array
number
required
string [ 1 .. 40 ] characters
Example: "123-45-6789"

Unique and unambiguous identification of an organization.

schemeName
required
string (PartySchemeName) [ 1 .. 35 ] characters
Example: "TaxIdentificationNumber"

Name of the identification scheme, in PascalCase form. Possible values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET BusinessDomainIdentifier BusinessOtherIdentification AlienRegistrationNumber ResidentAlienCard PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification LEIIdentifier BICIdentifier PermanentAccountNumberCard

issuer
string
Example: "UnitedStates"

Entity that assigns the identification.

issueDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

expirationDate
string <date> (Date)
Example: "2022-04-17"

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format.

countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

notifyPartyIndicator
boolean
object (RemittanceInformation)

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.

remittanceNumber
required
string [ 1 .. 60 ] characters

Unique and unambiguous identification of the remittance document

documentType
required
string [ 1 .. 60 ] characters

Specifies a type of financial or commercial document. Possible values are: MeteredServiceInvoice, CreditNoteRelatedToFinancialAdjustment, DebitNoteRelatedToFinancialAdjustment, CommercialInvoice, CreditNote, DebitNote, HireInvoice, SelfBilledInvoice, CommercialContract, StatementOfAccount, DispatchAdvice, BillOfLading, Voucher, AccountReceivableOpenItem, TradeServicesUtilityTransaction, PurchaseOrder

object (Document)

General information related to a physical document, such as identification number and issue date time.

documentReference
string [ 1 .. 35 ] characters

Document location.

format
string (DocumentFormat) [ 1 .. 35 ] characters
Example: "PDF"

Specifies a choice of format for a document. Possible Values: PDF, HTML.

title
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
version
string [ 1 .. 18 ] characters

Document version indentification.

signOffDate
string <date>
Example: "2022-04-17"

Signoff date of the document.

issueDate
string <date>
Example: "2022-04-17"

Issue date of the document.

purpose
string [ 1 .. 100 ] characters

Specifies the function of the document.

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchange": {
    },
  • "valueDate": "2022-04-17",
  • "expirationDate": "2022-04-17",
  • "creditor": {
    },
  • "debtor": {
    },
  • "remittanceInformation": {
    }
}

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchange": {
    },
  • "valueDate": "2022-04-17",
  • "expirationDate": "2022-04-17",
  • "creditor": {
    },
  • "debtor": {
    },
  • "remittanceInformation": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "date": "2022-04-17T08:00:00Z"
}

Creditor Payment Activation Status

Returns the status report of a creditor payment activation, process and excecution.

Authorizations:
jwtopenIdConnect
path Parameters
paymentId
required
string (PaymentId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Identification of the Payment.

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchange": {
    },
  • "check": {
    },
  • "valueDate": "2022-04-17",
  • "dueDate": "2022-04-17",
  • "creditor": {
    },
  • "debtor": {
    },
  • "remittanceInformation": {
    },
  • "settlement": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "date": "2022-04-17T08:00:00Z"
}

Standing Orders

Retrieves Account Standing Orders

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

query Parameters
standingOrderId.eq
string (Id) [ 1 .. 300 ] characters
Example: standingOrderId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
lookUpReference.eq
string
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "standingOrders": [
    ]
}

Creates a Standing Order

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
paymentType
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

standingOrderType
string (StandingOrderType) [ 1 .. 36 ] characters
Example: "OneTime"

Standing order category. Possible values: OneTime, Recurring, Predefined, Overdraw, Dividend, Maturity, SweepIn, SweepOut, SweepInOut.

amountType
string (StandingOrderAmountType) [ 1 .. 36 ] characters
Example: "OneTime"

Type of amount of the payment. Possible values: MinimumDue, CurrentBalance, FullStatement, FixedAmount.

recurrenceDateType
string (StandingOrderDateType) [ 1 .. 36 ] characters
Example: "OneTime"

Type of recurrence date of the payment. Possible values: OnTimeDue, SpecificDay.

paymentReasons
Array of strings (PaymentPurpose) [ items [ 1 .. 60 ] characters ]
Example: ["CashManagementTransfer"]
orderSequence
integer
Example: 1

Specifies the sequence in which the system will execute the liquidity transfers standing order within the set.

object (Frequency)

Dates during which the standing order is in effect

fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

cycleType
string [ 1 .. 35 ] characters

Specifies a cycle type. Possible values: Temporal, AtMaturity, InterestCycle, FromLastStatement, LastDay, AutoPay, Immediate, SkipFirst, SkipLast, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Shift, EndOfTheMonth

cycle
string [ 1 .. 35 ] characters
Example: "Monthly"

Specifies a temporal cycle. Possible values: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Once, IntraDay, Overnight, Fortnightly, Semimonthly, XHours, XDays, XWeeks, XMonths, XYears.

every
integer <= 999
Example: 15

Custom cycle definition. Number of XDays, XWeeks, XMonths, XYears.

weekDay
string <= 10 characters
Example: "Tuesday"

Day of the week. Possible Values: Monday, Tuesday, Wednesday, Thursday, Friday.

weekNumbers
Array of strings[ items <= 3 characters ]
Example: ["1st"]
days
Array of integers[ items <= 31 ]
Example: [30]
months
Array of strings[ items <= 12 characters ]
Example: ["12"]
startDay
string (MonthDay) ([0-9]{2})-([0-9]{2})
Example: "04-17"

A particular point in the year expressed in the MM-DD format.

numberOfTimes
integer
Example: 4

Number of times the event will be repeated.

eventDescription
string [ 1 .. 1025 ] characters
Example: "This is a description."

Describes the event which triggers the exercise of a standing order for instance the reception of a report or the closing of an account.

object

Specifies the hour of the day for the time event.

hour
string <time-hour>
Example: "12"
timeZone
string (TimeZone) [ 1 .. 30 ] characters
Example: "Pacific"

A time zone is an area which observes a uniform standard time for legal, commercial and social purposes. Some possible values: Pacific, Mountain, Central, Eastern, GreenwichMean

timeOfTheDay
string

Time of the day. Possible Values: AfterMidnight, after midnight and before business day; AfterBusinessDay, after business day and before midnight.

object (CreditTransferDetail)

Further details on the credit transfer instruction

Array of objects (PaymentIdentification)
Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

paymentMethod
required
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

paymentType
required
string (PaymentType) [ 1 .. 35 ] characters
Example: "OnUs"

Specifies the type of Payment. Possible values: LiquidityTransfer, OnUs, ACH, Wire, NotOnUs.

amount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

taxAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Tax amount to be deducted.

creditorAccountId
string (AccountId) [ 1 .. 300 ] characters
Example: "033-DDA-123456"

Identification assigned by the account service institution (Servicer). Could be encoded (UUID). Also may be used as composite account identifier when overlaying the account code parts. branch-type-subtype-number

object (PaymentProcessingDetail)

Provides further details of the type of payment.

instructionPriority
string (InstructionPriority) [ 1 .. 35 ] characters
Example: "123456789"

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. Possible values are: High, Normal.

serviceLevel
string (ServiceLevel) [ 1 .. 35 ] characters
Example: "BookTransaction"

Specifies a pre-agreed service between the parties. Some ISO compliant values from ExternalServiceLevel1Code are: BookTransaction, TrackedCustomerCreditTransfer, TrackedStopAndRecall, TrackedOutboundCorporateTransfer, TrackedFinancialInstitutionTransfe, NonurgentPriorityPayment, NonurgentPayment, EBAPriorityService, SameDayValue, DomesticChequeClearingAndSettlement, UrgentPayment, UrgentPaymentNetSettlement, InstantCreditTransferOrInstantDirectDebit, ServiceRequestToPay, ScheckVerarbeitungAustria, TrackedCaseManagement, TrackedInboundCustomerCreditTransfer, TrackedInstantCustomerCreditTransfer, TrackedLowValueCrossBorderCustomerCreditTransfer.

clearingChannel
string (ClearingSystem) [ 1 .. 35 ] characters
Example: "ACH"

Specifies the clearing system identification. Some ISO compliant values from ExternalCashClearingSystem1Code are: USFedACH, USFedNow, USFedwireFunds, ACH, EBAEuro1Step1, CanadaACSS, Albania, Austrian, NewZealand, Azerbaijan, BosniaHerzegovina, SwedenBGC, Ecuador, Barbados, Belgium, Bulgaria, Bahamas, Botswana, Finland, BankOfJapanNet, Italy, Philippines, CanadaCAD, SpainCAM, CentralBankOfArubaCSM, CentraleBankVanCuraçaoEnSintMaartenCSM, Ireland, Peru, USTCHChips,UnitedKingdom, China, CentralInteroperabilityService, ColumbiaCEDEC, ColumbiaCENIT, ColumbiaCUD, DenmarkDDK,Denmark, EBAEuro1, GermanyELS, Germany, ECB, USTCHEPN, EBAStep1, ForeignExchangeYenClearing, FasterPaymentsServices, Ghana, HongKongCHAT, HongKongFPS, Croatia, Greece, Hungary, SpainIberpayInstantPayments, DEandNLEquens, IndiaImmediatePaymentService, Jordan, Kenya, Luxemburg, SriLanka, Latvia, CanadaLVTS, LynxCanada, Singapore, SouthAfrica, MacaoRTGS, Malta, Mauritius, Namibia, Norway, NorwayNICSReal, AustraliaNPP, USNSS, NewZealandRTGS, Switzerland, AustraliaPDS, Egypt, FrancePNS, AustrianCSM, Angola, Venezuela, RomaniaEPO, RomaniaGSRS, RTGS, GermanyRTGSPlus, RTRCanada, RPSAndSEPAClearer, Chili, SwedenSEC, euroSIC, SIC, SICIP, Slovania, SpainES, Portugal, SwedenSSK, EBAClearingSTEP2, UnitedKingdomGBP, FranceFR, USTCHRealTime, Target, Thailand, Thailand-NITMX, Tanzania, Netherlands, TrinidadAndTobago, CanadaUSBE, Uganda, IndiaUnifiedPaymentsInterface, VocaLink, EBASTEP2XCT, Zengin, Zimbabwe, Zambia, Iceland, NorwayRTGS, NGInterswitch, P27RealTime, P27, UnitedKingdomUKD, SingaporeSCRIPS, RIXRTGSSverigesRiksbank

localInstrument
string (LocalInstrument) [ 1 .. 35 ] characters
Example: "CCD"

This element is used to specify a local clearing option and/or qualify the service or service level. For ACH service Level offers more detailed information about the authorization method of the ACH transaction. Posible values for ACH Entry Class or SEC code: PPD, CCD, CTX

categoryPurpose
string (CategoryPurpose) [ 1 .. 35 ] characters
Example: "SalaryPayment"

Specifies the high level purpose of the instruction based on a set of pre-defined categories. Usage: This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain. Some ISO compliant values are from ExternalCategoryPurpose1Code: BonusPayment, CashManagementTransfer, CardBulkClearing, CreditCardPayment, TradeSettlementPayment, DebitCardPayment, Dividend, DeliverAgainstPayment, EPayment,FeeCollectionAndInterest, FeeCollection,PersontoPersonPayment, GovernmentPayment, Hedging, IrrevocableCreditCardPayment, IrrevocableDebitCardPayment, IntraCompanyPayment, Interest, LockboxTransactions, Loan, Commercial, Consumer, PensionPayment, Represented, ReimbursementReceivedCreditTransfer, ReceiveAgainstPayment, SalaryPayment, Securities, SocialSecurityBenefit, SupplierPayment, TaxPayment, Trade, TreasuryPayment, ValueAddedTaxPayment, WithHolding, CashManagementSweepAccount, CashManagementTopAccount, CashManagementZeroBalanceAccount

chargeBearerType
string (ChargeBearerType) [ 1 .. 35 ] characters
Example: "Shared"

Specifies which party(ies) will pay charges due for processing of the instruction. BorneByDebtor, BorneByCreditor, Shared, FollowingServiceLevel

object (PartyIdentification)
name
string (PartyName) [ 1 .. 350 ] characters
Example: "Jane Birkin"

Name by which a party is known and which is usually used to identify that party.

object (PaymentAccount)
paymentReference
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
object (PostalAddress)

Information that locates and identifies a specific address, as defined by postal services.

object (FinancialInstitution)
object (PlaceAndDateOfBirth)

Date and place of birth of a person.

object (PaymentPartyContactDetails)

Specifies the contact details of a person.

Array of objects (PartyGenericIdentification)
countryOfResidence
string (CountryCode) ^([A-Z]{2,2})?$
Example: "US"

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

notifyPartyIndicator
boolean
lastPaymentDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date of the last payment.

nextPaymentDate
string <date>
Example: "2022-04-17"

Date of the next payment.

failedCount
integer

The number of times a standing order payment has failed to be processed.

delayDays
integer <= 31
Example: 30

Period between when a standing order is set to be executed and when it actually processes.

authorizationChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

paymentMethod
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

convenienceFeeRefundAmount
string <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

A convenience fee refund amount refers to the money that is returned to a customer when a convenience fee is refunded. A convenience fee is an additional charge for making a payment through a particular method, such as online or over the phone, as opposed to a standard method like cash or check.

enableIndicator
boolean

Indicates whether the standing order is enabled.

minimumIndicator
boolean

Indicates whether the standing order pays the least amount required to keep the account in good standing.

depositMatchIndicator
boolean

Indicates whether a transaction qualifies for promotional offer.

status
string (StandingOrderStatus) [ 1 .. 36 ] characters
Example: "Sent"

Specifies the status of a standing order request. Possible values: Cancelled, Pending, Sent.

statusReasonDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
statusReason
string (StatusReason) [ 1 .. 36 ] characters
Example: "BlockedAccount"

Reason for the status. Possible Values: AbortedClearingTimeout, AbortedClearingFatalError, AbortedSettlementTimeout, AbortedSettlementFatalError,TimeoutCreditorAgent, TimeoutInstructedAgent, OfflineAgent, OfflineCreditorAgent, ErrorCreditorAgent, ErrorInstructedAgent, TimeoutDebtorAgent,IncorrectAccountNumber, InvalidDebtorAccountNumber,InvalidCreditorAccountNumber, ClosedAccountNumber,ClosedDebtorAccountNumber, BlockedAccount,ClosedCreditorAccountNumber, InvalidBranchCode,InvalidAccountCurrency, InvalidDebtorAccountCurrency,InvalidCreditorAccountCurrency, InvalidAccountType,InvalidDebtorAccountType,InvalidCreditorAccountType,AccountDetailsChanged, CardNumberInvalid, TransactionForbidden, InvalidBankOperationCode, TransactionNotSupported, InvalidAgentCountry, InvalidDebtorAgentCountry, InvalidCreditorAgentCountry, UnsuccesfulDirectDebit, InvalidAccessRights,PaymentNotReceived, AgentSuspended,CreditorAgentSuspended, NotAllowedBookTransfer, ForbiddenReturnPayment, IncorrectAgent, ZeroAmount, NotAllowedAmount, NotAllowedCurrency, InsufficientFunds, Duplication, TooLowAmount, BlockedAmount, WrongAmount, InvalidControlSum, InvalidTransactionCurrency, InvalidAmount, AmountExceedsClearingSystemLimit, AmountExceedsAgreedLimit, AmountBelowClearingSystemMinimum, InvalidGroupControlSum, InvalidPaymentInfoControlSum, InvalidNumberOfTransactions,InvalidGroupNumberOfTransactions, InvalidPaymentInfoNumberOfTransactions, LimitExceeded, ZeroAmountNotApplied, AmountExceedsSettlementLimit, InconsistenWithEndCustomer, MissingCreditorAddress, UnrecognisedInitiatingParty, UnknownEndCustomer, MissingDebtorAddress, MissingDebtorName, InvalidCountry, InvalidDebtorCountry, InvalidCreditorCountry, InvalidCountryOfResidence, InvalidDebtorCountryOfResidence, InvalidCreditorCountryOfResidence, InvalidIdentificationCode, InvalidDebtorIdentificationCode, InvalidCreditorIdentificationCode, InvalidContactDetails, InvalidChargeBearerCode, InvalidNameLength, MissingName, MissingCreditorName, AccountProxyInvalid, CheckERI, RequestedExecutionDateOrRequestedCollectionDateTooFarInFuture, RequestedExecutionDateOrRequestedCollectionDateTooFarInPast, ElementIsNotToBeUsedAtB-andC-Level, MandateChangesNotAllowed, InformationOnMandateChangesMissing, CreditorIdentifierIncorrect, CreditorIdentifierNotUnambiguouslyAtTransaction-Level, OriginalDebtorAccountIsNotToBeUsed, OriginalDebtorAgentIsNotToBeUsed, ElementContentIncludesMoreThan140Characters, ElementContentFormallyIncorrect, ElementNotAdmitted, ValuesWillBeSetToNextTARGETday, DecimalPointsNotCompatibleWithCurrency, RequiredCompulsoryElementMissing, COREandB2BwithinOnemessage, ChequeSettledOnCreditorAccount, CreditorBankIsNotRegistered, IncorrectCurrency, RequestedByCustomer, DebtorBankIsNotRegistered,ElectronicSignaturesCorrect, OrderCancelled, OrderNotCancelled, OrderRejected, OrderForwardedForPostprocessing, TransferOrder, ProcessingOK, DecompressionError, DecryptionError, DataSignRequested, UnknownDataSignFormat, SignerCertificateRevoked, SignerCertificateNotValid, IncorrectSignerCertificate, SignerCertificationAuthoritySignerNotValid, NotAllowedPayment, NotAllowedAccount, NotAllowedNumberOfTransaction, Signer1CertificateRevoked, Signer1CertificateNotValid, IncorrectSigner1Certificate, SignerCertificationAuthoritySigner1NotValid, UserDoesNotExist, IdenticalSignatureFound, PublicKeyVersionIncorrect, DifferentOrderDataInSignatures, RepeatOrder, ElectronicSignatureRightsInsufficient, Signer2CertificateRevoked, Signer2CertificateNotValid, IncorrectSigner2Certificate, SignerCertificationAuthoritySigner2NotValid, WaitingTimeExpired, OrderFileDeleted, UserSignedMultipleTimes, UserNotYetActivated, InvalidDate, InvalidCreationDate, InvalidNonProcessingDate, FutureDateNotSupported, InvalidCutOffDate, ExecutionDateChanged, DuplicateMessageID, DuplicatePaymentInformationID, DuplicateTransaction, DuplicateEndToEndID, DuplicateInstructionID, DuplicatePayment, CorrespondentBankNotPossible, BalanceInfoRequest, SettlementFailed, SettlementSystemNotAvailable, ERIOptionNotSupported, InvalidFileFormat, SyntaxError, InvalidPaymentTypeInformation, InvalidServiceLevelCode, InvalidLocalInstrumentCode, InvalidCategoryPurposeCode, InvalidPurpose, InvalidEndToEndId, InvalidChequeNumber, BankSystemProcessingError, ClearingRequestAborted, PaymentTransferredAndTracked, PaymentTransferredAndNotTracked, CreditDebitNotConfirmed, CreditPendingDocuments, CreditPendingFunds, DeliveredWithServiceLevel, DeliveredWIthoutServiceLevel, CorrespondingOriginalFileStillNotSent, NoMandate, MissingMandatoryInformationInMandate, CollectionNotDue, RefundRequestByEndCustomer, EndCustomerDeceased, NotSpecifiedReasonCustomerGenerated, NotSpecifiedReasonAgentGenerated, Narrative, NoERI, BankIdentifierIncorrect, InvalidBankIdentifier, InvalidDebtorBankIdentifier, InvalidCreditorBankIdentifier, InvalidBICIdentifier, InvalidDebtorBICIdentifier, InvalidCreditorBICIdentifier, InvalidClearingSystemMemberIdentifier, InvalidDebtorClearingSystemMemberIdentifier, InvalidCreditorClearingSystemMemberIdentifier, InvalidIntermediaryAgent, MissingCreditorSchemeId, RMessageConflict, ReceiverCustomerInformation,NotUniqueTransactionReference, MissingDebtorAccountOrIdentification, MissingDebtorNameOrAddress, MissingCreditorNameOrAddress, RegulatoryReason, RegulatoryInformationInvalid, TaxInformationInvalid, RemittanceInformationInvalid, RemittanceInformationTruncated, InvalidStructuredCreditorReference, InvalidCharacterSet, InvalidDebtorAgentServiceID, InvalidPartyID, ValidRequestForCancellationAcknowledged, UETRFlaggedForCancellation, NetworkStopOfUETR, RequestForCancellationForwarded, RequestForCancellationDeliveryAcknowledgement, SpecificServiceOfferedByDebtorAgent, SpecificServiceOfferedByCreditorAgent, ServiceofClearingSystem, CreditorNotOnWhitelistOfDebtor, CreditorOnBlacklistOfDebtor, MaximumNumberOfDirectDebitTransactionsExceeded, MaximumDirectDebitTransactionAmountExceeded, TransmissonAborted, NoDataAvailable, FileNonReadable, IncorrectFileStructure, TokenInvalid, SenderTokenNotFound, ReceiverTokenNotFound, TokenMissing, TokenCounterpartyMismatch, TokenSingleUse, TokenSuspended, TokenValueLimitExceeded, TokenExpired, InvalidCutOffTime, TransmissionSuccessful, TransferToSignByHand, AuthorisationCancelled, FollowingCancellationRequest, Fraud, NotCompliantGeneric, NoAnswerFromCustomer, ReturnUponUnableToApply, UnduePayment, AlreadyAcceptedRTP, AlreadyExpiredRTP, AlreadyRefusedRTP, AlreadyRejectedRTP, AttachementsNotSupported, ExpiryDateTimeReached, ExpiryDateTooLong, FraudulentOrigin, IncorrectExpiryDateTime, InitialRTPNeverReceived, NonAgreedRTP, NoPaymentGuarantee, PayerOrPayerRTPSPNotReachable, RTPNotSupportedForDebtor, RTPReceivedCanBeProcessed, RTPServiceProviderIdentifierIncorrect, TypeOfPaymentInstrumentNotSupported, UnknownCreditor, OriginalTransactionNotEligibleForRequestedReturn, RequestForCancellationNotFound, SettlementNotReceived

Array of objects (GenericCode)

Codes related to the standing order. Possible values: ACHRecurringCalendarDay, AutoPaymentChargeDda, AutoPaymentEnrollType.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
paymentDescription
string (Description) [ 1 .. 1025 ] characters
Example: "This is a description."
Array of objects (Balance)

Transference blances.

Array
fromDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period starts.

upToDateTime
string <date-time>
Example: "2022-04-17T08:00:00Z"

Date and time at which the period ends.

periodNumber
integer

Sequence number of the period.

periodName
string (PeriodName)

Time of the year or previous. Possible Values: YearToDate, MonthToDate, PreviousYear, BeginningPreviousYear, QuarterToDate, PreviousQuarter, YearEnd, Last, Lifetime, SinceLastStatement, SinceLastRate, Initial.

balanceName
string (BalanceName) [ 1 .. 50 ] characters
Example: "Available"

Specifies the nature of the balance. Possible values: Current, Available, Pending, Opening, Blocked, Previous, RelatedBalance, OnHold, PendingLedger, Collected, LastAnniversary, CurrentAccrued, PreviousAccrued, CurrentWithLastCalculus, CarriedAdjustment, PaidWithPenalties, Accrued, Penalty, Fees, Withholding, CollectionLedger, LastLedger, CurrentLedger, Ledger, MinimumAvailable, MinimumLedger, Withheld, CurrentBooked, CurrentBook, LastDeposit, FloatAmount, Average, RegulationDDAvailable. Loan Balances: CashProceeds, the amount that a customer actually received, exclusive of insurance premiums, fees, and unearned discount; FinancedExpenses, indicates the amount of expenses an institution has financed for a borrower; TotalInterest; AdditionalInterest, if the date of the first payment is beyond one month from the note date, the interest for the odd days will be earned during the first interest period; DeferredUnsecuredPrincipal, is the outstanding balance of an unsecured debt. The DUPB includes any accrued interest that is yet to be paid by the borrower. The deferral typically occurs due to bankruptcy or debt relief proceedings, which temporarily halt collection efforts by the original creditor; Charge Balances: Earned, RealTimeDeliveryMaximum, Current, Financed, Prepaid, CurrentEarned, CurrentEarnedOtherEscrow, InterestPaidToDate, InterestPaidThisYear, InterestPaidPreviousYear, InterestPaidLastStatement, InterestPaidThisYear, RevolvingCreditPaid, BasePaidToDate, TotalPastDue, Escrow, AppliedEscrow, UnpaidEscrow, EscrowBucket, Principal, Interest, Fees, BilledFees, OtherEscrow, FinalAmount, FinalInterestAmount, Chapter4PreviousYear, Payments: Delinquent, FixPayment, Transaction, LoanPayOff, PrincipalAndInterest, AvailableCash, AvailableCheck, AvailableCredit, Sweep, Float, MemoLedger, Memo, AvailablePending, LedgerPending.

amount
string (Amount) <= 23 characters ^-?([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: -9999999999999.99999999

count
integer

Number of transactions added to the amount.

currency
string (CurrencyCode) = 3 characters ^([A-Z]{3})?$
Example: "USD"

Three contiguous letters for the representation of currencies and funds. Valid currency codes are registered with the ISO 4217 Maintenance Agency.

calculationDate
string <date-time>
Example: "2022-04-17T08:00:00Z"

Specifies the date and time at which the balance is calculated.

Array of objects (GenericCode)

Bank defined codes to classify balances. Possible values: BalanceCategory, BalanceType, PartyAgreementNumber.

Responses

Request samples

Content type
application/json
{
  • "paymentType": "OnUs",
  • "standingOrderType": "OneTime",
  • "amountType": "OneTime",
  • "recurrenceDateType": "OneTime",
  • "paymentReasons": [
    ],
  • "orderSequence": 1,
  • "frequency": {
    },
  • "eventDescription": "This is a description.",
  • "timeOfDay": {
    },
  • "paymentInstruction": {
    },
  • "lastPaymentDate": "2022-04-17T08:00:00Z",
  • "nextPaymentDate": "2022-04-17",
  • "failedCount": 0,
  • "delayDays": 30,
  • "authorizationChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "convenienceFeeRefundAmount": "100",
  • "enableIndicator": true,
  • "minimumIndicator": true,
  • "depositMatchIndicator": true,
  • "status": "Sent",
  • "statusReasonDescription": "This is a description.",
  • "statusReason": "BlockedAccount",
  • "codes": [
    ],
  • "paymentDescription": "This is a description.",
  • "balances": [
    ]
}

Response samples

Content type
application/json
{
  • "paymentType": "OnUs",
  • "standingOrderType": "OneTime",
  • "amountType": "OneTime",
  • "recurrenceDateType": "OneTime",
  • "paymentReasons": [
    ],
  • "orderSequence": 1,
  • "frequency": {
    },
  • "eventDescription": "This is a description.",
  • "timeOfDay": {
    },
  • "paymentInstruction": {
    },
  • "lastPaymentDate": "2022-04-17T08:00:00Z",
  • "nextPaymentDate": "2022-04-17",
  • "failedCount": 0,
  • "delayDays": 30,
  • "authorizationChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "convenienceFeeRefundAmount": "100",
  • "enableIndicator": true,
  • "minimumIndicator": true,
  • "depositMatchIndicator": true,
  • "status": "Sent",
  • "statusReasonDescription": "This is a description.",
  • "statusReason": "BlockedAccount",
  • "codes": [
    ],
  • "paymentDescription": "This is a description.",
  • "balances": [
    ],
  • "standingOrderId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "statusDateAndTime": "2022-04-17T08:00:00Z",
  • "cancellationReason": "This is a description."
}

Standing Order Status

Returns the status of a standing order.

Authorizations:
jwtopenIdConnect
path Parameters
standingOrderId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Standing Order Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "BlockedAccount",
  • "charges": [
    ],
  • "relatedAccounts": [
    ],
  • "parties": [
    ],
  • "balances": [
    ],
  • "identifiers": [
    ],
  • "codes": [
    ],
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "OnUs",
  • "amount": "100",
  • "paymentReasons": [
    ],
  • "debtorAccountId": "033-DDA-123456",
  • "creditorAccountId": "033-DDA-123456",
  • "purpose": "This is a description.",
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "mandate": {
    },
  • "requestedCollectionDate": "2022-04-17",
  • "debtor": {
    }
}

Updates a standing order

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
standingOrderId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Standing Order Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/merge-patch+json
{ }

Account Payments

Creates a rigt time payment associated with a specific card account.

Creates a rigt time payment associated with a specific card account. A rigt time payment is processed to temporarily adjust the member's credit and delinquency attributes without waiting for nightly processing.

Authorizations:
jwtopenIdConnect
path Parameters
cardId
required
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Card Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
amount
string (PositiveAmount) <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: 0

paymentDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
cardNumber
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

Array of objects (PaymentIdentification)

Payment identifification

Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

paymentChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

paymentMethod
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

Array of objects (GenericCode)

Codes to link the payment, with other systems or to classify the payment.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."

Responses

Request samples

Content type
application/json
{
  • "amount": "100",
  • "paymentDate": "2022-04-17T08:00:00Z",
  • "cardNumber": "1234567890123456789",
  • "identifiers": [
    ],
  • "paymentChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "amount": "100",
  • "paymentDate": "2022-04-17T08:00:00Z",
  • "cardNumber": "1234567890123456789",
  • "identifiers": [
    ],
  • "paymentChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "codes": [
    ],
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted"
}

Request Right Time Payment Cancellation

Authorizations:
jwtopenIdConnect
path Parameters
paymentId
required
string (PaymentId) [ 1 .. 36 ] characters
Example: 0dd926fe-1ca2-11ed-861d-0242ac120002

Identification of the Payment.

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
amount
string (PositiveAmount) <= 23 characters ^([0]|([1-9][0-9]{0,12}))([.][0-9]{0,8})?$
Example: "100"

Number of monetary units where the size of the decimal part is defined by the currency. Note: total number of digits: 21 number of digits in fractional part: 8 maxInclusive: 9999999999999.99999999 minInclusive: 0

paymentDate
string <date-time> (DateAndTime)
Example: "2022-04-17T08:00:00Z"
cardNumber
string (PrimaryAccountNumber) [ 1 .. 19 ] characters
Example: "1234567890123456789"

Primary Account Number (PAN) of the card.

Array of objects (PaymentIdentification)

Payment identifification

Array
number
required
string [ 1 .. 40 ] characters

Unique and unambiguous identification of a payment.

schemeName
string [ 1 .. 40 ] characters
Example: "UETR"

Name of other payment identificaction. For instance, ISOInitiationMessageIdentifier, InstructionIdentification (Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period), UETR (Universally unique identifier to provide an end-to-end reference of a payment transaction), ExecutionIdentification, EndToEndIdentification, InstructionIdentification, TransactionIdentification, ClearingSystemReference, CreditorReference, CounterpartyReference, UniqueTradeIdentifier, ClearingBrokerIdentification, UniqueTradeIdentifier, ClearingBrokerIdentification, CommonIdentification, ReferenceNumber, TracerNumber, DraftNumber.

issuer
string
Example: "Baltimore"

Entity that assigns the identification.

paymentChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

paymentMethod
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

Array of objects (GenericCode)

Codes to link the payment, with other systems or to classify the payment.

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."
paymentId
string (PaymentId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification of the Payment.

Responses

Request samples

Content type
application/json
{
  • "amount": "100",
  • "paymentDate": "2022-04-17T08:00:00Z",
  • "cardNumber": "1234567890123456789",
  • "identifiers": [
    ],
  • "paymentChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "codes": [
    ],
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002"
}

Response samples

Content type
application/json
{
  • "amount": "100",
  • "paymentDate": "2022-04-17T08:00:00Z",
  • "cardNumber": "1234567890123456789",
  • "identifiers": [
    ],
  • "paymentChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "codes": [
    ],
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted"
}

Retrieves the payments made to an account.

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

query Parameters
cursor
string

Specifies an opaque string value ( "no meaning" string value) at which start retrieving transactions. For instance, limit=5&cursor=62aef884fbe3470ce7d9a92140b09b17

limit
string

Specifies the number of resources to return in one request, specified as an integer from 1 to 100.

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Pagination-Cursor
string

Pagination Cursor

Pagination-Total
string

Total number of resources.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "payment": [
    ]
}

External Provider Accounts

Retrieves external provider accounts linked to particular account

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

query Parameters
externalAccountId.eq
string (Id) [ 1 .. 300 ] characters
Example: externalAccountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
lookUpReference.eq
string
name.inc
string

The person name includes the substring provided.

lastName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: lastName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

firstName.eq
string (PartyName) [ 1 .. 350 ] characters
Example: firstName.eq=Jane Birkin

Name by which a party is known and which is usually used to identify that party.

paymentMethod.eq
string
authorizationChannel.eq
string
agreedToTermsIndicator.eq
boolean
header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountId": "033-DDA-123456",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "ownershipType": "SingleOwnerAccount",
  • "accounts": [
    ]
}

Creates an external provider account linked to particular account.

Creates an external account within a payment provider platform, associated with the designated account.

Authorizations:
jwtopenIdConnect
path Parameters
accountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

Account Identification

header Parameters
idempotencyId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Request Body schema: application/json
accountBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: "SEA_1"

Identification of the account servicer institution at branch level or center level. To overlay the codes to produce a unique identifier the following expresion is used: BranchRegionCode-BranchSubdivisionCode.

accountNumber
string (AccountNumber) <= 30 characters
Example: "012345678"

The account number or Basic Bank Account Number (BBAN). A Basic Bank Account Number (BBAN) is a bank account number that includes the domestic bank code, branch identifier, and account number. It is a unique identifier for a bank account within a specific country.

accountType
string (AccountType) [ 1 .. 60 ] characters
Example: "Checking"

Type of the account. Some possible ISO 20022 compliant values are: Checking, CardAccount, CashPayment, Charges, CashIncome, Commission, ClearingParticipantSettlementAccount, LimitedLiquiditySavingsAccount, MarginalLending, MoneyMarket, NonResidentExternal, Overdraft, OverNightDeposit, Settlement, Salary, Savings, Tax, TransactingAccount, CashTrading, VirtualAccount, CreditCard, DebitCard, Universal, Investment, EpurseCard, CertificateOfDeposit, MoneyMarketChecking, RetirementAccount, RetireeReimbursementAccount, StockOrBond, PrePaid, FleetCard, Cash, DebitAccount, CreditAccount, Benefit, HealthSavingsAccount, FlexibleSpendingAccount, ForBenefitOf, Estate, ClientTrustAccount, LawyersTrustAccount, KeoghPlanAccount, UniformTransfersToMinorsAct, UniformGiftsToMinorsAct, ReserveFunds, SelfDirectedBrokerage, IRA, Annuity, ExternalAccount, Loan, CommercialLoan, MortgageLoan, SafeDepositBox.

Array of objects (RoutingNumber)
Array
number
string (ABANumber) = 9 characters
Example: "012345678"

The routing number (sometimes referred to as an ABA routing number, regarding the American Bankers Association) is a sequence of nine digits used by banks to identify specific financial institutions within the United States.

routingNumberType
string (RoutingNumberType) = 9 characters
Example: "ACH"

Different types of payments may require different bank routing numbers. Some possible values: ACH, WIRE, ElectronicCheck, PaperCheck

Array of objects (AccountIdentification)
Array
number
string [ 1 .. 40 ] characters

Identification assigned by an institution or internally to connect to other applications.

schemeName
string [ 1 .. 40 ] characters
Example: "BBANIdentifier"

Name of the identification scheme, in PascalCase. Possible ISO 20022 compliant values names are: IssuerIdentificationNumber, BBANIdentifier, CHIPSUniversalIdentifier, UPICIdentifier, IBANIdentifier. Other possible values: CreditBackIdentification, UniversalLoanIdentifier, HMDAUniversalLoanIdentifier, CommitmentNumber, RecordNumber, FlexDataRecordNumber, RegistrationNumber, ExternalAccountId, MortgageNumber, DepartmentNumber.

issuer
string [ 1 .. 35 ] characters

Entity that assigns the identification.

externalAccountId
string [ 1 .. 300 ] characters
Example: "5fb9d4d6-1a3c-11ed-861d-0242ac120002"

External Provider Account Id

object (StructuredName)

The structured name is used to initialize the person name with the format

firstName
required
string [ 1 .. 200 ] characters
Example: "Mary"

Person given first name.

middleName
string [ 1 .. 200 ] characters
Example: "Joe"

Person given middle name.

lastName
required
string [ 1 .. 200 ] characters
Example: "Smith"

Person surname.

middleInitial
string [ 1 .. 10 ] characters
Example: "J."

Person middle initial.

suffix
string [ 1 .. 20 ] characters
Example: "PhD"

A name suffix in the Western English-Language naming tradition, follows a person's full name and provides additional information about the person. Possible Values: PhD, Snr, Jnr. Generation order should be expressed with roman numerals: I, II, III, IV, V.

prefix
string [ 1 .. 20 ] characters
Example: "Dr."

Name prefixes are typically Dr., Mr., Mrs., Ms.

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Customer complete name

authorizationChannel
string (CommunicationChannelName) [ 1 .. 35 ] characters
Example: "Email"

Channel used to communicate with a party. Possible Values: Email, Fax, File, Online, PostalService, LiveSupport, ATM, IVR, Kiosk, Mobile, OnlineBanking, Phone, SMS, Card, InPerson, Operator, VRU, Telebanc, Notice, ExceptionReport, Statement, TextMessage, Teller, Walkin, Voice, Web, Retailer, WesternUnion, Electronic, CenterView, Paper, WWW.

paymentMethod
string (PaymentMethod) [ 1 .. 35 ] characters
Example: "CreditTransfer"

Specifies the means of payment that will be used to move the amount of money. Possible values are: Check, CreditTransfer. More specific values: ECheck, CreditCard, CommercialCreditCard, CheckCard, BusinessCheck, PinlessDebit, PINDebit, POS, Cash, ACHCredit, LockBox, RemoteCapture, EFTCredit, FedWire, ACHDebit, EFT, MoneyOrder, Coupon.

agreedToTermsIndicator
boolean

Indicates whether the customer agreed the terms of third party payment company.

Array of objects (GenericCode)

Codes related to the external provider account. Possible Values: LookUpReference

Array
name
string [ 1 .. 200 ] characters
Example: "AccountingGroup"

Name of the code in PascalCase.

value
string [ 1 .. 35 ] characters
Example: "195"

Code value.

description
string (Title) [ 1 .. 200 ] characters
Example: "This is a Title."

Responses

Request samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "externalAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "structuredName": {
    },
  • "name": "Jane Birkin",
  • "authorizationChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "agreedToTermsIndicator": true,
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "externalAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "structuredName": {
    },
  • "name": "Jane Birkin",
  • "authorizationChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "agreedToTermsIndicator": true,
  • "codes": [
    ]
}

External Provider Account Status

Returns the status of an external provider account

Authorizations:
jwtopenIdConnect
path Parameters
externalAccountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

External Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "externalAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "structuredName": {
    },
  • "name": "Jane Birkin",
  • "authorizationChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "agreedToTermsIndicator": true,
  • "codes": [
    ]
}

External Provider Removal

Deletes a registerd external provider account

Authorizations:
jwtopenIdConnect
path Parameters
externalAccountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

External Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

servicerBranchId
string (ServicerBranchId) [ 1 .. 36 ] characters
Example: SEA_1

Identification of the account servicer institution at branch level or center level.

Responses

Response samples

Content type
application/json
{
  • "code": "InvalidRequest",
  • "message": "Invalid Request",
  • "details": [
    ],
  • "innerError": {
    },
  • "debugMessage": { },
  • "documentationUrl": "/errors/invalid-credentials"
}

Updates an external provider account.

Use the JSON Merge Patch standard https://tools.ietf.org/html/rfc7396

Authorizations:
jwtopenIdConnect
path Parameters
externalAccountId
required
string (AccountId) [ 1 .. 300 ] characters
Example: 033-DDA-123456

External Account Identification

header Parameters
servicerId
string (Id) [ 1 .. 300 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

Request Body schema: application/merge-patch+json
object

Responses

Request samples

Content type
application/merge-patch+json
{ }

Response samples

Content type
application/json
{
  • "accountBranchId": "SEA_1",
  • "accountNumber": "012345678",
  • "accountType": "Checking",
  • "routingNumbers": [
    ],
  • "identifiers": [
    ],
  • "externalAccountId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002",
  • "structuredName": {
    },
  • "name": "Jane Birkin",
  • "authorizationChannel": "Email",
  • "paymentMethod": "CreditTransfer",
  • "agreedToTermsIndicator": true,
  • "codes": [
    ]
}