Skip to main content
API docs by Redocly

PortX ORCA Payments (0.1.2)

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 paremeters.

Authorizations:
jwtopenIdConnect
query Parameters
paymentId.eq
string (Id) [ 1 .. 36 ] 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).

creditorAccountId.eq
string (Id) [ 1 .. 36 ] characters
Example: creditorAccountId.eq=5fb9d4d6-1a3c-11ed-861d-0242ac120002
checkType.eq
string
checkNumber.eq
string
amount.lte
string (AmountInCents) <= 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 (AmountInCents) <= 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

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

Account Servicer Identification (Bank)

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

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

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 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

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

Request Body schema: application/json
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 ISO 20022 compliant values are: Check, CreditTransfer

paymentType
required
string (PaymentType) [ 1 .. 35 ] characters
Example: "On-Us"

Specifies the type of Payment. Possible values: LiquidityTransfer, On-Us, ACH, Wire

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.

debtorAccountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

creditorAccountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

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

Set of elements used to reference a payment instruction.

endToEndIdentification
string (EndToEndIdentification) [ 1 .. 35 ] characters
Example: "12345678912345"

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.

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

Unique and unambiguous identification of a payment.

identifierName
required
string [ 1 .. 36 ] 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.

issuer
string
Example: "Banc of California"

Entity that assigns the identification.

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 ISO Complaiant values are: High, Normal.

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

Specifies a pre-agreed service between the parties. Some ISO complaiant 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 complaiant 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: "CreditTransfers"

This element is used to specify a local clearing option and/or qualify the service or service level. CreditTransfers, ReturnedCreditTransfers, TruncatedCreditTransfers, TruncatedChecks, RevokedCreditTransfers, RevokedReturnedCreditTransfers, RevokedTruncatedChecks, RevokedTruncatedCreditTransfers, CardClearing, FedNowAccount.

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 complaiant 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, OtherPayment, 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 ISO compliant values are: CustomerCheque, CertifiedCustomerCheque, BankCheque, Draft, ElectronicDraft.

checkNumber
string <= 35 characters

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

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).

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

Date on which a payment must be executed

object (PartyIdentification)
required
object (Party)
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.

shortName
string (PartyShortName) [ 1 .. 35 ] characters
Example: "Jane"

Short name or nickname by which a party is known and which is usually used to identify that party.

Array of objects (RelatedParty)
Array of objects (PostalAddress)
residenceType
string [ 1 .. 35 ] characters
Example: "Domestic"

Specifies the type of residence where the party has its permanent home or principal establishment. Possible ISO Complaian values are: Domestic, Foreign, Mixed

object (TaxPartyInformation)

Taxation parameters which apply to an individual person or to an organization.

object (PowerOfAttorney)

Document that transfers specific rights from a party to a person.

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PartySystemSettings)

System configurations at Party level.

Array of objects (Restriction)

Access and operation restrictions at Party level.

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

The account number or Basic Bank Account Number (BBAN).

Array of objects (RoutingNumber)
Array of objects (AccountIdentification)
object (PostalAddress)

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

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible ISO Compliant values are: Postal, POBox, Residential, Permanent, Temporary, Business.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible ISO Compliant values are: MailTo, DeliveryTo, Billing, PlaceOfOperation, PlaceOfRegistration.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

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

Identification of a division of a large organisation or building.

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

Identification of a sub-division of a large organisation 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 organisation, where letters are kept until called for.

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

Building room number.

postCode
string [ 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.

townName
string [ 1 .. 35 ] characters
Example: "Tualatin"

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

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

Specific location name within the town.

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

Identifies a subdivision 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.

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

Specifies the clearing system member identification. Some ISO complaiant values from ExternalCashClearingSystem1Code are: UnitedStatesRoutingNumberFedwireNACHA, AustrianBankleitzahl, AustralianBankStateBranchCodeBSB,CanadianPaymentsAssociationPaymentRoutingNumber,SwissFinancialInstitutionIdentificationShort,SwissFinancialInstitutionIdentificationLong,CNAPSIdentifier, GermanBankleitzahl, SpanishDomesticInterbankingCode, UKDomesticSortCode, HelenicBankIdentificationCode, 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.

Array of objects (OrganizationIdentification)
object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
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 (PersonContactDetails)

Specifies the contact details of a person.

namePrefix
string [ 1 .. 35 ] characters

Specifies the terms used to formally address a person, in PascalCase form. Possible ISO compliant values are:
Doctor, Madam, Miss, Mister, GenderNeutral

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Preferred name to contact the person

Array of objects (Phone)
Array of objects (Email)
jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

department
string [ 1 .. 35 ] characters
Example: "Sales"

Identification of a division of a large organisation or building.

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

Preferred method used to reach the contact, in PascalCase form. Possible ISO compliant 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.

Array of objects (PartyGenericIdentification)
Array
number
required
string [ 1 .. 35 ] 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 ISO compliant values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET TaxIdentificationNumber BusinessDomainIdentifier BusinessOtherIdentification AlienRegistrationNumber PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification LEIIdentifier BICIdentifier

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).

