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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Citi

Citi Outgoing Payments APIs

Payment initiation, status, cancellation, refund, enhanced inquiry, reconfirmation, bulk payments, instant/express payments and WorldLink cross-border payouts. Message bodies are ISO 20022 (pain.001, pain.002, pacs.008, pacs.009, camt.056) in both JSON and XML encodings. Citi publishes 27 machine-readable specifications for this family covering 71 operations, served from developer.citi.com.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 19 operations across 11 paths, organized into 6 resource areas, and defines 216 schemas. It is described by OpenAPI 3.0.2, at version 1.0.0.

Requests are made against 3 base URLs: https://tts.apib2b.citi.com/citiconnect/prod, https://tts.sandbox.apib2b.citi.com/citiconnect/sb, https://tts.sit.apib2b.citi.com/citiconnect/uat.

19 operations 11 paths 216 schemas 1 DELETE6 GET6 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://tts.apib2b.citi.com/citiconnect/prod/paymentservices/v3
Authentication
custom, OAuth 2.0
Contact
Standards & Developer Hub
Resource Areas
6

Authentication & Security 2

Citi Outgoing Payments APIs declares 2 security schemes for authenticating requests. It defines a custom scheme (clientCredentials). It supports OAuth 2.0 (oAuth2) using the authorizationCode flow, exposing 1 scope.

  • clientCredentials — All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of a…

Paths & Operations 19

Across 11 paths, the API surfaces 19 operations — 1 DELETE, 6 GET, 6 PATCH, 6 POST. They span 6 resource areas: Payment-Acceptance, Refunds, Tokens, Authentication, Mandate, Sessions. Each is listed below with its method, path, parameters, and response codes.

Payment-Acceptance 4

Payment Acceptance API

GET
/digitalpayments/v1/payment-acceptance/methods
Payment Method Details
getPayment-Method 2 params → 200400401404405429500504
POST
/digitalpayments/v1/payment-acceptance
Submit A Payment With Selected Payment Method
Payments 5 params body → 200202400401404405409415
GET
/digitalpayments/v1/payment-acceptance
Get Transaction Details
getpaymentstatus 4 params → 200400401404405429500504
PATCH
/digitalpayments/v1/payment-acceptance/{id}
Update a payment with selected payment method.
collectionUpdate 5 params body → 200202400401404405409415
Refunds 3

Refunds API

POST
/digitalpayments/v1/payment-acceptance/refunds
Initiate An Outgoing Instant Refund Credit Transfer
refundPayments 4 params body → 202400401404405409415429
GET
/digitalpayments/v1/payment-acceptance/refunds
Get refund transaction details
getrefundpaymentstatus 11 params → 200400401404405429500504
PATCH
/digitalpayments/v1/payment-acceptance/refunds/{id}
Update a payment with selected payment method.
refundUpdate 6 params body → 202400401404405409415429
Tokens 4

Tokens API

POST
/digitalpayments/v1/payment-acceptance/tokens
Create a Tokenization request.
tokenize 4 params body → 202400401404405409415429
GET
/digitalpayments/v1/payment-acceptance/tokens
Retrieve token details
getToken 3 params → 200400401404405429500504
PATCH
/digitalpayments/v1/payment-acceptance/tokens
Token Update Request.
updateToken 3 params body → 202400401404405409415429
DELETE
/digitalpayments/v1/payment-acceptance/tokens
Token Delete Request.
deleteToken 4 params → 202400401404405409415429
Authentication 2
POST
/digitalpayments/v1/payment-acceptance/authentication
Create a authentication request.
authentication 5 params body → 200400401404405409415429
PATCH
/digitalpayments/v1/payment-acceptance/authentication/{id}
Payer Authentication Request.
updateAuthentication 5 params body → 200400401404405409415429
Mandate 3

Mandate API

POST
/digitalpayments/v1/payment-acceptance/mandates
Initiate New Mandate Outgoing Request
initiateMandate 2 params body → 202400401404405409415429
GET
/digitalpayments/v1/payment-acceptance/mandates
Get Mandate details
getMandate 3 params → 200400401404405409415429
PATCH
/digitalpayments/v1/payment-acceptance/mandates
Cancel Mandate Outgoing Request
cancelMandate 3 params body → 202400401404405409415429
Sessions 3
GET
/digitalpayments/v1/payment-acceptance/sessions
Retrieve session details
getSession 3 params → 200400401404405429500504
POST
/digitalpayments/v1/payment-acceptance/sessions
Create a Session request.
createsession 3 params body → 200400401404405409415429
PATCH
/digitalpayments/v1/payment-acceptance/sessions/{id}
Create a Session request.
updatesession 5 params body → 200400401404405409415429

