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 GitHub OpenAPI

Operations 19

GET /digitalpayments/v1/payment-acceptance/methods Payment Method Details #

POST /digitalpayments/v1/payment-acceptance Submit A Payment With Selected Payment Method #

GET /digitalpayments/v1/payment-acceptance Get Transaction Details #

POST /digitalpayments/v1/payment-acceptance/refunds Initiate An Outgoing Instant Refund Credit Transfer #

GET /digitalpayments/v1/payment-acceptance/refunds Get refund transaction details #

PATCH /digitalpayments/v1/payment-acceptance/refunds/{id} Update a payment with selected payment method. #

POST /digitalpayments/v1/payment-acceptance/tokens Create a Tokenization request. #

GET /digitalpayments/v1/payment-acceptance/tokens Retrieve token details #

PATCH /digitalpayments/v1/payment-acceptance/tokens Token Update Request. #

DELETE /digitalpayments/v1/payment-acceptance/tokens Token Delete Request. #

PATCH /digitalpayments/v1/payment-acceptance/{id} Update a payment with selected payment method. #

POST /digitalpayments/v1/payment-acceptance/authentication Create a authentication request. #

PATCH /digitalpayments/v1/payment-acceptance/authentication/{id} Payer Authentication Request. #

POST /digitalpayments/v1/payment-acceptance/mandates Initiate New Mandate Outgoing Request #

GET /digitalpayments/v1/payment-acceptance/mandates Get Mandate details #

PATCH /digitalpayments/v1/payment-acceptance/mandates Cancel Mandate Outgoing Request #

GET /digitalpayments/v1/payment-acceptance/sessions Retrieve session details #

POST /digitalpayments/v1/payment-acceptance/sessions Create a Session request. #

PATCH /digitalpayments/v1/payment-acceptance/sessions/{id} Create a Session request. #

Documentation

https://developer.citi.com/apidocs/outgoing-payments/payments/payments-overview

https://developer.citi.com/apidocs/outgoing-payments/payments/payments-api-reference

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/authentication/citi-authentication.yml

Specifications

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-digitalpaymentscollectionsv12-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-express-payments-api-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-payto-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-vamanagement-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-add-on-service-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-addonservice-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-worldlink-v2-api-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-worldlink-v3-api-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-payment-status-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-worldlink-v5-api-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-bulk-payments-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-contractstatusinquiry-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-payment-reconfirmation-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-payment-refund-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentcancellation-json-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentcancellation-xml-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentenhancedinquiry-json-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentenhancedinquiry-xml-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentinitiation-pacs008-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentinitiation-pacs009-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentinitiation-pain102-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-paymentinitiation-pain103-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-proof-of-payment-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-worldlink-ir-api-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-worldlink-v1-api-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-digitalpaymentscollections-webhooks-openapi.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-express-payments-webhooks-openapi.yaml

Other Resources

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/overlays/citi-outgoing-payments-overlay.yaml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/conventions/citi-conventions.yml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/errors/citi-problem-types.yml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/sandbox/citi-sandbox.yml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/asyncapi/citi-webhooks.yml

https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/errors/citi-decline-codes.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/citi-outgoing-payments-apis"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.0.2
info:
  title: Payment Acceptance API
  description: |
    Payment Acceptance API
    Update - April 28, 2026
  contact:
    name: Standards & Developer Hub
    url: https://tts.sandbox.developer.citi.com/citiconnect/
    email: developer-support@citi.com
  version: 1.0.0
servers:
  - url: https://tts.apib2b.citi.com/citiconnect/prod
    description: production gateway URL
  - url: https://tts.sandbox.apib2b.citi.com/citiconnect/sb
    description: sbox URL
  - url: https://tts.sit.apib2b.citi.com/citiconnect/uat
    description: uat URL
tags:
  - name: Payment-Acceptance
    description: Payment Acceptance API
  - name: Refunds
    description: Refunds API
  - name: Tokens
    description: Tokens API
  - name: Mandate
    description: Mandate API
