WorldLink Payment Initiation

POST

///v3/payment/initiation

POST

/v3/payment/initiation

curl -X POST /v3/payment/initiation \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/xml" \
     -d '{
  "paymentBase64": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxEb2N1bWVudCB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0idXJuOmlzbzpzdGQ6aXNvOjIwMDIyOnRlY2g6eHNkOnBhaW4uMDAxLjAwMS4wMyI+DQogIDxDc3RtckNkdFRyZkluaXRuPg0KICAgIDxHcnBIZHI+DQogICAgICA8TXNnSWQ+R0JQMTYxMTE0Njk0ODY5PC9Nc2dJZD4NCiAgICAgIDxDcmVEdFRtPjIwMTctMDYtMDJUMTA6MTc6NTU8L0NyZUR0VG0+DQogICAgICA8TmJPZlR4cz4xPC9OYk9mVHhzPg0KICAgICAgPEN0cmxTdW0+MS4wMDwvQ3RybFN1bT4NCiAgICAgIDxJbml0Z1B0eT4NCiAgICAgICAgPE5tPkh1ZHNvbiBBZHZpc29ycyBFdXJvcGUgTHRkPC9ObT4NCiAgICAgIDwvSW5pdGdQdHk+DQogICAgPC9HcnBIZHI+DQogICAgPFBtdEluZj4NCiAgICAgIDxQbXRJbmZJZD4xNDAxNzQ5OCBGdW5kIFRyYW5zZmVyIERvbWVzdGljPC9QbXRJbmZJZD4NCiAgICAgIDxQbXRNdGQ+VFJGPC9QbXRNdGQ+DQogICAgICA8TmJPZlR4cz4xPC9OYk9mVHhzPg0KICAgICAgPEN0cmxTdW0+MS4wMDwvQ3RybFN1bT4NCiAgICAgIDxQbXRUcEluZj4NCiAgICAgICAgPFN2Y0x2bD4NCiAgICAgICAgICA8Q2Q+VVJHUDwvQ2Q+DQogICAgICAgIDwvU3ZjTHZsPg0KICAgICAgPC9QbXRUcEluZj4NCiAgICAgIDxSZXFkRXhjdG5EdD4yMDE5LTA4LTIwPC9SZXFkRXhjdG5EdD4NCiAgICAgIDxEYnRyPg0KICAgICAgICA8Tm0+Q0lUSUJBTksgRS1CVVNJTkVTUyBFVVIgRFVNIERFTU88L05tPg0KICAgICAgICA8UHN0bEFkcj4NCiAgICAgICAgICA8Q3RyeT5HQjwvQ3RyeT4NCiAgICAgICAgPC9Qc3RsQWRyPg0KICAgICAgICA8SWQ+DQogICAgICAgICAgPE9yZ0lkPg0KICAgICAgICAgICAgPEJJQ09yQkVJPkNJVElHQjJMPC9CSUNPckJFST4NCiAgICAgICAgICA8L09yZ0lkPg0KICAgICAgICA8L0lkPg0KICAgICAgPC9EYnRyPg0KICAgICAgPERidHJBY2N0Pg0KICAgICAgICA8SWQ+DQogICAgICAgICAgPE90aHI+DQogICAgICAgICAgICA8SWQ+MTAwMTIyNjI8L0lkPg0KICAgICAgICAgIDwvT3Rocj4NCiAgICAgICAgPC9JZD4NCiAgICAgICAgPENjeT5VU0Q8L0NjeT4NCiAgICAgIDwvRGJ0ckFjY3Q+DQogICAgICA8RGJ0ckFndD4NCiAgICAgICAgPEZpbkluc3RuSWQ+DQogICAgICAgICAgPEJJQz5DSVRJR0IyTDwvQklDPg0KICAgICAgICAgIDxQc3RsQWRyPg0KICAgICAgICAgICAgPEN0cnk+R0I8L0N0cnk+DQogICAgICAgICAgPC9Qc3RsQWRyPg0KICAgICAgICA8L0Zpbkluc3RuSWQ+DQogICAgICA8L0RidHJBZ3Q+DQogICAgICA8Q2hyZ0JyPkRFQlQ8L0NocmdCcj4NCiAgICAgIDxDZHRUcmZUeEluZj4NCiAgICAgICAgPFBtdElkPg0KICAgICAgICAgIDxFbmRUb0VuZElkPlBBMjAxODIwMTkxMjwvRW5kVG9FbmRJZD4NCiAgICAgICAgPC9QbXRJZD4NCiAgICAgICAgPEFtdD4NCiAgICAgICAgICA8SW5zdGRBbXQgQ2N5PSJVU0QiPjEuMDA8L0luc3RkQW10Pg0KICAgICAgICA8L0FtdD4NCiAgICAgICAgPFVsdG10RGJ0cj4NCiAgICAgICAgICA8SWQ+DQogICAgICAgICAgICA8UHJ2dElkPg0KICAgICAgICAgICAgICA8T3Rocj4NCiAgICAgICAgICAgICAgICA8SWQ+UEFSVElDSVBBTlQgSUQgUE9CTyBVSyBCUjYwMCAwMTIzNDU8L0lkPg0KICAgICAgICAgICAgICAgIDxTY2htZU5tPg0KICAgICAgICAgICAgICAgICAgPFBydHJ5PklOU1Q8L1BydHJ5Pg0KICAgICAgICAgICAgICAgIDwvU2NobWVObT4NCiAgICAgICAgICAgICAgPC9PdGhyPg0KICAgICAgICAgICAgPC9QcnZ0SWQ+DQogICAgICAgICAgPC9JZD4NCiAgICAgICAgPC9VbHRtdERidHI+DQogICAgICAgIDxDZHRyQWd0Pg0KICAgICAgICAgIDxGaW5JbnN0bklkPg0KICAgICAgICAgICAgPEJJQz5DSVRJR0IyTDwvQklDPg0KICAgICAgICAgICAgPENsclN5c01tYklkPg0KICAgICAgICAgICAgICA8TW1iSWQ+MTg1MDA4PC9NbWJJZD4NCiAgICAgICAgICAgIDwvQ2xyU3lzTW1iSWQ+DQogICAgICAgICAgICA8Tm0+Q0lUSUJBTksoSVNPKTwvTm0+DQogICAgICAgICAgICA8UHN0bEFkcj4NCiAgICAgICAgICAgICAgPEN0cnk+R0I8L0N0cnk+DQogICAgICAgICAgICA8L1BzdGxBZHI+DQogICAgICAgICAgPC9GaW5JbnN0bklkPg0KICAgICAgICA8L0NkdHJBZ3Q+DQogICAgICAgIDxDZHRyPg0KICAgICAgICAgIDxObT44MDEwNjQzMTIyWCBYWFhYWFhYWFhYWFhYIFhYWDwvTm0+DQogICAgICAgICAgPFBzdGxBZHI+DQogICAgICAgICAgICA8Q3RyeT5HQjwvQ3RyeT4NCiAgICAgICAgICA8L1BzdGxBZHI+DQogICAgICAgICAgPEN0Y3REdGxzPg0KICAgICAgICAgICAgPE5tPldEVyAzIElOVkVTVE1FTlRTIExJTUlURUQ8L05tPg0KICAgICAgICAgIDwvQ3RjdER0bHM+DQogICAgICAgIDwvQ2R0cj4NCiAgICAgICAgPENkdHJBY2N0Pg0KICAgICAgICAgIDxJZD4NCiAgICAgICAgICA8T3Rocj4NCiAgICAgICAgICAgICAgICAgICA8SWQ+MTAwMTIyNjI8L0lkPg0KICAgICAgICAgICAgICAgICAgPC9PdGhyPg0KICAgICAgICAgIDwvSWQ+DQogICAgICAgIDwvQ2R0ckFjY3Q+DQogICAgICAgIDxSbXRJbmY+DQogICAgICAgICAgPFVzdHJkPlRSMDAyNjM4PC9Vc3RyZD4NCiAgICAgICAgPC9SbXRJbmY+DQogICAgICA8L0NkdFRyZlR4SW5mPg0KICAgIDwvUG10SW5mPg0KICA8L0NzdG1yQ2R0VHJmSW5pdG4+DQo8L0RvY3VtZW50Pg=="
}'

