How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CitiConnect Trade Services APIs

Trade finance over a lightweight message exchange interface: standby letters of credit, trade finance undertakings, amendment and cancellation, and receivables finance. Citi publishes 2 machine-readable specifications for this family covering 7 operations, served from developer.citi.com.

This API exposes 4 operations across 2 paths, and defines 58 schemas. It is described by OpenAPI 3.0.2, at version 0.0.1.

Requests are made against the base URL https://tts.apib2b.citi.com/citiconnect/prod.

4 operations 2 paths 58 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
0.0.1
Base URL
https://tts.apib2b.citi.com/citiconnect/prod
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

CitiConnect Trade Services APIs declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (opaque OAuth 2.0) (oauthBearerToken). It supports OAuth 2.0 (oAuth2) using the clientCredentials flow.

  • oauthBearerToken — The access token obtained as a result of OAuth 2.0 flows.
  • oAuth2 — This API uses OAuth2 with the client credentials grant type for service provider API gateway integration.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Trade Finance Undertaking 4
GET
/trade-finance-undertakings
Get Trade Finance Undertaking.
getBankGuarantees 10 params → 200400401403404406413415
POST
/trade-finance-undertakings
Create Trade Finance Undertaking.
createBankGuarantee 3 params body → 201202400401403404406415
GET
/trade-finance-undertakings/{application-reference}
Get Trade Finance Undertaking.
getBankGuarantee 4 params → 200400401403404406413415
PATCH
/trade-finance-undertakings/{application-reference}
Update Trade Finance Undertaking.
modifyBankGuarantee 5 params body → 202400401403404406412415

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are TradeFinanceInstruction (51 properties), TradeFinanceAmends (51 properties), BankGuaranteeAmendment2Subset (21 properties), BankGuaranteeAmendment3Subset (21 properties). Each schema is shown below with its type and property counts.

AccountIdentificationChoice
object
Specifies the unique identification of an account as assigned by the account servicer.
Amount1Choice
object
Choice of amounts.
BankGuaranteeAmendment2Subset
object
Details of the bank guarantee amendment.
21 properties
BankGuaranteeAmendment3Subset
object
Details of the bank guarantee amendment.
21 properties 2 required
ActiveCurrencyAndAmount
object
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
2 properties 2 required
AmendmentPurposeTypeCode
string
Purpose of amendment message Code Name Definition: ICCA - Request issuance of amendment to issued counter counter-undertaking and/or request to issue amendment…
AmountChoice
object
Choice of amounts. Usage - This field is applicable for Amend of Bank Guarantee.
AnyBICDec2014Identifier
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - "Banking - Banking telecomm…
AutoExtendChoice
object
Choice of format for the auto extend period.This field will be available only expriy type is COND. Usage : It is applicable for Issuance and Amendment of Bank…
BranchAndFinancialInstitutionIdentification
object
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
2 properties 1 required
BranchIdentification
object
Information that locates and identifies a specific branch of a financial institution.
4 properties
CashAccount
object
Provides the details to identify an account.
7 properties 2 required
CashAccountTypeChoice
object
Nature or use of the account.
Charge
object
Charges applied
4 properties
ClearingSystemIdentificationChoice
object
Choice of a clearing system identifier.
ClearingSystemMemberIdentification
object
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
2 properties 1 required
CompleteDemandCode
string
The codes specify whether the demand is complete or incomplete. Code Name Definition: COMP - Complete demand, no other documentation to accompany or follow thi…
Contacts
object
Address for electronic mail (e-mail).
3 properties
CountryCode
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (…
DateAndPlaceOfBirth
object
Date and place of birth of a person.
4 properties 3 required
DemandCode
string
Code for partial and/or multiple demands. Code Name Definition: NMLT -Multiple demands not permitted. NMPT -Multiple and partial demands not permitted. NPRT-Pa…
DemandTypeCode
string
Specifies the type of demand for payment. Code Name Definition: PAYM - Pay only. PAEX- Pay or extend.
DocumentSummary
object
Information about a document.
3 properties
Document
object
Information about a document.
8 properties 2 required
ExpiryTypeCode
string
This field specifies whether the undertaking has a specified expiry date or is open-ended or is dependent non a documentary condition or event. Code Name Defin…
FinancialInstitutionIdentification
object
Specifies the details to identify a financial institution.
7 properties
FormOfUndertakingCode
string
This field specifies the form of the independent and irrevocable undertaking.Code Name Definition: DGAR - Demand guarantee STBY - Standby letter of credit. Usa…
GenericIdentification
object
Information related to an identification, for example, party identification or account identification.
3 properties 1 required
GenericOrganisationIdentification
object
Information related to an identification of an organisation.
3 properties 1 required
GenericPersonIdentification
object
Information related to an identification of a person.
3 properties 1 required
GovernanceIdentificationCode
string
Specifies the identification of the rules and laws governing the undertaking. Code Name Definition: ISPR - The version of the International Standby Practices (…
GuaranteePaymentDemand
object
Details of the demand payment request.
19 properties 6 required
ISO2ALanguageCode
string
Identification of the language name according to the ISO 639-1 codes. The type is validated by the list of values coded with two alphabetic characters, defined…
Location
object
Location information.
2 properties
OrganisationIdentification
object
Unique and unambiguous way to identify an organisation.
3 properties
OrganisationIdentificationSchemeNameChoice
object
Sets of elements to identify a name of the organisation identification scheme.
PartyAndSignature
object
Entity involved in an activity.
2 properties 2 required
PartyIdentification
object
Specifies the identification of a person or an organisation.
5 properties
PartyIdentificationChoice
object
Identify the type of party identification as either organisation identification or individual identification.
PartyIdentificationDetail
object
Set of elements used to identify a person or an organisation.
12 properties 1 required
PartyIdentificationSummary
object
Set of elements used to identify a person or an organisation.
6 properties
PersonIdentification
object
Unique and unambiguous way to identify a person.
2 properties
PersonIdentificationSchemeNameChoice
object
Sets of elements to identify a name of the identification scheme.
PhoneNumber
string
The collection of information which identifies a specific phone or FAX number as defined by telecom services. It consists of a "+" followed by the country code…
PlaceOfPresentation
object
Location of a presentation.
2 properties 1 required
PlaceOrUnderConfirmationChoice
object
Choice between a location and codified form.
Presentation
object
Electronic presentation information.
4 properties
PresentationPartyCode
string
Specifies the party to receive the presentation. Code Name Definition: ETHR - Presentation made either to the issuer or other nominated party. EXCN - Presentat…
TradeConfirmationTypeCode
string
This field contains confirmation instructions from the issuing bank to the advising party. Code Name Definition: CONFIRM - The requested confirmation party is…
TradeFinanceInstruction
object
51 properties 11 required
TradeFinanceAmends
object
51 properties 2 required
TradeFinanceInstructionReference
object
Trade Finance Undertaking Application Reference to identify a Trade Finance Undertaking Application throughout the application lifecycle.
1 property
UndertakingPurposeCode
string
This field specifies whether the application text is draft or final. Code Name Definition: FINL - Final submission requesting/authorizing issuance of a guarant…
Link
object
Contains a generic structure to support hyperlinking (REST level 3).
3 properties 1 required
Errors
array
Container to return multiple ErrorMessage object. Collection of error can be useful when API needs to return multiple errors, for example validation errors. Wh…
ErrorMessage
object
Custom error schema to support detailed error message.
5 properties 3 required
inline_response_200
object
2 properties
inline_response_400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

citi-finance-undertaking-api-openapi.yaml Raw ↑
Where this information came from

This is an independent, third-party profile of CitiConnect Trade Services APIs, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.