The identity and technical contract details declared by the specification.
Gateway-Error-Response
object
3 properties
3 required
Service-Error-Response
object
2 properties
2 required
Error-Detail
object
3 properties
Merchant-Onboarding-Request
Request parameters for Merchant Onboarding Request.
Get-Merchant-Onboarding
Response for Get Merchant Onboarding.
Common-Merchant-Onboarding-Request
object
Request parameters for Merchant Onboarding Request.
3 properties
3 required
Merchant-Onboarding-Response
object
Response parameters for Merchant Onboarding Response.
2 properties
Status-Details
object
Status Details.
2 properties
File-Upload-Response
object
Response parameters for file upload.
3 properties
File-Download-Response
array
Response for file download.
File-Download
object
File download details.
2 properties
File-Id
string
Unique identifier for the document uploaded.
Created-Time
string
Date and time of the file created. Pattern YYYY-MM-DDTHH:mm:ssZ
Merchant-Id
string
Unique identifier generated by Citi for each seller. Seller to use this id for the further functional calls.
Partner-User-Id
string
Partner user identifier for seller from your system.
Status
string
Status of the request.
Message
string
Description of the status.
Business-Address
object
Address information for company.
5 properties
Document
object
Document information for KYC validation including document type, sub-type, and file reference.
4 properties
1 required
Person-Document
object
Document information for business person KYC validation.
7 properties
2 required
Business-Person-Address
Business person address information.
Country-Code
string
Country code.
Common-Date
string
Date in ISO 8601 (YYYY-MM-DD).
Birth-Details
object
Birth information of the business person.
3 properties
Personal-Details
object
This section contains the name details.
6 properties
Business-Person
Business person details for KYC certification.
Business
object
Detailed information of the business for certification.
14 properties
1 required
Account-Usage
string
Description of merchant's business purpose of using PSP account. Required for CN and HK.
Certification-Request
Request body for submitting certification information for KYC verification.
Certification-Common-Details
object
Certification details.
3 properties
Webhook-Certification
Notification for certification status updates.
Get-Certification-Response
Response body for retrieving certification details including KYC status and business information.
Wallet-Activation-Request
object
Notification for wallet activation status update.
2 properties
2 required
Sync-Response
object
Acknowledgement.
1 property
Virtual-Account
object
This field contains the detailed information of account.
4 properties
Bank
object
This field contains the detailed information of bank.
10 properties
Webhook-Wallet-Activation
Wallet activation notification for the status update.
Webhook-Error-Response
Details of error in the request.
Common-Error-Response
object
Details of error in the request.
3 properties
Virtual-Account-Id
string
Account ID for a specific virtual account.
Wallet-Activation
object
Response body containing wallet activation details and virtual account information.
4 properties
Get-Wallet-Activation
Response body containing wallet activation details and virtual account information.
Get-Wallet-Activation-Response
array
Response body containing wallet and virtual account information.
Get-Wallet-Balances
array
Response body containing wallet balance information.
Wallet-Balance-Item
object
Balance information for a single account.
4 properties
Amount
number
Amount in currency.
Currency-Code
string
The currency code in the transaction.
Link-Account-Request
object
Request body for linking an external account for payments.
4 properties
3 required
Creditor-Id
string
The unique creditor identifier assigned by payment service provider.
Get-Link-Account-Response
array
Response body containing linked account details.
Creditor-Detail
object
Response body containing creditor's details.
8 properties
Webhook-Link-Account
Notification for Link account for the status update.
Get-Creditor-Account
This section contains the details information of bank.
Creditor-Account
Creditor Account.
Creditor-Account-Details
object
This section contains the details information of account.
8 properties
Get-Creditor-Bank
This section contains the details information of bank.
Creditor-Bank
Creditor Bank.
Creditor-Bank-Details
object
This section contains the details information of bank.
8 properties
Address-Details
object
Address information for the bank.
4 properties
Creditor
This section contains the details information of creditor.
Get-Creditor
This section contains the details information of creditor.
Common-Creditor
object
This section contains the details information of creditor.
5 properties
Partial-Address
object
Address information for the creditor.
2 properties
Creditor-Address
Address information for the creditor.
Creditor-Address-Details
Address information for the creditor.
Multiple-Currency-Amount
object
4 properties
Reference-Id
string
Unique identifier for this request from your system.
Fx-Rate-Id
string
When you request a guaranteed quote of Instant FX and Reserved FX, the Citi will return a fxrateid, which is the unique ID only for guaranteed fxindirate. fxra…
Fx-Rate
number
The indicative FX rate which is for reference only. The number indicates how much units of buycurrency you can get from one unit of sellcurrency.
Payment-Request
object
Request body for creating a payment. Contains the payload with debtor, creditor, and transaction details.
2 properties
1 required
Payment-Details
object
Payment details.
2 properties
1 required
Partner-User-Reference
string
Unique reference from seller for each payment.
Transaction-Details
object
Transaction details.
Method
object
This object contains the payment method and clearing network details.
3 properties
2 required
Payment-Info-Details
object
Payment Information details.
3 properties
2 required
Payment-Debtor
object
Information pertaining to debtor of the payment.
2 properties
Reporting-Debtor
Debtor details for reporting.
Reporting-Creditor
Crediotr details for reporting.
Payment-Creditor
object
Information pertaining to creditor of the payment.
2 properties
Account
object
Account details.
3 properties
Transaction
object
Details of the transaction.
2 properties
Payment-Response
object
Response body for payment initiation. Contains the details of the payment.
5 properties
Webhook-Payment-Request
Notification for payments to update the status.
Webhook-Transaction
object
Transaction details.
Message-Id
string
Unique id from your system for batch. Required for Payment to Wallet (virtualaccount credit).
Get-Payment-Response
object
Retrieve payments details.
2 properties
Get-Payment-Response-Details
object
Get Payment Response Details.
6 properties
Get-Transaction-Detail
object
Retrieve transaction details.
Rfi-Save-Request
object
Request body for responding to an RFI.
2 properties
2 required
Rfi-Save-Response
object
Response body for responding to an RFI.
3 properties
Rfi-Id
string
RFI unique id.
Questions-Request
object
A question with response information for RFI submission.
2 properties
2 required
Questions-Response
object
A question with response information for RFI submission.
2 properties
Question-Id
string
The unique id for specific question.
Information-Request
Information item that needs to be responded to in an RFI.
Information-Request-Response
Information item that needs to be responded to in an RFI.
Common-Information-Request
object
Information item that needs to be responded to in an RFI.
2 properties
Get-Information-Request
Information item that needs to be responded to in an RFI.
Information-Type
string
Information type: text or file.
Information-Name
string
Information name.
Answer
string
The answer for the information request.
Rfi-Query-Response
array
The information to be responded to.
Rfi-Query-Item
Response containing RFI list and details.
Common-Rfi
object
Response containing RFI list and details.
6 properties
Question
An individual RFI question.
Common-Question
object
An individual RFI question.
5 properties
Merchant-Type
string
Type of merchant.
Certification-Source
Information related to the KYC source.
Rfi-Submit-Request
object
Request body for submitting an RFI for review.
1 property
1 required
Rfi-Submit-Response
object
Response body for RFI Submit.
1 property
Pagination-Metadata
object
currentpage: Current page number totalpages: Total number of pages available for this request pagesize: The number of records to display per page hasmore: Any…
4 properties
Uetr
string
This is a unique payment service provider ID assigned to all individual transactions.
End-To-End-Id
string
The unique payment request ID from your system. If the request is for payment to wallet, this field should contain maximum 16 character and should be in UPPER…
Completed-Time
string
The time the transaction was finished. Pattern YYYY-MM-DDTHH:mm:ssZ
Balance-Transaction
object
Transaction details for balance reporting including opening and closing balances.
10 properties
Balance-Report-Response
array
Payment-Type
string
Transaction type. WITHDRAW is applicable only if the payment is USD to CNY to China.
Reporting-Payment-Type
string
Transaction type.
Common-Transaction
object
Transaction details.
4 properties
Report-Transaction
Transaction details for reporting.
Report-Transaction-Detail
object
Transaction details for reporting.
Transaction-Report-Response
array
Inbound-Payment-Notification
object
Inbound payment notification.
8 properties
Inbound-Debtor
object
This section contains detailed payor information.
Debtor-Bank
object
This section contains detailed payor bank information.
1 property
Common-Inbound
object
This section contains Common details.
3 properties
Inbound-Creditor
object
This section contains detailed payee information.
Inbound-Transaction
object
This section contains detailed transaction information.
RFI-Notification
object
Request for Information (RFI) notification.
RFI-Question
An individual RFI question with its associated information requests and certification source.
Information-Request-Webhook
object
Information that needs to be responded to for the RFI question.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