200Payment-Initiation-Request-Xml (application/xml)

"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n  <Document xmlns=\"urn:iso:std:iso:20022:tech:xsd:pain.002.001.03\">\n    <CstmrPmtStsRpt>\n      <GrpHdr>\n        <MsgId>7777108</MsgId>\n        <CreDtTm>2020-02-20T18:00:00</CreDtTm>\n        <InitgPty>\n          <Nm>TDBank</Nm>\n          <Id>\n            <OrgId>\n              <Othr>\n                <Id>248840001</Id>\n              </Othr>\n            </OrgId>\n          </Id>\n        </InitgPty>\n      </GrpHdr>\n      <OrgnlGrpInfAndSts>\n        <OrgnlMsgId>7777108</OrgnlMsgId>\n        <OrgnlMsgNmId>Pain.001.001.03</OrgnlMsgNmId>\n        <OrgnlCreDtTm>2020-02-20T18:00:00</OrgnlCreDtTm>\n        <OrgnlNbOfTxs>1</OrgnlNbOfTxs>\n        <OrgnlCtrlSum>33</OrgnlCtrlSum>\n      </OrgnlGrpInfAndSts>\n      <OrgnlPmtInfAndSts>\n        <OrgnlPmtInfId>7777108</OrgnlPmtInfId>\n        <TxInfAndSts>\n          <OrgnlInstrId>WLPAYMENTTEST4</OrgnlInstrId>\n          <OrgnlEndToEndId>WLPAYMENTTEST4</OrgnlEndToEndId>\n          <TxSts>ACCP</TxSts>\n          <OrgnlTxRef>\n            <Amt>\n              <EqvtAmt>\n                <Amt Ccy=\"CLP\">33</Amt>\n                <CcyOfTrf>INR</CcyOfTrf>\n              </EqvtAmt>\n            </Amt>\n            <ReqdExctnDt>2025-09-24</ReqdExctnDt>\n            <PmtTpInf>\n              <SvcLvl>\n                <Cd>URGP</Cd>\n              </SvcLvl>\n              <LclInstrm>\n                <Prtry>CITI949</Prtry>\n              </LclInstrm>\n            </PmtTpInf>\n            <PmtMtd>TRF</PmtMtd>\n            <RmtInf>\n              <Ustrd>PAYMENT FOR GOODS</Ustrd>\n              <Ustrd>PYMT TYPE P0108</Ustrd>\n              <Ustrd>PYMTTYPEIAT3 PMDDInvoiceAmount07012</Ustrd>\n              <Ustrd>/BPS/77</Ustrd>\n            </RmtInf>\n            <Dbtr>\n              <Nm>Mr. John Cena</Nm>\n              <PstlAdr>\n                <Ctry>CA</Ctry>\n                <AdrLine>004-87690-45874125</AdrLine>\n                <AdrLine>123 Long Street Name</AdrLine>\n                <AdrLine>Toronto</AdrLine>\n                <AdrLine>Ontario M5H 1A1</AdrLine>\n              </PstlAdr>\n            </Dbtr>\n            <DbtrAcct>\n              <Id>\n                <Othr>\n                  <Id>1100008234</Id>\n                </Othr>\n              </Id>\n              <Ccy>CLP</Ccy>\n            </DbtrAcct>\n            <DbtrAgt>\n              <FinInstnId>\n                <BIC>CITICATTBCH</BIC>\n                <Othr>\n                  <Id>248840001</Id>\n                </Othr>\n              </FinInstnId>\n            </DbtrAgt>\n            <CdtrAgt>\n              <FinInstnId>\n                <ClrSysMmbId>\n                  <MmbId>221272303</MmbId>\n                </ClrSysMmbId>\n                <Nm>KRISH</Nm>\n                <PstlAdr>\n                  <Ctry>US</Ctry>\n                </PstlAdr>\n              </FinInstnId>\n            </CdtrAgt>\n            <Cdtr>\n              <Nm>Prof. Ryan Myn</Nm>\n              <PstlAdr>\n                <Ctry>US</Ctry>\n                <AdrLine>004-87690-45874125</AdrLine>\n                <AdrLine>123 Long Street Name</AdrLine>\n                <AdrLine>Toronto</AdrLine>\n                <AdrLine>Ontario M5H 1A1</AdrLine>\n              </PstlAdr>\n            </Cdtr>\n            <CdtrAcct>\n              <Id>\n                <Othr>\n                  <Id>38456275968463578</Id>\n                </Othr>\n              </Id>\n              <Tp>\n                <Cd>CACC</Cd>\n              </Tp>\n            </CdtrAcct>\n          </OrgnlTxRef>\n        </TxInfAndSts>\n      </OrgnlPmtInfAndSts>\n    </CstmrPmtStsRpt>\n  </Document>\n"

The CitiConnect WorldLink Payment Initiation endpoint allows users to perform payment initiation through their ERP/partner systems of choice.
Content-Type: Supports application/xml:

Authentication

AuthorizationBearer

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 authentication used by this API. See the Citi Authentication API reference for information on requesting a token.

Query parameters

client_idstringRequired

Unique identifier created during the onboarding process.

Request

Request body. Encode this XML request body with Base64 to place it in the <Request><paymentBase64> tag.

paymentBase64stringRequired

Base64 encoded string of ISO XML payment initiation input xml. Based on the use case, you should use one of the ISO schema. Use PACS schema for financial institutions and PAIN format for non-financial clients. ISO schema can be refered from below URL pain.001.001.03 - https://www.iso20022.org/message/14316/download or #/definitions/Pain001

Response

psrDocumentstringOptionalformat: "byte"

Base64 encoded string of ISO XML payment initiation response xml. ISO schema can be found @ https://www.iso20022.org/message/14361/download or #/definitions/Pain002

Authentication

Headers

Query parameters

Request

Response