paths:
  /digitalpayments/v1/payment-acceptance/methods:
    get:
      tags:
        - Payment-Acceptance
      summary: Payment Method Details
      description: >
        Payment method details, merchant enabled payment method during
        onboarding details.
      operationId: getPayment-Method
      parameters:
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/Merchant-Id'
      security:
        - clientCredentials: []
      responses:
        '200':
          description: Payment method
          headers:
            apim-guid:
              schema:
                type: string
              description: Citi's unique identification for your request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment-Method-Response'
              examples:
                Payment-Method:
                  $ref: '#/components/examples/Payment-Method'
        '400':
          $ref: '#/components/responses/Bad-Get-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '429':
          $ref: '#/components/responses/Rate-Limit-Exceeded'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
  /digitalpayments/v1/payment-acceptance:
    post:
      tags:
        - Payment-Acceptance
      summary: Submit A Payment With Selected Payment Method
      description: Create a payment
      operationId: Payments
      parameters:
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/Idempotency-Id'
        - $ref: '#/components/parameters/Merchant-Post-Id'
        - $ref: '#/components/parameters/Post-Operation'
        - $ref: '#/components/parameters/Post-Country-Code'
      security:
        - clientCredentials: []
      requestBody:
        description: Payment Initiation
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Payment-Request'
            examples:
              Brazil QR Creation Payment Request:
                $ref: '#/components/examples/Qrpix-Payment-Request-Example'
              US Alipay Payment Request:
                $ref: '#/components/examples/US-Alipay-Payment-Request-Example'
              US Trustly Payment Request:
                $ref: '#/components/examples/US-Trustly-Payment-Request-Example'
              US Card Payment Request With Card Details:
                $ref: '#/components/examples/US-Card-Payment-Request-Example'
              US Card Payment Request With Token Details:
                $ref: >-
                  #/components/examples/US-Card-Payment-Request-With-Token-Example
              US Card Payment Request With Session Details:
                $ref: >-
                  #/components/examples/US-Card-Payment-Request-With-Session-Example
              US Card Authorize Request With Card Details:
                $ref: >-
                  #/components/examples/US-Card-Authorize-Request-With-Card-Example
              US Card Authorize Request With Token Details:
                $ref: >-
                  #/components/examples/US-Card-Authorize-Request-With-Token-Example
              US Card Authorize Request With Session Details:
                $ref: >-
                  #/components/examples/US-Card-Authorize-Request-With-Session-Example
              US Card Verify Request With Card Details:
                $ref: '#/components/examples/US-Card-Verify-Request-With-Card-Example'
              US Card Verify Request With Token Details:
                $ref: >-
                  #/components/examples/US-Card-Verify-Request-With-Token-Example
              US Card Verify Request With Session Details:
                $ref: >-
                  #/components/examples/US-Card-Verify-Request-With-Session-Example
              US Card Capture Request:
                $ref: '#/components/examples/US-Card-Capture-Request-Example'
              US Google Pay Capture Request:
                $ref: '#/components/examples/Us-Google-Pay-Capture-Request-Example'
              US Google Pay Verify With Card Request:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Verify-With-Card-Request-Example
              US Google Pay Verify With Session Request:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Verify-With-Session-Request-Example
              US Google Pay Verify With Token Request:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Verify-With-Token-Request-Example
              India Card Payment Request With Card Details:
                $ref: >-
                  #/components/examples/India-Card-Payment-With-Card-Request-Example
              India Card Capture Payment Request:
                $ref: >-
                  #/components/examples/India-Card-Capture-Payment-Request-Example
              India Card Payment Request With Token Details:
                $ref: '#/components/examples/India-Card-Token-Payment-Request-Example'
              India Card Authorize Request:
                $ref: '#/components/examples/India-Card-Authorize-Request-Example'
              India Token Authorize Request:
                $ref: '#/components/examples/India-Token-Authorize-Request-Example'
              UK PayByBank Payment Request:
                $ref: '#/components/examples/Uk-Payment-Request-Example'
              US RFP Payment Request:
                $ref: '#/components/examples/Us-Rfp-Request-Example'
              US ApplePay Payment With Card Request:
                $ref: >-
                  #/components/examples/US-Apple-Pay-Payment-With-Card-Request-Example
              US ApplePay Payment With Token Request:
                $ref: >-
                  #/components/examples/US-Apple-Pay-Payment-With-Token-Request-Example
              US ApplePay Payment With Session Request:
                $ref: >-
                  #/components/examples/US-Apple-Pay-Payment-With-Session-Request-Example
              US ApplePay Authorize With Card Request:
                $ref: >-
                  #/components/examples/US-Apple-Pay-Authorize-With-Card-Request-Example
              US ApplePay Authorize With Token Request:
                $ref: >-
                  #/components/examples/US-Apple-Pay-Authorize-With-Token-Request-Example
              US ApplePay Authorize With Session Request:
                $ref: >-
                  #/components/examples/US-Apple-Pay-Authorize-With-Session-Request-Example
              US Apple Pay Capture Request:
                $ref: '#/components/examples/Us-Apple-Pay-Capture-Request-Example'
              US Apple Pay Verify With Card Request:
                $ref: >-
                  #/components/examples/Us-Apple-Pay-Verify-With-Card-Request-Example
              US Apple Pay Verify With Token Request:
                $ref: >-
                  #/components/examples/Us-Apple-Pay-Verify-With-Token-Request-Example
              US Apple Pay Verify With Session Request:
                $ref: >-
                  #/components/examples/Us-Apple-Pay-Verify-With-Session-Request-Example
              US GooglePay Payment Request With Card:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Payment-Request-With-Card-Example
              US GooglePay Payment Request With Token:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Payment-Request-With-Token-Example
              US GooglePay Payment Request With Session:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Payment-Request-With-Session-Example
              US GooglePay Authorize Request With Card:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Authorize-Request-With-Card-Example
              US GooglePay Authorize Request With Session:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Authorize-Request-With-Session-Example
              US GooglePay Authorize Request With Token:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Authorize-Request-With-Token-Example
              US Paypal Payment Request:
                $ref: '#/components/examples/US-Paypal-Payment-Request-Example'
              US Paypal Authorize Request:
                $ref: '#/components/examples/Us-Paypal-Authorize-Request-Example'
              US Paypal Capture Request:
                $ref: '#/components/examples/Us-Paypal-Capture-Request-Example'
              US ACH DirectDebit Payment Request CCD/PPD/WEB:
                $ref: >-
                  #/components/examples/Us-Ach-Direct-Debit-CCD-PPD-WEB-Request-Example
              US ACH DirectDebit Payment Request IAT:
                $ref: '#/components/examples/Us-Ach-Direct-Debit-IAT-Request-Example'
              Brazil PIX Initiation Request:
                $ref: '#/components/examples/Brazil-PIX-Initiation-Request-Example'
              US ACH Payment Request:
                $ref: '#/components/examples/US-Ach-Pay-Payment-Request-Example'
      callbacks:
        payment-qr-created:
          $ref: '#/components/callbacks/Payment-Created-Status'
        payment-qr-failed:
          $ref: '#/components/callbacks/Payment-Failed-Status-Notification'
        payment-settled:
          $ref: '#/components/callbacks/Payment-Success-Status-Notification'
        payment-authorize-success:
          $ref: '#/components/callbacks/payment-Authorize-Success'
        payment-authorize-failed:
          $ref: '#/components/callbacks/payment-Authorize-Failed'
        payment-capture-success:
          $ref: '#/components/callbacks/Payment-Capture-Success'
        payment-capture-failed:
          $ref: '#/components/callbacks/Payment-Capture-Failed'
        payment-failed:
          $ref: '#/components/callbacks/Payment-Failed'
        payment-rfp-failed:
          $ref: '#/components/callbacks/Payment-Rfp-Failed'
        payment-rfp-success:
          $ref: '#/components/callbacks/Payment-Rfp-Success'
      responses:
        '200':
          description: OK
          headers:
            apim-guid:
              schema:
                type: string
              description: Citi's unique identification for your request
            Merchant-Id:
              schema:
                type: string
              description: The unique identifier issued to you by your payment provider
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment-Notification'
              examples:
                USCardPaymentResponse:
                  $ref: '#/components/examples/Card-Payment-Response-Example'
                IndiaCardPaymentResponse:
                  $ref: '#/components/examples/India-Card-Payment-Response-Example'
                USGooglepayPaymentResponse:
                  $ref: '#/components/examples/Googlepay-Payment-Response-Example'
                USApplepayPaymentResponse:
                  $ref: '#/components/examples/Applepay-Payment-Response-Example'
                USPaypalPaymentResponse:
                  $ref: '#/components/examples/Paypal-Payment-Response-Example'
                Payment-Uk-Link-Failed-Response:
                  $ref: '#/components/examples/Payment-Uk-Link-Failed-Notification'
                Payment-Uk-Link-Success-Response:
                  $ref: '#/components/examples/Payment-Uk-Link-Sucess-Notification'
                USAlipay-Link-Success-Response:
                  $ref: '#/components/examples/Alipay-Link-Sucess-Notification'
                USTrustly-Link-Success-Response:
                  $ref: '#/components/examples/Trustly-Link-Sucess-Notification'
        '202':
          $ref: '#/components/responses/Accepted'
        '400':
          $ref: '#/components/responses/Bad-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '415':
          $ref: '#/components/responses/Unsupported-Media-Type'
        '429':
          $ref: '#/components/responses/Rate-Limit-Exceeded'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
    get:
      tags:
        - Payment-Acceptance
      summary: Get Transaction Details
      description: >
        Receive transaction status of the transaction for last 90 days using
        transaction ID provided during transaction creation or transaction
        end-to-end-id received in incoming credit notification.
      operationId: getpaymentstatus
      parameters:
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/Get-Payment-End-To-End-Id'
        - $ref: '#/components/parameters/Type'
        - $ref: '#/components/parameters/Post-Country-Code'
      security:
        - clientCredentials: []
      responses:
        '200':
          description: Payment status
          headers:
            apim-guid:
              schema:
                type: string
              description: Citi's unique identification for your request
            result:
              schema:
                type: integer
                minimum: 1
                maximum: 1000
                default: 100
              description: Number of transaction status matching your request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payments-Response'
              examples:
                Brazil-Qr-Created-Status:
                  $ref: '#/components/examples/Qr-Created-Status'
                Brazil-Qr-Pending-Status:
                  $ref: '#/components/examples/Qr-Pending-Status'
                Brazil-Qr-Cancelled-Status:
                  $ref: '#/components/examples/Qr-Cancelled-Status'
                Brazil-Qr-Failed-Status:
                  $ref: '#/components/examples/Qr-Failed-Status'
                Brazil-Qr-Settled-Status:
                  $ref: '#/components/examples/Qr-Settled-Status'
                India-Upi-Settled-Status:
                  $ref: '#/components/examples/Payment-Success-Upi-Status'
                Brazil-Incoming-Credit-Settled-Status:
                  $ref: >-
                    #/components/examples/Payment-Success-Incoming-Brazil-PIX-Credit-Status-Notification
                Brazil-Incoming-Credit-Failed-Status:
                  $ref: >-
                    #/components/examples/Payment-Failed-Incoming-Brazil-PIX-Credit-Status-Notification
                UK-Pending-Status:
                  $ref: '#/components/examples/Uk-Pending-Status'
                UK-Failed-Status:
                  $ref: '#/components/examples/Uk-Failed-Status'
                UK-Settled-Status:
                  $ref: '#/components/examples/Uk-Settled-Status'
                US-RFP-Reject-Status:
                  $ref: '#/components/examples/Us-Rfp-Reject-Status-Example'
                US-RFP-Success-Status:
                  $ref: '#/components/examples/Us-Rfp-Success-Status-Example'
                Payment-Success-US-RFP-Status:
                  $ref: '#/components/examples/Payment-Success-Us-Rfp-Status'
                US-ACH-Direct-Debit-Status:
                  $ref: '#/components/examples/ACH-Direct-Debit-Status'
                US-Wire-Status:
                  $ref: '#/components/examples/US-Wire-Status'
                US-ACH-Status:
                  $ref: '#/components/examples/US-ACH-Status'
                Brazil-PIX-Status:
                  $ref: '#/components/examples/BR-PIX-Status'
                India-Card-Status:
                  $ref: '#/components/examples/India-Card-Status'
                US-Card-Status:
                  $ref: '#/components/examples/Us-Card-Status'
                US-Googlepay-Card-Status:
                  $ref: '#/components/examples/Us-Googlepay-Status'
                US-Applepay-Card-Status:
                  $ref: '#/components/examples/Us-Applepay-Status'
                US-Paypal-Card-Status:
                  $ref: '#/components/examples/Us-Paypal-Status'
                India-IMPS-Status:
                  $ref: '#/components/examples/India-IMPS-Status'
                Thailand-IP-Status:
                  $ref: '#/components/examples/Thailand-IP-Status'
                Australia-IP-Status:
                  $ref: '#/components/examples/Australia-IP-Status'
        '400':
          $ref: '#/components/responses/Bad-Get-Request2'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '429':
          $ref: '#/components/responses/Rate-Limit-Exceeded'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
  /digitalpayments/v1/payment-acceptance/refunds:
    post:
      tags:
        - Refunds
      summary: Initiate An Outgoing Instant Refund Credit Transfer
      description: >-
        Return an incoming payment transaction to the sender using either the
        "end_to_end_id" and "value_date", or "UETR".  The response to a refund
        transaction is asynchronous, which is either through a GET Refund
        request or as a push notification via webhook.
      operationId: refundPayments
      parameters:
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/Idempotency-Id'
        - $ref: '#/components/parameters/Merchant-Refund-Id'
        - $ref: '#/components/parameters/Post-Country-Code'
      requestBody:
        description: Refund Initiation Request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Refunds-Request'
            examples:
              Brazil Pix Refund Transfer:
                $ref: >-
                  #/components/examples/Brazil-Pix-Refund-Initiation-Request-Example
              US Card Refund Transfer:
                $ref: >-
                  #/components/examples/US-Card-Refund-Initiation-Request-Example
              US ACH Refund Transfer:
                $ref: '#/components/examples/US-Ach-Refund-Initiation-Request-Example'
              India Card Refund Transfer:
                $ref: >-
                  #/components/examples/India-Card-Refund-Initiation-Request-Example
              India UPI Refund Transfer:
                $ref: >-
                  #/components/examples/India-Upi-Refund-Initiation-Request-Example
              UK Refund Transfer:
                $ref: '#/components/examples/Uk-Ip-Refund-Initiation-Request-Example'
              US Ach Return And Reversal:
                $ref: '#/components/examples/Us-Ach-Retrun-Reversal-Request-Example'
              US Googlepay Refund Transfer:
                $ref: >-
                  #/components/examples/Googlepay-Refund-Initiation-Request-Example
              US Applepay Refund Transfer:
                $ref: >-
                  #/components/examples/Applepay-Refund-Initiation-Request-Example
              US Paypal Refund Transfer:
                $ref: >-
                  #/components/examples/Us-Paypal-Refund-Initiation-Request-Example
              US PPRO Refund Transfer:
                $ref: '#/components/examples/PPRO-Refund-Initiation-Request-Example'
      security:
        - clientCredentials: []
      callbacks:
        payment-refund-success:
          $ref: '#/components/callbacks/Payment-Refund-Created-Status'
        payment-refund-failed:
          $ref: '#/components/callbacks/Payment-Refund-Failed-Status'
        payment-refund-pending:
          $ref: '#/components/callbacks/Payment-Refund-Pending-Status'
      responses:
        '202':
          description: Accepted
          headers:
            apim-guid:
              schema:
                type: string
              description: Citi's unique identification for your request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment-L0-Refund-Notification'
              examples:
                CardPaymentCreatedSucessResponse:
                  $ref: '#/components/examples/Payment-Refund-Card-Sucess-Response'
                IndiaCardPaymentCreatedSucessResponse:
                  $ref: >-
                    #/components/examples/India-Payment-Refund-Card-Sucess-Response
                PixPaymentCreatedSucessResponse:
                  $ref: '#/components/examples/Payment-Refund-Pix-Sucess-Response'
                UpiPaymentCreatedSucessResponse:
                  $ref: >-
                    #/components/examples/Payment-Refund-India-Upi-Sucess-Response
                UkPaymentCreatedSucessResponse:
                  $ref: '#/components/examples/Payment-Refund-Uk-Ip-Sucess-Response'
                UsAchReturnAndRevesalCreatedSuccessResponse:
                  $ref: >-
                    #/components/examples/Us-Ach-Return-And-Revesal-Success-Response
                GooglepayPaymentCreatedSucessResponse:
                  $ref: '#/components/examples/Googlepay-Refund-Card-Sucess-Response'
                ApplepayPaymentCreatedSucessResponse:
                  $ref: '#/components/examples/Applepay-Refund-Card-Sucess-Response'
                PproPaymentCreatedSucessResponse:
                  $ref: '#/components/examples/Ppro-Refund-Card-Sucess-Response'
        '400':
          $ref: '#/components/responses/Bad-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '415':
          $ref: '#/components/responses/Unsupported-Media-Type'
        '429':
          $ref: '#/components/responses/Rate-Limit-Exceeded'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
        default:
          $ref: '#/components/responses/Internal-Server-Error'
    get:
      tags:
        - Refunds
      summary: Get refund transaction details
      description: >-
        Receive transaction status of the transaction for last 90 days using the
        additional parameter. End-To-End-Id or UETR or Country-Code or Original
        Payment UETR is mandatory. 

        - For ACH Return & Reversal, you can retrieve transaction details using
        original_payment_uetr.
      operationId: getrefundpaymentstatus
      parameters:
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/End-To-End-Id'
        - $ref: '#/components/parameters/Country-Code'
        - $ref: '#/components/parameters/Uetr'
        - $ref: '#/components/parameters/Original-Payment-Uetr'
        - $ref: '#/components/parameters/Creation-Date-Time-Start'
        - $ref: '#/components/parameters/Creation-Date-Time-End'
        - $ref: '#/components/parameters/Amount'
        - $ref: '#/components/parameters/Status'
        - $ref: '#/components/parameters/Offset-Param'
        - $ref: '#/components/parameters/Limit-Param'
      security:
        - clientCredentials: []
      responses:
        '200':
          description: Payment status
          headers:
            apim-guid:
              schema:
                type: string
              description: Citi's unique identification for your request
            result:
              schema:
                type: integer
                minimum: 1
                maximum: 1000
                default: 100
              description: Number of transaction status matching your request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refunds-Response'
              examples:
                Brazil Pix Refund Transfer:
                  $ref: '#/components/examples/Payment-Refund-Pix-Sucess-Notification'
                Card Refund Transfer:
                  $ref: >-
                    #/components/examples/Payment-Refund-Card-Sucess-Notification
                India UPI Refund Transfer:
                  $ref: >-
                    #/components/examples/Payment-Refund-India-Upi-Sucess-Notification
                Uk PAYBYBANK Refund Transfer:
                  $ref: '#/components/examples/Payment-Refund-Uk-Sucess-Notification'
                US ACH RETURN AND REVERSAL:
                  $ref: >-
                    #/components/examples/Us-Ach-Retrun-Reversal-Success-Notification
                Googlepay Refund Transfer:
                  $ref: >-
                    #/components/examples/Googlepay-Refund-Card-Sucess-Notification
                Applepay Refund Transfer:
                  $ref: >-
                    #/components/examples/Applepay-Refund-Card-Sucess-Notification
                Ppro Refund Transfer:
                  $ref: '#/components/examples/Ppro-Refund-Card-Sucess-Notification'
        '400':
          $ref: '#/components/responses/Bad-Get-Request2'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '429':
          $ref: '#/components/responses/Rate-Limit-Exceeded'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
  /digitalpayments/v1/payment-acceptance/refunds/{id}:
    patch:
      tags:
        - Refunds
      summary: Update a payment with selected payment method.
      description: Update a payment.
      operationId: refundUpdate
      parameters:
        - $ref: '#/components/parameters/Idempotency-Id'
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/Id'
        - $ref: '#/components/parameters/Merchant-Post-Id'
        - $ref: '#/components/parameters/Refund-Patch-Operation'
        - $ref: '#/components/parameters/Post-Country-Code'
      requestBody:
        description: Update a payment with selected payment method.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Refund-Update-Request'
            examples:
              US Card Refund Update Request:
                $ref: '#/components/examples/Us-Refund-Update-Request-Example'
              US Card Refund Cancel Request:
                $ref: '#/components/examples/Us-Refund-Cancel-Request-Example'
              US GooglePay Refund Cancel Request:
                $ref: >-
                  #/components/examples/Us-Google-Pay-Refund-Cancel-Request-Example
              US ApplePay Refund Cancel Request:
                $ref: >-
                  #/components/examples/Us-Apple-Pay-Refund-Cancel-Request-Example
      security:
        - clientCredentials: []
      callbacks:
        refund-cancel-success:
          $ref: '#/components/callbacks/Refund-Cancel-Success'
        refund-cancel-failed:
          $ref: '#/components/callbacks/Refund-Cancel-Failed'
      responses:
        '202':
          $ref: '#/components/responses/Accepted'
        '400':
          $ref: '#/components/responses/Bad-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '415':
          $ref: '#/components/responses/Unsupported-Media-Type'
        '429':
          $ref: '#/components/responses/Rate-Limit-Exceeded'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
  /digitalpayments/v1/payment-acceptance/tokens:
    post:
      tags:
        - Tokens
      summary: Create a Tokenization request.
      description: >-
        This endpoint validates your request and synchronously responds with
        HTTP status 202 (accepted) after successful validation. If validation
        fails, the endpoint synchronously responds with error (HTTP status 4XX /
        5XX and any applicable reason code), indicating Citi couldn't accept
        your tokenization creation request.
      operationId: tokenize
      parameters:
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/Idempotency-Id'
        - $ref: '#/components/parameters/Merchant-Token-Id'
        - $ref: '#/components/parameters/Value-Added-Services'
      requestBody:
        description: Create Tokenization request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tokenization-Create-Request'
            examples:
              Citi_Token_Create_Request:
                $ref: '#/components/examples/Citi-Token-Create-Request-Example'
              Network_Token_Create_Request:
                $ref: '#/components/examples/Network-Token-Create-Request-Example'
              Account_Updater_Create_Request:
                $ref: >-
                  #/components/examples/Account-Updater-Token-Create-Request-Example
      security:
        - clientCredentials: []
      callbacks:
        tokenization-create-request-status:
          $ref: '#/components/callbacks/Tokenization-Create-Request-Status'
      responses:
        '202':
          $ref: '#/components/responses/Request-Accepted'
        '400':
          $ref: '#/components/responses/Bad-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '415':
          $ref: '#/components/responses/Unsupported-Media-Type'
        '429':
          $ref: '#/components/responses/Rate-Limit-Exceeded'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
        default:
          $ref: '#/components/responses/Internal-Server-Error'
    get:
      tags:
        - Tokens
      summary: Retrieve token details
      description: >-
        Get the latest statuses of tokenization using matching criteria.
        Currently, you can get the latest tokenization statuses up to 90 days
        from the token creation date. If the tokenization statuses date is 90+
        days old, the endpoint responds with HTTP status 404 (not found).
      operationId: getToken
      parameters:
        - $ref: '#/components/parameters/Client-Id'
        - $ref: '#/components/parameters/Get-Token-Id'
        - $ref: '#/components/parameters/Merchant-Id'
      security:
        - clientCredentials: []
      responses:
        '200':
          description: Token status
          headers:
            apim-guid:
              schema:
                type: string
              description: Citi's unique identification for your request
 

# --- truncated at 32 KB (875 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/openapi/citi-digitalpaymentscollectionsv12-openapi.yaml