Payments
payments
Methods
This API allows clients to inquire details of their transactions for both Incoming and Outgoing payments based on various significant parameters.
Content-Type : Supports application/json and format PSRJ03 :
Authorization : The OAuth Token prefixed with ?Bearer? and space in between. :
Payment initiation
This service allows you to initiate new payments by accommodating different data attributes for all the available payment methods. After the initial API request call, user receive a response that denotes whether the payment has passed the basic validations.
Initiating a payment using the Payment Initiation API involves making a well-formed POST request to the CitiConnect API.
Supported ISO formats under Payment Initiation API
|Payment Nature| ISO XML format||--|--||Outgoing Payment| pain.001.001.03||Direct Debit Payment| pain.008.001.02|
How to initiate CitiConnect Payment
1. Authenticate to CitiConnect API (Go To Link)
2. Make an API call by specifying the Payment Initiation service URL.
3. Specify your request headers. (See Appendix D: Payment Initiation API Reference for sample requests.)
4. Specify all mandatory values in the ISOXML file at the minimum and encode the XML file with Base64 to place it in the
5. Review further status using ?Payment Status Inquiry? API.
https://tts.{env_name1}.apib2b.citi.com/citiconnect/{env_name2}/paymentservices/v1/payment/initiation?client_id={client_id}
Parameters
Headers
i.Content-Type( required)
ii.PayloadType(required)
iii.Authorization (required)
Body
Specify all mandatory values in the ISOXML V3 (pain.001.001.03) file at the minimum and encode the XML file with Base64 to place it in the
Response Types
This API allows you to initiate reconfirm/reject FI payments in JSON and XML format.
Unique reference which was shared during CitiConnect API on-boarding(client_id which used during oauth token generation)
This is the five digits reconfirm/reject code (Example DUPL) which is specified by the customer to request to reconfirm/reject the transaction
This field specifies the Product processor Reference Number for the transaction that needs to be reconfirm/reject. UETR or citi_reference with interbank_settlement_date or instruction_id with interbank_settlement_date is mandatory.
This is a unique instrution id that identifies a transaction that needs to be reconfirm/reject. UETR or citi_reference with interbank_settlement_date or instruction_id with interbank_settlement_date is mandatory.
This field specifies the value date (yyyy-MM-dd) of the original transaction that needs to be reconfirm/reject (the date on which funds were credited to the account).
Unique End-to-end Transaction Reference (UETR) relating to a payment has been identified as being associated with a Request for reconfirm/reject. It should follow UUID version 4 format. UETR or citi_reference with interbank_settlement_date or instruction_id with interbank_settlement_date is mandatory.
This API allows you to initiate stop/recall FI payments in JSON and XML format.
Domain types
Inquiry
payments.inquiry
Methods
Payment Status inquiry
This service allows you to access the status of your payments where it generates payment details with status of the payment transaction.
How to initiate to Payment Status Inquiry
To initiate status inquiry to CitiConnect API, you must perform the following tasks in your source code:
1. Authenticate to CitiConnect API (go To link)
2. Make an API call by specifying the Payment Status Inquiry service URL.
3. Specify your request headers.
4. Specify all mandatory values in the XML file at the minimum. Then sign and encrypt the payload in the body of the request with mandatory header values.
5. Review further status using ?Payment Status Inquiry? API.
https://tts.{env_name1}.apib2b.citi.com/citiconnect/{env_name2}/paymentservices/v1/payment/inquiry?client_id={client_id}
Parameters
Headers
i.Content-Type( required)
ii.Authorization ( required)
Body
i.EndToEndId( required):
Unique identification assigned by the initiating party to clearly identify the transaction. This Identification is passed on, unchanged, throughout the entire end-to-end chain.ii.CreDt:
Date when the payment initiation started. The date format is: YYYY-MM-DD.iii.InstdAmt, Ccy :
Amount of money transferred between the debtor and the creditor before any deduction of charges is made. This is expressed in the currency that is specified by the initiating party.iv. ReqdExctnDt :
Date that the initiating party requests that the clearing agent process the payment.Response Types
Payment Status inquiry- GET
This service allows you to access the status of your payments in an innovative way where it generates payment details with status of the payment transaction.
How to initiate to Payment Status Inquiry
To initiate status inquiry to CitiConnect API, you must perform the following tasks in your source code:
1. Authenticate to CitiConnect API
2. Make an API call by specifying the Payment Status Inquiry service (GET Verb) URL.
3. Specify your request headers.
4. Specify all mandatory values in the XML file at the minimum. Then sign and encrypt the payload in the body of the request with mandatory header values.
_5_. Review further status using ?Payment Status Inquiry(GET Verb)? API.
https://tts.{env_name1}.apib2b.citi.com/citiconnect/{env_name2}/paymentservices/v1/payment/inquiry?client_id={client_id}
Parameters
Headers
i.Content-Type( required)
ii.Authorization ( required)