Responses

Request samples

Content type
application/json
{
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "On-Us",
  • "amount": "100",
  • "debtorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creditorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "purpose": "This is a description.",
  • "identifiers": {
    },
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchangeDetail": {
    },
  • "checkDetail": {
    },
  • "valueDate": "2022-04-17",
  • "creditor": {
    }
}

Response samples

Content type
application/json
{
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "On-Us",
  • "amount": "100",
  • "debtorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creditorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "purpose": "This is a description.",
  • "identifiers": {
    },
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchangeDetail": {
    },
  • "checkDetail": {
    },
  • "valueDate": "2022-04-17",
  • "creditor": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "Cash",
  • "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 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "On-Us",
  • "amount": "100",
  • "debtorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creditorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "purpose": "This is a description.",
  • "identifiers": {
    },
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchangeDetail": {
    },
  • "checkDetail": {
    },
  • "valueDate": "2022-04-17",
  • "creditor": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "Cash",
  • "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 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

Identification of the account servicer institution at branch level or operation 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
{
  • "cancellationReason": "This is a description.",
  • "cancellationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
}

Direct Debits

Direct Debit Management

Direct Debit Initiation

Instruction to collect funds from a debitor.

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

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

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

Request Body schema: application/json
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 ISO 20022 compliant values are: Check, CreditTransfer

paymentType
required
string (PaymentType) [ 1 .. 35 ] characters
Example: "On-Us"

Specifies the type of Payment. Possible values: LiquidityTransfer, On-Us, ACH, Wire

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.

debtorAccountId
required
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

creditorAccountId
string (AccountId) [ 1 .. 36 ] characters
Example: "0dd926fe-1ca2-11ed-861d-0242ac120002"

Identification assigned by the account service institution (Servicer).

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

Set of elements used to reference a payment instruction.

endToEndIdentification
string (EndToEndIdentification) [ 1 .. 35 ] characters
Example: "12345678912345"

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.

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

Unique and unambiguous identification of a payment.

identifierName
required
string [ 1 .. 36 ] 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.

issuer
string
Example: "Banc of California"

Entity that assigns the identification.

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 ISO Complaiant values are: High, Normal.

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

Specifies a pre-agreed service between the parties. Some ISO complaiant 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 complaiant 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: "CreditTransfers"

This element is used to specify a local clearing option and/or qualify the service or service level. CreditTransfers, ReturnedCreditTransfers, TruncatedCreditTransfers, TruncatedChecks, RevokedCreditTransfers, RevokedReturnedCreditTransfers, RevokedTruncatedChecks, RevokedTruncatedCreditTransfers, CardClearing, FedNowAccount.

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 complaiant 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, OtherPayment, 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 .. 36 ] 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

Binary data of 10K maximum.

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

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

Specifies a frequency. Some ISO 20022 compliant values are: Annual, Monthly, Quarterly, SemiAnnual, Weekly, Daily, Adhoc, IntraDay, Overnight, TenDays, Fortnightly, TriggeredByMovement, Never, Rate, OnCreditEvent, Upfront, OnExpiry, Hourly, TriAnnual, Bimonthly, OnDemand, Shift, TwiceAWeek, XDays, XMonths, XYears.

value
integer <= 999

Number of units, for XDays, XMonths, XYears.

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)
required
object (Party)
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.

shortName
string (PartyShortName) [ 1 .. 35 ] characters
Example: "Jane"

Short name or nickname by which a party is known and which is usually used to identify that party.

Array of objects (RelatedParty)
Array of objects (PostalAddress)
residenceType
string [ 1 .. 35 ] characters
Example: "Domestic"

Specifies the type of residence where the party has its permanent home or principal establishment. Possible ISO Complaian values are: Domestic, Foreign, Mixed

object (TaxPartyInformation)

Taxation parameters which apply to an individual person or to an organization.

object (PowerOfAttorney)

Document that transfers specific rights from a party to a person.

supplementaryData
object (SupplementaryData)

Additional information that cannot be captured in the structured elements and/or any other specific block. If this information need to be converted in ISO Messages, must be ISO 20022 compliant: it requires development of a compliant message extension model and its components must be registered in the ISO 20022 Data Dictionary. https://www.iso20022.org/catalogue-messages/additional-content-messages/supplementary-data

object (PartySystemSettings)

System configurations at Party level.

Array of objects (Restriction)

Access and operation restrictions at Party level.

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

The account number or Basic Bank Account Number (BBAN).

Array of objects (RoutingNumber)
Array of objects (AccountIdentification)
object (PostalAddress)

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

addressType
string
Example: "Postal"

Specifies the type of address, in PascalCase form. Possible ISO Compliant values are: Postal, POBox, Residential, Permanent, Temporary, Business.