Schemas 216

The contract defines 216 schemas that model the data the API accepts and returns. The most detailed are Transaction-Status (59 properties), Transaction-Notification (42 properties), Authentication-Payer-Initiate-Response (34 properties), Refund-Transaction-Status (33 properties). Each schema is shown below with its type and property counts.

Customer
object
16 properties
Customer-Authentication-Request
object
9 properties
Customer-Authentication-Response
object
8 properties
Customer-Notification
object
11 properties
Sender-Notification
object
9 properties
Receiver-Notification
object
9 properties
Unstructured
string
“Unstructured remittance information”
Merchant-Notification
object
10 properties
Method-Notification
object
3 properties 1 required
Order-Notification
object
1 property
Mandate-Notification
object
1 property
Transaction-Notification
object
42 properties
Order-Get-Notification
object
15 properties
Customer-Get
object
14 properties
Restricted-Finx-Max-Text
string
Specifies a character string with a maximum length of 35 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + . - For Brazil refund requ…
Address
object
Address
16 properties
Authentication-Address
object
Authentication Address
6 properties
Lines
string
Address Lines - For US RFP only one(1) line of 70 characters is allowed - For US ACH Direct Debit payment, unstructured addresslines is mandatory when structur…
Purpose
string
Purpose of a payment
Mandate-Address
object
Mandate Address
1 property
Notification-Address
object
Notification-Address
16 properties
Shipping-Address
object
Address
6 properties
Original-Payment
object
Either populate UETR OR (endtoendid AND valuedate) for the refund to be processed
5 properties
Refund-Customer-Status
object
3 properties
Refund-Merchant-Status
object
3 properties
Original-Initial-Payment
object
Either populate UETR OR (id AND valuedate) for the refund to be processed - For Brazil PIX, India UPI and UK FPS refund payment, originalpayment object is mand…
3 properties
Merchant
object
10 properties
Merchant-Status
object
11 properties
Method-Status
object
6 properties
Method
object
14 properties 1 required
Authentication-Transaction-Request
object
2 properties 1 required
Authentication-Transaction-Response
object
11 properties 4 required
Transaction
object
29 properties 3 required
Order
object
30 properties
Authentication-Payer-Order
object
25 properties 5 required
Authentication-Payer-Order-Response
object
32 properties 12 required
Authentication-Method
object
5 properties 1 required
Authentication-Payer-Method
object
6 properties
Authentication-Payer-Method-Response
object
5 properties 1 required
Authentication-Transaction
object
4 properties 3 required
Authentication-Order
object
4 properties 2 required
Initiate-Authentication
object
4 properties 1 required
Authentication-Payer-Initiate-Request
object
5 properties 1 required
Authentication-Payer-Initiate-Response
object
34 properties 5 required
Mandate
object
14 properties
Authentication-Mandate
object
11 properties
Shipping
object
11 properties
Authentication
object
15 properties
Authentication-Payer-Shipping
object
8 properties
Risk
object
2 properties
Payment-Recipient
object
4 properties
Sender
object
7 properties
Receiver
object
7 properties
Additional-Info
object
2 properties
Customer-Device
object
Customer-Device.
7 properties
Authentication-Customer-Device
object
Customer-Device.
16 properties
Authentication-Customer-Device-Response
object
Customer-Device.
9 properties 3 required
Url
object
URL. - For UK PAYBYBANK Creation transaction.url parameter is mandatory.
4 properties
Url-Update
object
URL.
2 properties
Authorization-Response
object
Authorization Response
14 properties
Authorization-Refund-Response
object
Authorization Response
14 properties
Acquirer-Request
object
acquirer
1 property
Response
object
Response
3 properties
avs
object
avs
2 properties
Alipay
object
- For ALIPAY Pay operation method.alipay parameter is mandatory when method.type parameter selected as ALIPAY
1 property
Name
object
3 properties
Recipient-Name
object
Recipient Name
3 properties
Boleto
object
- For BOLETO Pay operation method.boleto parameter is mandatory when method.type parameter is selected as BOLETO
3 properties
Paypal
object
- For PAYPAL Pay operation method.paypal parameter is mandatory when method.type parameter is selected as PAYPAL
4 properties
Paypal-Update
object
- For PAYPAL Pay operation method.paypal parameter is mandatory when method.type parameter is selected as PAYPAL
1 property
Paypal-Response
object
Paypal Method Response
4 properties
Billing-Agreement
object
Paypal Billing Method Response
4 properties
Card-Response
object
Card Method Response
12 properties
Card-Refund-Update-Notification
object
Card refund update Response
6 properties
Card-Refund-Response
object
Card Method Response
4 properties
Device-Specific-Response
object
Device Specific Response
3 properties
Device-Response
object
Device Response
1 property
Card
object
- For CARD Authorize operation method.card parameter is mandatory when method.type parameter is selected as CARD - For CARD Capture operation method.card param…
11 properties
Authentication-Card
object
Card informations
4 properties
Authentication-Payer-Card
object
Card informations
5 properties
Authentication-Payer-Card-Response
object
Card informations
11 properties
Authentication-Card-Response
object
Card informations
10 properties
Sdk
object
sdk payer authentication
8 properties
Sdk-Payer-Authentication-Response
object
sdk payer authentication response
5 properties
Authentication-Customer-Payer-Request
object
Authentication-Customer-Payer-Request
4 properties
Authentication-Customer-Payer-Response
object
Authentication-Customer-Payer-Response
4 properties
Authentication-Customer-History-Payer-Request
object
Authentication-Customer-Payer-Request
14 properties
Pix
object
- For Brazil QR creation method.pix parameter is mandatory when method.type parameter is selected as PIX
1 property
Upi
object
India UPI Transaction
1 property
Ach
object
- For ACH Pay operation method.ach parameter is mandatory when method.type parameter is selected as ACH - For ACH Verify operation method.ach parameter is is m…
1 property
Device
object
Device
8 properties
Authentication-Device-Payment
object
Device
4 properties
Authentication-Device-Payment-Response
object
Device
1 property
Acquirer
object
Acquirer
3 properties
Acquirer-Refund-Response
object
Acquirer
6 properties
Constraints
object
Constraints
3 properties
Product-Info
object
Product related information
5 properties
Transit
object
Transit
2 properties
Aggregated-Fare
object
3 properties
Holder-Name
object
The name of the bank account holder for the payer's bank account.
2 properties
Refunds-Request
object
4 properties 2 required
Refund-Method
object
1 property 1 required
Refund-Transaction
object
8 properties 2 required
Refund-Order
object
2 properties
Session-Create-Request
object
2 properties 1 required
Session
object
2 properties
Session-Status-Response
object
5 properties 2 required
Session-Create-Response
object
3 properties 3 required
Session-Update-Request
object
3 properties
Session-Update-Response
object
5 properties 2 required
Session-Get-Status-Card-Notification
object
3 properties
Session-Get-Status-Ach-Notification
object
3 properties
Session-Response
object
4 properties 3 required
Method-Session-Update
object
Session method
1 property
Holder-Session-Name
object
Session Name
2 properties
Session-Get-Response
object
3 properties 3 required
Session-Updat-Response
object
1 property 1 required
Tokenization-Create-Request
object
5 properties 3 required
Tokenization-Create-Request-Customer
object
3 properties 1 required
Tokenization-Create-Request-Method
object
4 properties 2 required
Tokenization-Create-Request-Card
object
Card object is mandatory for Citi token ID creation, if method.type is selected as CARD
4 properties
Tokenization-Create-Request-Billing_Address
object
8 properties
Tokenization-Update-Request-Billing_Address
object
8 properties
Token_Lines
string
Address Lines
Payment-Method
array
Customer-Update
object
6 properties
Merchant-Update
object
2 properties
Method-Update
object
4 properties
Refund-Method-Update
object
1 property 1 required
Transaction-Update
object
16 properties 1 required
Refund-Transaction-Update
object
7 properties 1 required
Order-Update
object
8 properties
Refund-Order-Update
object
1 property
Payment-Method-Response
object
Payment method response
1 property
Token-Response
array
Tokenization
object
9 properties
Tokenization-Request-Customer
object
3 properties 1 required
Tokenization-Request-Id
object
1 property 1 required
Tokenization-Request-Card
object
1 property 1 required
Payments-Response
array
Payments
object
Payment status notification / inquiry response
11 properties
Transaction-Status
object
59 properties
Payment-Request
object
Payment Request
11 properties 3 required
Authentication-Request
object
Authentication Request
4 properties 4 required
Authentication-Payer-Request
object
Payment Request
7 properties 2 required
Authentication-Payer-Response
object
Payment Request
7 properties 4 required
Payment-Update-Request
object
Payment Update Request
6 properties 1 required
Refund-Update-Request
object
Payment Update Request
3 properties 2 required
Token-Update-Request
object
4 properties 2 required
Token-Update-Request-Customer
object
3 properties 1 required
Token-Update-Request-Method
object
3 properties 3 required
Mandate-Initiation-Request
object
4 properties 2 required
Mandate-Initiation-Request-Mandate
object
14 properties 4 required
Mandate-Initiation-Request-Customer
object
2 properties
Mandate-Initiation-Request-Sender
object
2 properties
Mandate-Initiation-Request-Merchant
object
3 properties 2 required
Mandate-Cancellation-Request
object
1 property 1 required
Mandate-Cancellation-Request-Mandate
object
4 properties 3 required
Payment-Response
object
3 properties
Tokens-Response
object
3 properties
Mandate-Initiation-Response
object
3 properties
Mandate-Cancellation-Response
object
4 properties
Payment-Qr-Failed
object
1 property
Payment-Credit-Notification
object
Payment Notification
8 properties 1 required
Payment-Cancelled-Notification
object
1 property
Payment-Link-Notification
object
2 properties
Payment-Failed-Notification
object
1 property
Payment-Notification
object
8 properties
Authentication-Response
object
4 properties 4 required
Refund-Update-Notification
object
3 properties
Refund-Update-Transaction
object
22 properties
Refund-Update-Method
object
2 properties
Refund-Update-Order
object
14 properties
Mandate-Inquiry-Response
array
Mandate-Response
object
4 properties
Mandate-Get-Status
object
22 properties
Customer-Get-Status
object
3 properties
Merchant-Get-Status
object
3 properties
Sender-Get-Status
object
2 properties
Refunds-Response
array
Payment-Refund-Notification
object
6 properties 2 required
Payment-L0-Refund-Notification
object
4 properties 2 required
Refund-L0-Method-Status
object
2 properties 1 required
Refund-Method-Status
object
3 properties 1 required
Refund-Transaction-Status
object
33 properties 2 required
Refund-L0-Transaction-Status
object
13 properties 2 required
Refund-Order-Status
object
13 properties
Payment-Created-Notification
object
1 property
Tokenization-Create-Status-Notification
object
9 properties 5 required
Tokenization-Create-Status-Customer-Notification
object
3 properties 1 required
Tokenization-Create-Status-Billing_Address-Notification
object
8 properties
Tokenization-Create-Status-Method-Notification
object
4 properties 3 required
Tokenization-Create-Status-Card-Notification
object
4 properties
Token-Update-Request-Notification
object
8 properties 5 required
Token-Delete-Request-Notification
object
6 properties 4 required
Token-Delete-Request-Customer-Notification
object
1 property 1 required
Token-Update-Request-Customer-Notification
object
3 properties 1 required
Token-Delete-Request-Method-Notification
object
4 properties 3 required
Token-Delete-Request-Card-Notification
object
1 property 1 required
Mandate-Status-Notification
object
4 properties 1 required
Mandate-Initiation-Status-Mandate-Notification
object
16 properties 1 required
Mandate-Initiation-Status-Customer-Notification
object
3 properties
Mandate-Initiation-Status-Sender-Notification
object
2 properties
Mandate-Initiation-Status-Merchant-Notification
object
3 properties 2 required
Rfp-Notification
object
8 properties 3 required
Rfp-Method-Notification
object
1 property
Rfp-Transaction-Notification
object
21 properties 3 required
Rfp-Customer-Notification
object
8 properties
Rfp-Merchant-Notification
object
8 properties
Rfp-Sender-Notification
object
7 properties
Rfp-Receiver-Notification
object
7 properties
Rfp-Response-Rfp-Notification
object
4 properties
Rfp-Mandate-Notification
object
1 property
Error-Response
object
2 properties
Gateway-Error-Response
object
3 properties
Error-Detail
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

citi-digitalpaymentscollectionsv12-openapi.yaml Raw ↑
#Payments#ISO 20022#Treasury
← Back to C APIs
API Details
ID
citi:citi-outgoing-payments-apis
Base URL
https://tts.apib2b.citi.com/citiconnect/prod/paymentservices/v3
Docs
https://developer.citi.com/apidocs/outgoing-payments/payments/payments-overview
Provider
Citi
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=citi-citi-outgoing-payments-apis&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/citi-citi-outgoing-payments-apis"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Citi Outgoing Payments 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.