addressPurpose
string
Example: "Billing"

Specifies the purpose of an address, in PascalCase form. Possible ISO Compliant values are: MailTo, DeliveryTo, Billing, PlaceOfOperation, PlaceOfRegistration.

primaryIndicator
boolean (PrimaryContactIndicator)

Indicates whether the contact informacion is primary.

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

Identification of a division of a large organisation or building.

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

Identification of a sub-division of a large organisation 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 organisation, where letters are kept until called for.

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

Building room number.

postCode
string [ 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.

townName
string [ 1 .. 35 ] characters
Example: "Tualatin"

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

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

Specific location name within the town.

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

Identifies a subdivision 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.

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

Specifies the clearing system member identification. Some ISO complaiant values from ExternalCashClearingSystem1Code are: UnitedStatesRoutingNumberFedwireNACHA, AustrianBankleitzahl, AustralianBankStateBranchCodeBSB,CanadianPaymentsAssociationPaymentRoutingNumber,SwissFinancialInstitutionIdentificationShort,SwissFinancialInstitutionIdentificationLong,CNAPSIdentifier, GermanBankleitzahl, SpanishDomesticInterbankingCode, UKDomesticSortCode, HelenicBankIdentificationCode, 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.

Array of objects (OrganizationIdentification)
object (PlaceAndDateOfBirth)

Date and place of birth of a person.

countrySubdivision
string [ 1 .. 35 ] characters
Example: "Oregon"
townName
string [ 1 .. 35 ] characters
Example: "Tualatin"
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 (PersonContactDetails)

Specifies the contact details of a person.

namePrefix
string [ 1 .. 35 ] characters

Specifies the terms used to formally address a person, in PascalCase form. Possible ISO compliant values are:
Doctor, Madam, Miss, Mister, GenderNeutral

name
string [ 1 .. 350 ] characters
Example: "Jane Birkin"

Preferred name to contact the person

Array of objects (Phone)
Array of objects (Email)
jobTitle
string (JobTitle) [ 1 .. 35 ] characters
Example: "Head of Documentation"

Title of the function in an organization.

department
string [ 1 .. 35 ] characters
Example: "Sales"

Identification of a division of a large organisation or building.

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

Preferred method used to reach the contact, in PascalCase form. Possible ISO compliant 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.

Array of objects (PartyGenericIdentification)
Array
number
required
string [ 1 .. 35 ] 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 ISO compliant values are: BankPartyIdentification CentralBankIdentificationNumber ClearingIdentificationNumber CertificateOfIncorporationNumber CountryIdentificationCode CustomerNumber DataUniversalNumberingSystem EmployerIdentificationNumber GS1GLNIdentifier SIREN SIRET TaxIdentificationNumber BusinessDomainIdentifier BusinessOtherIdentification AlienRegistrationNumber PassportNumber CustomerIdentificationNumber DriversLicenseNumber EmployeeIdentificationNumber NationalIdentityNumber SocialSecurityNumber TelephoneNumber TaxIdentificationNumber PersonCommercialIdentification LEIIdentifier BICIdentifier

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).

Responses

Request samples

Content type
application/json
{
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "On-Us",
  • "amount": "100",
  • "debtorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creditorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "purpose": "This is a description.",
  • "identifiers": {
    },
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "mandate": {
    },
  • "requestedCollectionDate": "2022-04-17",
  • "debitor": {
    }
}

Response samples

Content type
application/json
{
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "Cash",
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "On-Us",
  • "amount": "100",
  • "debtorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creditorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "purpose": "This is a description.",
  • "identifiers": {
    },
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "mandate": {
    },
  • "requestedCollectionDate": "2022-04-17",
  • "debitor": {
    }
}

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 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Account Servicer Identification (Bank)

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

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

Responses

Response samples

Content type
application/json
{
  • "paymentMethod": "CreditTransfer",
  • "paymentType": "On-Us",
  • "amount": "100",
  • "debtorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "creditorAccountId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "purpose": "This is a description.",
  • "identifiers": {
    },
  • "paymentProcessing": {
    },
  • "chargeBearerType": "Shared",
  • "currency": "USD",
  • "exchangeDetail": {
    },
  • "checkDetail": {
    },
  • "valueDate": "2022-04-17",
  • "creditor": {
    },
  • "paymentId": "0dd926fe-1ca2-11ed-861d-0242ac120002",
  • "status": "AcceptedSettlementCompleted",
  • "statusReason": "Cash",
  • "date": "2022-04-17T08:00:00Z"
}

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 .. 36 ] characters
Example: 5fb9d4d6-1a3c-11ed-861d-0242ac120002

Idempotency identifier used by the client when making repeated calls

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

Account Servicer Identification (Bank)

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

Identification of the account servicer institution at branch level or operation 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
{
  • "cancellationReason": "This is a description.",
  • "cancellationId": "5fb9d4d6-1a3c-11ed-861d-0242ac120002"
}