```json
{
"openapi": "3.1.0",
"info": {
"title": "Visa Direct Connect",
"description": "Visa Direct Connect provides simple, fast and streamlined access to our money movement solutions",
"version": "1"
},
"servers": [
{
"url": "https://sandbox.api.visa.com",
"description": "Sandbox server"
}
],
"security": [],
"tags": [
{
"name": "Eligibility",
"description": "Eligibility API will enable Visa Direct Connect clients to check eligibility of recipient payment instrument(Cards). It will provide the details if the card can be used for payout/payin, cardis fast funds enabled and what other non-visa networks are enabled."
}
],
"paths": {
"/visadirect-connect/v1/cards/eligibility": {
"post": {
"tags": [
"Eligibility"
],
"summary": "Eligibility check of Card",
"description": "Validates if a card is eligible for payout or payin payments",
"operationId": "cardEligibility",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EligibilityRequestData"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful verification check",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EligibilityResponseData"
}
}
}
},
"400": {
"$ref": "#/components/responses/400ErrorResponses"
},
"401": {
"$ref": "#/components/responses/401ErrorResponse"
},
"403": {
"$ref": "#/components/responses/403ErrorResponse"
},
"500": {
"$ref": "#/components/responses/500ErrorResponse"
},
"503": {
"$ref": "#/components/responses/503ErrorResponse"
}
},
"x-operationVersions": [
{
"label": "v1 - Latest",
"operationPointer": "#/paths/~1visadirect-connect~1v1~1cards~1eligibility/post",
"default": false
}
],
"x-hideTryIt": true
}
}
},
"components": {
"schemas": {
"PosEnvironment": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "POS environment"
},
"OCTNetworkResponseSettlementInfo": {
"required": [
"settlementResponsibilityFlag"
],
"type": "object",
"properties": {
"givUpdatedFlag": {
"$ref": "#/components/schemas/GivUpdatedFlag"
},
"settlementAmount": {
"$ref": "#/components/schemas/SettlementAmount"
},
"settlementServiceFlag": {
"$ref": "#/components/schemas/SettlementServiceFlag"
},
"settlementCurrencyCode": {
"$ref": "#/components/schemas/SettlementCurrencyCode"
},
"givPreviouslyUpdatedFlag": {
"$ref": "#/components/schemas/GivPreviouslyUpdatedFlag"
},
"settlementConversionRate": {
"$ref": "#/components/schemas/FxConversionRate"
},
"settlementResponsibilityFlag": {
"$ref": "#/components/schemas/SettlementResponsibilityFlag"
}
}
},
"VauErrorReasonCode": {
"maxLength": 6,
"minLength": 6,
"type": "string",
"description": "Error reason code for VAU",
"example": "000000"
},
"AFTResponseOriginatorDetail": {
"type": "object",
"properties": {
"cardAcceptor": {
"$ref": "#/components/schemas/AFTResponseCardAcceptor"
}
}
},
"OCTSenderDetail": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/SenderName"
},
"type": {
"$ref": "#/components/schemas/SenderType"
},
"address": {
"type": "object",
"properties": {
"city": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "City of sender's address"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Country of sender's address"
},
"stateCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "State code of sender's address"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Postal code of sender's address"
},
"addressLine1": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "First line of sender's address"
},
"addressLine2": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Second line of sender's address"
}
}
},
"lastName": {
"$ref": "#/components/schemas/SenderLastName"
},
"firstName": {
"$ref": "#/components/schemas/SenderFirstName"
},
"middleName": {
"$ref": "#/components/schemas/SenderMiddleName"
},
"occupation": {
"$ref": "#/components/schemas/Occupation"
},
"dateOfBirth": {
"$ref": "#/components/schemas/DateOfBirth"
},
"nationality": {
"$ref": "#/components/schemas/Nationality"
},
"contactEmail": {
"$ref": "#/components/schemas/SenderContactEmail"
},
"senderAddress": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Address of sender"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OCTSenderDetailAdditionalData"
}
},
"countryOfBirth": {
"$ref": "#/components/schemas/SenderCountryOfBirth"
},
"identificationList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SenderIdentification"
}
},
"senderAccountNumber": {
"$ref": "#/components/schemas/SenderAccountNumber"
},
"senderReferenceNumber": {
"$ref": "#/components/schemas/SenderReferenceNumber"
},
"senderAccountNumberType": {
"type": "string",
"description": "Type of sender account number",
"enum": [
"DEFAULT"
]
},
"paymentCredentialReference": {
"$ref": "#/components/schemas/OctSenderPaymentCredentialReference"
}
},
"description": "Sender details for Original Credit Transaction.\nConditional\nOnly one of 'senderAccountNumber' and 'paymentCredentialReference' is provided in a request.\n"
},
"RecipientCountryOfBirth": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Recipient country of birth. Format: 3-digit numeric or 3-character ISO-3166 (Alpha-3) country code. ISO20022 field name: Creditor Country of Birth.\n",
"example": "840 USA"
},
"TaxAmount": {
"type": "number",
"description": "Tax amount value",
"format": "double",
"example": 8
},
"OCTRecipientDetail": {
"type": "object",
"properties": {
"card": {
"$ref": "#/components/schemas/OCTRecipientCard"
},
"name": {
"$ref": "#/components/schemas/RecipientName"
},
"type": {
"$ref": "#/components/schemas/RecipientType"
},
"address": {
"type": "object",
"properties": {
"city": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "City of recipient's address"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Country of recipient's address"
},
"stateCode": {
"maxLength": 3,
"minLength": 1,
"type": "string",
"description": "State code of recipient's address"
},
"postalCode": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Postal code of recipient's address"
},
"addressLine1": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "First line of recipient's address"
},
"addressLine2": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Second line of recipient's address"
},
"subDivisionMinorCode": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Sub-division minor code of recipient's address"
}
}
},
"lastName": {
"$ref": "#/components/schemas/RecipientLastName"
},
"firstName": {
"$ref": "#/components/schemas/RecipientFirstName"
},
"middleName": {
"$ref": "#/components/schemas/RecipientMiddleName"
},
"occupation": {
"$ref": "#/components/schemas/Occupation"
},
"dateOfBirth": {
"$ref": "#/components/schemas/RecipientDateOfBirth"
},
"nationality": {
"$ref": "#/components/schemas/Nationality"
},
"contactEmail": {
"$ref": "#/components/schemas/RecipientContactEmail"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OCTRecipientDetailAdditionalData"
}
},
"countryOfBirth": {
"$ref": "#/components/schemas/RecipientCountryOfBirth"
},
"identificationList": {
"$ref": "#/components/schemas/RecipientIdentificationList"
},
"paymentCredentialReference": {
"$ref": "#/components/schemas/PaymentCredentialReference"
}
},
"description": "Recipient details for Original Credit Transaction. \nConditional\nOnly one of 'card' and 'paymentCredentialReference' is provided in a request.\n"
},
"PosConditionCode": {
"type": "number",
"description": "Contains a code identifying transaction conditions at the point of sale or point of service.",
"example": 59
},
"EligibilityResponseData": {
"required": [
"cardEligibilityDetail"
],
"type": "object",
"properties": {
"cardEligibilityDetail": {
"$ref": "#/components/schemas/CardEligibilityDetail"
}
},
"description": "Response data for checking card eligibility"
},
"LocalTransactionDateTime": {
"type": "string",
"description": "Local date and time of the transaction",
"format": "date-time",
"example": "2023-06-15T14:25:32Z"
},
"VisaRateTableId": {
"maxLength": 5,
"minLength": 1,
"type": "string",
"description": "Visa rate table identifier",
"example": "12345"
},
"TerminalId": {
"maxLength": 8,
"type": "string",
"description": "Identifier for the terminal at the card acceptor location",
"example": "TERM1234"
},
"AFTResponsePosData": {
"type": "object",
"properties": {
"motoECIIndicator": {
"$ref": "#/components/schemas/MotoECIIndicator"
},
"integratedCircuitCardData": {
"$ref": "#/components/schemas/IntegratedCircuitCardData"
}
}
},
"AFTResponseData": {
"required": [
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"$ref": "#/components/schemas/AFTResponseOriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/AFTResponseTransactionDetail"
}
},
"description": "Account Funding Transaction (AFT) response data structure"
},
"RecipientCityOfBirth": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient city of birth. ISO20022 field name: Creditor City of Birth.\n",
"example": "New York"
},
"SenderCardPosData": {
"type": "object",
"properties": {
"pinData": {
"$ref": "#/components/schemas/PinData"
},
"magneticStripeData": {
"$ref": "#/components/schemas/MagneticStripeData"
},
"integratedCircuitCardData": {
"$ref": "#/components/schemas/IntegratedCircuitCardData"
}
}
},
"Status": {
"type": "string",
"description": "Overall status of the transaction",
"example": "PAYMENT_DELIVERED",
"enum": [
"PAYMENT_DELIVERED",
"PAYMENT_DECLINED",
"IN_PROGRESS"
]
},
"MotoECIIndicator": {
"maximum": 8,
"minimum": 1,
"type": "number",
"description": "Identifies the level of security used in an electronic commerce transaction or the type of mail or telephone order. Defaults to 7 for US and 5 for rest of the world for e-Commerce transactions.",
"example": 7
},
"OCTNetworkResponsePosData": {
"type": "object",
"properties": {
"integratedCircuitCardData": {
"$ref": "#/components/schemas/IntegratedCircuitCardData"
}
}
},
"RiskAssessmentData": {
"type": "object",
"properties": {
"scpExemptionIndicator": {
"$ref": "#/components/schemas/ScpExemptionIndicator"
},
"traExemptionIndicator": {
"$ref": "#/components/schemas/TraExemptionIndicator"
},
"lowValueExemptionIndicator": {
"$ref": "#/components/schemas/LowValueExemptionIndicator"
},
"scaEnvironmentOutageIndicator": {
"$ref": "#/components/schemas/ScaEnvironmentOutageIndicator"
},
"delegatedAuthenticationIndicator": {
"$ref": "#/components/schemas/DelegatedAuthenticationIndicator"
},
"trustedMerchantExemptionIndicator": {
"$ref": "#/components/schemas/TrustedMerchantExemptionIndicator"
}
}
},
"SenderFirstName": {
"maxLength": 35,
"minLength": 2,
"type": "string",
"description": "Sender first name. Conditionally required when \"name\" is not provided. The length of first name and last name combined must be at least 3 characters. Must not contain exclusively numeric characters. Must not contain special symbols.\n",
"example": "John"
},
"MerchantVerificationValue": {
"maxLength": 10,
"minLength": 10,
"type": "string",
"description": "The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value.",
"example": "1234567890"
},
"VerificationTransactionDetail": {
"required": [
"clientReferenceId"
],
"type": "object",
"properties": {
"card": {
"$ref": "#/components/schemas/VerificationCard"
},
"posData": {
"$ref": "#/components/schemas/VerificationPosData"
},
"cardHolder": {
"$ref": "#/components/schemas/VerificationCardHolder"
},
"clientReferenceId": {
"maxLength": 12,
"minLength": 12,
"type": "string",
"description": "Reference identifier to tie multiple API calls with a single funds transfer transaction"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"paymentCredentialReference": {
"$ref": "#/components/schemas/AcnvPaymentCredentialReference"
}
},
"description": "Transaction details for Verification check Conditional Only one of 'card' and 'paymentCredentialReference' is provided in a request."
},
"ServiceLocationPostalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Postal code of the service location",
"example": "54321"
},
"PrepaidBalanceData": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Prepaid balance amount",
"format": "double"
},
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-character alpha ISO Currency code for the prepaid balance"
}
}
},
"PosData": {
"type": "object",
"properties": {
"pinData": {
"$ref": "#/components/schemas/PinData"
},
"panEntryMode": {
"type": "number",
"description": "PAN entry mode"
},
"posEnvironment": {
"$ref": "#/components/schemas/PosEnvironment"
},
"motoECIIndicator": {
"$ref": "#/components/schemas/MotoECIIndicator"
},
"posConditionCode": {
"$ref": "#/components/schemas/PosConditionCode"
},
"magneticStripeData": {
"$ref": "#/components/schemas/MagneticStripeData"
},
"pointOfServiceCapability": {
"$ref": "#/components/schemas/PointOfServiceCapability"
},
"integratedCircuitCardData": {
"$ref": "#/components/schemas/IntegratedCircuitCardData"
},
"specialConditionIndicatorMerchant": {
"$ref": "#/components/schemas/SpecialConditionIndicatorMerchant"
}
}
},
"MemberComments": {
"maxLength": 254,
"minLength": 1,
"type": "string",
"description": "This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider.\n"
},
"CustomerReference": {
"type": "string",
"description": "Customer reference"
},
"SharingGroupCode": {
"type": "string",
"description": "Optionally used by Push Payments Gateway participants to specify the network access priority. Supported only in US for domestic transactions involving Push Payments Gateway Service.",
"example": "SGCXXXXXXX"
},
"SettlementDate": {
"type": "string",
"description": "Date when settlement occurs",
"format": "date"
},
"AFTSenderCard": {
"required": [
"accountNumber",
"accountNumberType",
"expirationDate"
],
"type": "object",
"properties": {
"accountNumber": {
"maxLength": 19,
"minLength": 13,
"type": "string",
"description": "For \"DEFAULT\" PAN/Token can be entered from 13-19 characters."
},
"expirationDate": {
"$ref": "#/components/schemas/CardExpiryDate"
},
"schemeIdentifier": {
"$ref": "#/components/schemas/SchemeIdentifier"
},
"accountNumberType": {
"type": "string",
"enum": [
"DEFAULT"
]
},
"authenticationData": {
"$ref": "#/components/schemas/AuthenticationData"
},
"addressVerificationData": {
"$ref": "#/components/schemas/AddressVerificationData"
}
}
},
"AFTRecipientDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identificationNumberBusiness
Conditional.
This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)
If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:
AA
PP
TU
BI
WT
FT
For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN)."
},
"value": {
"maxLength": 20,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identificationNumberIndividual
Conditional.
This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification."
},
"value": {
"maxLength": 13,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "localNameData
This object is used to provide the recipient's local name data. This object is required for transactions where the recipient's local name data is required."
},
"value": {
"$ref": "#/components/schemas/RecipientLocalNameData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "contactInformationList
Contact Information list of recipient.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/ContactInformationList"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "ancillaryRecipientDetails
Ancillary recipient details.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/AncillaryRecipientDetails"
}
}
}
]
},
"RecipientAddress": {
"type": "object",
"properties": {
"city": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "City of the recipient's address",
"example": "San Francisco"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Country code (ISO 3166-1 alpha-3) of the recipient's address",
"example": "USA"
},
"stateCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "2-character abbreviated state code or territory code",
"example": "CA"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Postal or zip code of the recipient's address",
"example": "94404"
},
"addressLine1": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "First line of the recipient's address",
"example": "123 Main St"
},
"addressLine2": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Second line of the recipient's address",
"example": "Apt 4B"
},
"subDivisionMinorCode": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Sub-division minor code of recipient's address"
}
},
"description": "Address information of the recipient"
},
"AncillaryRecipientDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "This field identifies if the ancillary recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual."
},
"address": {
"$ref": "#/components/schemas/AncillaryRecipientDetailAddress"
},
"lastName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "This field contains ancillary recipient's last name"
},
"firstName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "This field contains ancillary recipient's first name"
},
"middleName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "This field contains ancillary recipient's middle name"
}
}
},
"AFTRecipientDetail": {
"required": [
"recipientAccountNumber"
],
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/RecipientName"
},
"type": {
"$ref": "#/components/schemas/RecipientType"
},
"address": {
"$ref": "#/components/schemas/RecipientAddress"
},
"lastName": {
"$ref": "#/components/schemas/RecipientLastName"
},
"firstName": {
"$ref": "#/components/schemas/RecipientFirstName"
},
"middleName": {
"$ref": "#/components/schemas/RecipientMiddleName"
},
"occupation": {
"$ref": "#/components/schemas/Occupation"
},
"dateOfBirth": {
"$ref": "#/components/schemas/RecipientDateOfBirth"
},
"nationality": {
"$ref": "#/components/schemas/Nationality"
},
"contactEmail": {
"$ref": "#/components/schemas/RecipientContactEmail"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AFTRecipientDetailAdditionalData"
}
},
"countryOfBirth": {
"$ref": "#/components/schemas/RecipientCountryOfBirth"
},
"identificationList": {
"$ref": "#/components/schemas/RecipientIdentificationList"
},
"recipientAccountNumber": {
"$ref": "#/components/schemas/RecipientAccountNumber"
},
"recipientReferenceNumber": {
"$ref": "#/components/schemas/RecipientReferenceNumber"
}
}
},
"TransactionLinkIdentifier": {
"maxLength": 36,
"minLength": 1,
"type": "string",
"description": "Unique identifier for the transaction link. This is used to identify the linked transaction in the system.\n"
},
"SenderContactEmail": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Sender email address.",
"format": "email",
"example": "john.smith@example.com"
},
"VerificationCardAcceptorAddress": {
"type": "object",
"properties": {
"city": {
"maxLength": 13,
"minLength": 1,
"type": "string",
"description": "City of the merchant or the funds transfer originator/operator",
"example": "SAN FRANCISCO"
},
"county": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "County of the funds transfer operator/originator",
"example": "SFO"
},
"country": {
"maxLength": 3,
"minLength": 2,
"type": "string",
"description": "3-digit numeric or 3-character alpha ISO country code for the country of the merchant or the originator or the funds transfer operator",
"example": "840 USA"
},
"stateCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "2-character abbreviated state code or territory code",
"example": "CA"
},
"postalCode": {
"maxLength": 9,
"minLength": 5,
"type": "string",
"description": "Zip/Postal code of the merchant or the funds transfer operator/originator",
"example": "94105"
}
},
"description": "Physical address, URL, or telephone number for the merchant or funds transfer originator/operator"
},
"ActionCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Standard two-digit code that specifies the action taken by the card issuer on this transaction. Refer to action codes",
"example": "00"
},
"QueryNetworkResponse": {
"required": [
"actionCode",
"approvalCode"
],
"type": "object",
"properties": {
"networkId": {
"$ref": "#/components/schemas/NetworkId"
},
"actionCode": {
"$ref": "#/components/schemas/ActionCode"
},
"approvalCode": {
"$ref": "#/components/schemas/ApprovalCode"
},
"dafIndicator": {
"$ref": "#/components/schemas/DafIndicator"
},
"originalActionCode": {
"$ref": "#/components/schemas/OriginalActionCode"
},
"cardVerificationResults": {
"type": "object",
"properties": {
"cavvResultCode": {
"$ref": "#/components/schemas/CavvResultCode"
},
"cvv2ResultCode": {
"$ref": "#/components/schemas/Cvv2ResultCode"
}
}
}
}
},
"OCTRequestData": {
"required": [
"originatorDetail",
"recipientDetail",
"senderDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"senderDetail": {
"$ref": "#/components/schemas/OCTSenderDetail"
},
"recipientDetail": {
"$ref": "#/components/schemas/OCTRecipientDetail"
},
"originatorDetail": {
"$ref": "#/components/schemas/OCTOriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/OCTTransactionDetail"
}
},
"description": "Original Credit Transaction (OCT) request data structure"
},
"IdentificationList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"idtype": {
"type": "string",
"enum": [
"CUID",
"NTID",
"PASN",
"DRLN",
"TXIN",
"CPNY",
"PRXY",
"SSNB",
"ARNB",
"LAWE",
"MILI",
"TRVL",
"EMAL",
"PHON",
"BTHD"
]
},
"idNumber": {
"maxLength": 35,
"minLength": 1,
"type": "string"
},
"idOwnerType": {
"type": "string",
"enum": [
"C",
"I"
]
},
"idIssueCountry": {
"maxLength": 3,
"minLength": 3,
"type": "string"
}
}
}
},
"SenderContactNumberType": {
"type": "string",
"description": "Sender contact number type.",
"example": "MOBILE",
"enum": [
"HOME",
"WORK",
"MOBILE",
"FAX",
"PAGER",
"OTHER"
]
},
"BaseAmount": {
"type": "number",
"description": "Base amount for net reimbursement fee calculation",
"format": "double",
"example": 98.5
},
"PersonDetails": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PersonName"
},
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/Address"
}
}
}
]
},
"BusinessApplicationId": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Identifies the programs' business application type for VisaNet transaction processing",
"example": "PP"
},
"SettlementCurrencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "ISO 4217 3-character alpha currency code for the settlement amount",
"example": "USD"
},
"AFTRNetworkResponse": {
"required": [
"actionCode"
],
"type": "object",
"properties": {
"networkId": {
"$ref": "#/components/schemas/NetworkId"
},
"actionCode": {
"$ref": "#/components/schemas/ActionCode"
},
"approvalCode": {
"$ref": "#/components/schemas/ApprovalCode"
},
"settlementInfo": {
"$ref": "#/components/schemas/NetworkResponseSettlementInfo"
},
"customerReference": {
"$ref": "#/components/schemas/CustomerReference"
},
"responseReasonCode": {
"$ref": "#/components/schemas/ResponseReasonCode"
},
"feeProgramIndicator": {
"$ref": "#/components/schemas/FeeProgramIndicator"
},
"cardResponseTokenData": {
"$ref": "#/components/schemas/AFTRCardResponseTokenData"
},
"senderIdentificationNumberIndividual": {
"$ref": "#/components/schemas/RecipientIdentificationNumberIndividual"
}
}
},
"AFTRRequestData": {
"required": [
"originatorDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"$ref": "#/components/schemas/AFTROriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/AFTRTransactionDetail"
}
},
"description": "Details for Account Funding Transaction Reversal"
},
"AdjustmentRequestData": {
"required": [
"originatorDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"required": [
"acquirerCountryCode",
"acquiringBin",
"cardAcceptor"
],
"type": "object",
"properties": {
"acquiringBin": {
"type": "integer",
"description": "Bank Identification Number",
"example": 412345
},
"cardAcceptor": {
"$ref": "#/components/schemas/AdjustmentCardAcceptor"
},
"acquirerCountryCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-digit numeric or 3-character alpha ISO country code
Refer to ISO Codes",
"example": "840 USA"
}
},
"description": "Details about the originator of the adjustment"
},
"transactionDetail": {
"required": [
"adjustmentType",
"clientReferenceId",
"id",
"idType",
"localTransactionDateTime",
"transactionAmount",
"transactionCurrencyCode"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Transaction identifier value",
"example": "123456789012345"
},
"fees": {
"type": "object",
"properties": {
"surcharge": {
"type": "string",
"description": "Surcharge amount for the transaction",
"format": "double",
"example": "5.00"
}
}
},
"idType": {
"type": "string",
"description": "Type of identifier being used to identify the transaction",
"example": "TRANSACTION_IDENTIFIER",
"enum": [
"TRANSACTION_IDENTIFIER"
]
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdjustmentTransactionDetailAdditionalData"
}
},
"adjustmentType": {
"type": "string",
"description": "Type of adjustment being requested",
"example": "PULL_CREDIT",
"enum": [
"PULL_CREDIT",
"SALES_TAX_PUSH_DEBIT"
]
},
"clientReferenceId": {
"maxLength": 12,
"minLength": 12,
"type": "string",
"description": "Client-generated unique transaction identifier"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"transactionAmount": {
"type": "number",
"description": "Amount of the transaction being adjusted",
"format": "double",
"example": 100
},
"transactionCurrencyCode": {
"description": "Use a 3-digit numeric or 3-character alpha ISO currency code for currency of the original transaction.
Refer to ISO Codes",
"allOf": [
{
"$ref": "#/components/schemas/TransactionCurrencyCode"
}
]
},
"enablerVerificationValue": {
"maxLength": 5,
"minLength": 5,
"type": "string",
"description": "Value used for verification by the enabler",
"example": "12345"
},
"localTransactionDateTime": {
"type": "string",
"description": "Local date and time of the original transaction",
"format": "date-time",
"example": "2025-05-20T14:25:32Z"
},
"settlementServiceIndicator": {
"$ref": "#/components/schemas/SettlementServiceIndicator"
}
},
"description": "Transaction details for adjustment"
}
},
"description": "Request data for card transaction adjustment"
},
"SettlementAmount": {
"type": "number",
"description": "Amount to be settled between the parties involved in the transaction",
"format": "double",
"example": 123.45
},
"PaymentFacilitatorCountry": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-digit numeric or 3-character alpha ISO country code
Refer to ISO Codes",
"example": "840 USA"
},
"ClientReferenceId": {
"maxLength": 12,
"minLength": 12,
"type": "string",
"description": "Client-generated unique transaction identifier used for reference purposes, similar to retrievalReferenceNumber"
},
"PaymentFacilitatorAddressLine": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Street address of the payment facilitator",
"example": "123 Payment St, Suite 100"
},
"ResponseCode": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Code that defines the response to the authorization request",
"example": "0"
},
"VisaMerchantIdentifier": {
"maxLength": 8,
"minLength": 8,
"type": "string",
"description": "Visa merchant identifier"
},
"MagneticStripeData": {
"type": "object",
"properties": {
"track1Data": {
"maxLength": 76,
"minLength": 1,
"type": "string",
"description": "Track 1 data"
},
"track2Data": {
"maxLength": 38,
"minLength": 1,
"type": "string",
"description": "Track 2 data"
}
},
"description": "Magnetic stripe data"
},
"PersistentFX": {
"type": "object",
"properties": {
"exchangeRate": {
"$ref": "#/components/schemas/ExchangeRate"
},
"visaRateTableId": {
"$ref": "#/components/schemas/VisaRateTableId"
},
"visaRateProvider": {
"$ref": "#/components/schemas/VisaRateProvided"
}
}
},
"FirstName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "First name of the recipient"
},
"CardAcceptorId": {
"maxLength": 15,
"minLength": 1,
"type": "string",
"description": "Card acceptor identifier",
"example": "CACID12345"
},
"AFTRCardResponseTokenData": {
"type": "object",
"properties": {
"last4ofPAN": {
"$ref": "#/components/schemas/Last4ofPAN"
},
"tokenAssuranceMethod": {
"$ref": "#/components/schemas/TokenAssuranceMethod"
},
"additionalTokenRespInfo": {
"$ref": "#/components/schemas/AdditionalTokenRespInfo"
}
}
},
"ProcessingDate": {
"type": "string",
"description": "Date when the transaction was processed",
"format": "date"
},
"ErrorResponse": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "The short description of the error."
},
"status": {
"maximum": 999,
"minimum": 100,
"type": "integer",
"description": "3 digit HTTP status code",
"example": 400
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A short code indicating the specific error that occurred."
},
"message": {
"type": "string",
"description": "The long description of the specific error that occurred."
},
"location": {
"type": "string",
"description": "The place in the incoming message that the particular error occurred."
}
}
}
},
"message": {
"type": "string",
"description": "The long description of the error"
}
}
},
"Occupation": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Occupation of the recipient"
},
"RejectReasonCode": {
"type": "integer",
"description": "Code indicating the reason for rejection"
},
"AFTNetworkResponse": {
"required": [
"actionCode"
],
"type": "object",
"properties": {
"posData": {
"$ref": "#/components/schemas/AFTResponsePosData"
},
"vauData": {
"$ref": "#/components/schemas/NetworkResponseVauData"
},
"networkId": {
"$ref": "#/components/schemas/NetworkId"
},
"actionCode": {
"$ref": "#/components/schemas/ActionCode"
},
"approvalCode": {
"$ref": "#/components/schemas/ApprovalCode"
},
"dafIndicator": {
"$ref": "#/components/schemas/DafIndicator"
},
"settlementInfo": {
"$ref": "#/components/schemas/NetworkResponseSettlementInfo"
},
"customerReference": {
"$ref": "#/components/schemas/CustomerReference"
},
"originalActionCode": {
"$ref": "#/components/schemas/OriginalActionCode"
},
"responseReasonCode": {
"$ref": "#/components/schemas/ResponseReasonCode"
},
"feeProgramIndicator": {
"$ref": "#/components/schemas/FeeProgramIndicator"
},
"cardResponseTokenData": {
"$ref": "#/components/schemas/CardResponseTokenData"
},
"riskAssessmentResults": {
"$ref": "#/components/schemas/RiskAssessmentResults"
},
"reimbursementAttribute": {
"$ref": "#/components/schemas/ReimbursementAttribute"
},
"cardVerificationResults": {
"$ref": "#/components/schemas/AFTResponseCardVerificationResults"
},
"recipientIdentificationNumberIndividual": {
"$ref": "#/components/schemas/RecipientIdentificationNumberIndividual"
}
}
},
"VerificationOriginatorDetail": {
"required": [
"acquirerCountryCode",
"acquiringBin"
],
"type": "object",
"properties": {
"acquiringBin": {
"maxLength": 11,
"minLength": 6,
"type": "string",
"description": "This field must contain an acquiring BIN",
"example": "412345"
},
"cardAcceptor": {
"$ref": "#/components/schemas/VerificationCardAcceptor"
},
"acquirerCountryCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "The clients must provide a 3-digit numeric or 3-character alpha ISO country code",
"example": "840 USA"
}
},
"description": "Originator details for Verification check"
},
"RejectReason": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Detailed description of the rejection reason",
"example": "Insufficient Funds"
},
"RecipientContactNumber": {
"pattern": "^\\+[0-9]+$",
"type": "string",
"description": "Recipient contact number. + symbol followed by digits, no other symbols, e.g. +447809713678.\n",
"example": "+447700123456"
},
"OCTResponseOriginatorDetail": {
"required": [
"cardAcceptor"
],
"type": "object",
"properties": {
"cardAcceptor": {
"$ref": "#/components/schemas/OCTResponseCardAcceptor"
}
}
},
"EnablerVerificationValue": {
"maxLength": 5,
"minLength": 5,
"type": "string",
"description": "Enabler verification value"
},
"SystemsTraceAuditNumber": {
"type": "number",
"description": "Systems trace audit number",
"example": 123456
},
"CardAcceptorName": {
"maxLength": 25,
"type": "string",
"description": "Name of the merchant or card acceptor",
"example": "ACME Corporation"
},
"OCTRecipientCard": {
"type": "object",
"properties": {
"accountType": {
"type": "string",
"description": "Used to identify the account type of the recipient's primary account number in the request. Possible values: 00 (Not applicable), 10 (Saving account), 20 (Checking account), 30 (Credit card account), 40 (Universal account). Default is 00.\n",
"example": "30",
"default": "00",
"enum": [
"00",
"10",
"20",
"30",
"40"
]
},
"requestorId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Unique Merchant Identification assigned by Token Service Provider. Required if accountNumberType is PCI_TOKEN_REFID.\n",
"example": "MERCHANT123"
},
"accountNumber": {
"maxLength": 19,
"minLength": 13,
"type": "string",
"description": "Recipient's primary account number or token account number. Required if paymentCredentialReference is not provided in the request.\n",
"example": "4123456789012345"
},
"expirationDate": {
"type": "string",
"description": "Contains the expiration date for the recipient's primary account number or token. Visa requires the expiration date to be present in all OCTs destined to U.S. issuers. Format: YYYY-MM.\n",
"format": "date"
},
"sequenceNumber": {
"type": "number",
"description": "Sequence number of the recipient's primary account number. Required if paymentCredentialReference is not provided in the request.\n"
},
"schemeIdentifier": {
"type": "string",
"description": "The scheme identifier of the recipient's, 01 - Visa, 02 - Other\n",
"enum": [
"01",
"02"
]
},
"accountNumberType": {
"type": "string",
"description": "Type of recipient account number.\n",
"example": "DEFAULT",
"enum": [
"DEFAULT"
]
},
"authenticationData": {
"$ref": "#/components/schemas/RecipientAuthenticationData"
}
},
"description": "Card details of the recipient for Original Credit Transactions"
},
"PaymentFacilitatorPostalCode": {
"maxLength": 10,
"minLength": 4,
"type": "string",
"description": "Postal code of the payment facilitator",
"example": "12345"
},
"TransactionStatus": {
"type": "string",
"description": "Status of the transaction",
"example": "APPROVED",
"enum": [
"APPROVED",
"DECLINED",
"REJECTED",
"PENDING"
]
},
"SenderSourceOfFunds": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Source of funds for the sender"
},
"ArgentinaNationalServiceData": {
"required": [
"reimbursementFee"
],
"type": "object",
"properties": {
"reimbursementFee": {
"type": "number",
"description": "Fee amount for reimbursement",
"format": "double",
"example": 1.5
},
"reimbursementFeeTax": {
"type": "number",
"format": "double"
}
}
},
"AncillaryRecipientDetailAddress": {
"type": "object",
"properties": {
"city": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "This field contains the city of the ancillary recipient's address."
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "This field contains the 3-digit numeric or 3-character alpha ISO country code of the ancillary recipient's address.
Refer to ISO Codes"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "This field contains the postal code of the ancillary recipient's address."
},
"addressLine1": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "This field contains the first line of the ancillary recipient's address."
},
"addressLine2": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "This field contains the second line of the ancillary recipient's address."
}
}
},
"MinimumAccountRange": {
"type": "integer",
"description": "Minimum account range"
},
"VerificationRequestData": {
"required": [
"originatorDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"$ref": "#/components/schemas/VerificationOriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/VerificationTransactionDetail"
}
},
"description": "Request data for checking card verification"
},
"Name": {
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "Full name of the recipient"
},
"TraExemptionIndicator": {
"type": "string",
"description": "TRA exemption indicator",
"enum": [
"true",
"false"
]
},
"ServiceLocationDetails": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/ServiceLocationAddress"
}
}
},
"PaymentCredentialReference": {
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of payment instrument",
"example": "PCI_TOKEN_REFID",
"enum": [
"PCI_TOKEN_REFID",
"PAYNAME",
"PHONE",
"EMAIL",
"DIRECTORY_ALIASID"
]
},
"value": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "The value of the payment instrument. If type is PAYNAME then length should be between 6 and 50 characters. Format should be +payname.domain. The payname, between '+' and '.' characters, should be minimum 3 characters.
For \"PCI_TOKEN_REFID\", length is 1-75 and must accompany with \"requestorId\".
For \"PHONE\", \"EMAIL\", \"DIRECTORY_ALIASID\", length is 1-128 characters.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the '+' sign is not included. Below are some examples of phone numbers with different country codes -
\n \n \n | Country | \n Country Code | \n Examples | \n
\n \n \n \n | United States | \n 1 | \n 1650xxxxxxx | \n
\n \n | Ukraine | \n 380 | \n 38067xxxxxxx | \n
\n \n | Belarus | \n 375 | \n 37529xxxxxxx | \n
\n \n | Kazakhstan | \n 7 | \n 7701xxxxxxx | \n
\n \n | United Kingdom | \n 44 | \n 4478xxxxxxxx | \n
\n \n | Singapore | \n 65 | \n 659xxxxxxx | \n
\n \n | Hong Kong | \n 852 | \n 8529xxxxxxx | \n
\n \n | Kenya | \n 254 | \n 254701xxxxxx | \n
\n \n
\n",
"example": "TOKEN123456789"
},
"requestorId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Conditional
Unique Merchant Identification assigned by Token Service Provider. Only required if type is PCI_TOKEN_REFID.",
"example": "MERCHANT123"
},
"authenticationData": {
"$ref": "#/components/schemas/RecipientAuthenticationData"
}
},
"description": "External reference to a payment credential"
},
"QueryOriginatorDetail": {
"required": [
"acquiringBin"
],
"type": "object",
"properties": {
"acquiringBin": {
"$ref": "#/components/schemas/AcquiringBin"
}
}
},
"SettlementServiceFlag": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Flag indicating the settlement service used for this transaction",
"example": "1"
},
"AFTRResponseTransactionDetail": {
"required": [
"clientReferenceId",
"initiatingPartyId",
"networkResponse",
"status",
"transactionDateTime",
"transactionIdentifier"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/Status"
},
"memberComments": {
"$ref": "#/components/schemas/MemberComments"
},
"networkResponse": {
"$ref": "#/components/schemas/AFTRNetworkResponse"
},
"clientReferenceId": {
"$ref": "#/components/schemas/ClientReferenceId"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"transactionDateTime": {
"$ref": "#/components/schemas/TransactionDateTime"
},
"serviceProcessingType": {
"$ref": "#/components/schemas/AFTRServiceProcessingType"
},
"transactionIdentifier": {
"$ref": "#/components/schemas/TransactionIdentifier"
},
"enablerVerificationValue": {
"$ref": "#/components/schemas/EnablerVerificationValue"
},
"transactionLinkIdentifier": {
"$ref": "#/components/schemas/TransactionLinkIdentifier"
}
}
},
"AddressVerificationData": {
"required": [
"postalCode"
],
"type": "object",
"properties": {
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Postal code for address verification"
},
"streetName": {
"maxLength": 40,
"minLength": 0,
"type": "string",
"description": "Street for address verification"
}
}
},
"AFTSenderDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "localNameData
This object is used to provide the sender's local name data. This object is required for transactions where the sender's local name data is required."
},
"value": {
"$ref": "#/components/schemas/SenderLocalNameData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "contactInformationList
Contact Information list of sender.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/ContactInformationList"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "ancillarySenderDetails
Ancillary sender details.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/AncillarySenderDetails"
}
}
}
]
},
"CardAcceptorCustomerServicePhoneNumber": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Customer service phone number of the card acceptor",
"example": "+0987654321"
},
"ContactInformationList": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "This field identifies if the contact information is for a business or an individual. The valid value are: 'B' for Business and 'I' for Individual."
},
"contactType": {
"type": "string",
"description": "This field identifies the type of contact information. The valid value is: \"PHONE\" for phone number.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."
},
"contactValue": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "This field contains the contact value for provided contact type.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."
}
}
},
"AcnvPaymentCredentialReference": {
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of payment instrument.",
"example": "PCI_TOKEN_REFID",
"enum": [
"PCI_TOKEN_REFID"
]
},
"value": {
"maxLength": 75,
"minLength": 1,
"type": "string",
"description": "The value of the payment instrument. For \"PCI_TOKEN_REFID\", length is 1-75 and must accompany with \"requestorId\".
",
"example": "TOKEN123456789"
},
"requestorId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Conditional
Unique Merchant Identification assigned by Token Service Provider. Only required if type is PCI_TOKEN_REFID.",
"example": "MERCHANT123"
},
"AuthenticationData": {
"$ref": "#/components/schemas/AcnvAuthenticationData"
},
"addressVerificationData": {
"$ref": "#/components/schemas/AddressVerificationData"
}
},
"description": "External reference to a payment credential"
},
"AdditionalData": {
"required": [
"name",
"value"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The identifier or name of the additional data item."
},
"value": {
"description": "The value associated with the name. Can be of varying type.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
]
}
},
"description": "Represents a key-value pair of additional data used in various processing contexts."
},
"PaymentFacilitatorCity": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "City of the payment facilitator",
"example": "City Name"
},
"SenderMiddleName": {
"maxLength": 35,
"minLength": 2,
"type": "string",
"description": "Sender middle name or middle initial when sender is an individual",
"example": "Robert"
},
"AdjustmentCardAcceptor": {
"required": [
"id",
"terminalId"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/CardAcceptorId"
},
"terminalId": {
"$ref": "#/components/schemas/TerminalId"
},
"merchantCategoryCode": {
"$ref": "#/components/schemas/MerchantCategoryCode"
}
},
"description": "Card acceptor details for Adjustment Transaction"
},
"TrustedMerchantExemptionIndicator": {
"type": "string",
"description": "Trusted merchant exemption indicator",
"enum": [
"true",
"false"
]
},
"AFTRServiceProcessingType": {
"type": "object",
"properties": {
"requestType": {
"maxLength": 2,
"minLength": 2,
"type": "string"
}
}
},
"AFTResponseTransactionDetail": {
"required": [
"clientReferenceId",
"initiatingPartyId",
"status",
"transactionCurrencyCode",
"transactionDateTime",
"transactionIdentifier"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/Status"
},
"approvedAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"memberComments": {
"$ref": "#/components/schemas/MemberComments"
},
"settlementDate": {
"$ref": "#/components/schemas/SettlementDate"
},
"networkResponse": {
"$ref": "#/components/schemas/AFTNetworkResponse"
},
"clientReferenceId": {
"$ref": "#/components/schemas/ClientReferenceId"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"transactionAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"transactionDateTime": {
"$ref": "#/components/schemas/TransactionDateTime"
},
"serviceProcessingType": {
"$ref": "#/components/schemas/AFTServiceProcessingType"
},
"transactionIdentifier": {
"$ref": "#/components/schemas/TransactionIdentifier"
},
"transactionCurrencyCode": {
"$ref": "#/components/schemas/TransactionCurrencyCode"
},
"enablerVerificationValue": {
"$ref": "#/components/schemas/EnablerVerificationValue"
},
"transactionLinkIdenifier": {
"$ref": "#/components/schemas/TransactionLinkIdentifier"
},
"masterCardElectronicCommerceIndicators": {
"$ref": "#/components/schemas/MasterCardElectronicCommerceIndicators"
},
"cpsAuthorizationCharacteristicIndicator": {
"$ref": "#/components/schemas/CPSAuthorizationCharacteristicIndicator"
}
}
},
"ChipTransactionIndicator": {
"maximum": 9,
"minimum": 0,
"type": "number",
"description": "Chip transaction indicator"
},
"CardAcceptorAdditionalContactDetails": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "Additional contact details of the card acceptor"
},
"AftSenderPaymentCredentialReference": {
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of payment instrument.",
"example": "PCI_TOKEN_REFID",
"enum": [
"PCI_TOKEN_REFID"
]
},
"value": {
"maxLength": 75,
"minLength": 1,
"type": "string",
"description": "The value of the payment instrument. For \"PCI_TOKEN_REFID\", length is 1-75 and must accompany with \"requestorId\".
",
"example": "TOKEN123456789"
},
"requestorId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Conditional
Unique Merchant Identification assigned by Token Service Provider. Only required if type is PCI_TOKEN_REFID.",
"example": "MERCHANT123"
},
"AuthenticationData": {
"$ref": "#/components/schemas/AuthenticationData"
},
"addressVerificationData": {
"$ref": "#/components/schemas/AddressVerificationData"
}
},
"description": "External reference to a payment credential"
},
"RetrievalReferenceNumber": {
"maxLength": 12,
"minLength": 12,
"type": "string",
"description": "Reference number for the transaction",
"example": "412345678901"
},
"DafIndicator": {
"maxLength": 5,
"type": "string",
"description": "DAF indicator"
},
"CavvResultCode": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "CAVV result code"
},
"SenderLocalNameData": {
"required": [
"encodingFormat",
"languageCode"
],
"type": "object",
"properties": {
"lastName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Sender's last name in local language."
},
"aliasName": {
"maxLength": 70,
"minLength": 1,
"type": "string",
"description": "Sender's alias name in local language."
},
"firstName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Sender's first name in local language."
},
"middleName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Sender's middle name in local language."
},
"languageCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3 characters ISO 639 language code. Example 'heb' for Hebrew."
},
"encodingFormat": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "01 = UTF-8"
}
}
},
"VauData": {
"type": "object",
"properties": {
"vauFlag": {
"$ref": "#/components/schemas/VauFlag"
},
"accountStatus": {
"$ref": "#/components/schemas/AccountStatus"
},
"vauerrorReasonCode": {
"$ref": "#/components/schemas/VauErrorReasonCode"
},
"replacementCardAccountNumber": {
"$ref": "#/components/schemas/ReplacementCardAccountNumber"
},
"replacementCardExpirationDate": {
"$ref": "#/components/schemas/ReplacementCardExpirationDate"
}
}
},
"LastName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Last name of the recipient"
},
"VisaDiscretionaryData": {
"type": "object",
"properties": {
"derivationKeyIndexVIS": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Derivation key index VIS"
},
"cardVerificationResultsVIS": {
"maxLength": 12,
"minLength": 1,
"type": "string",
"description": "Card verification results VIS"
},
"cryptogramVersionNumberVIS": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Cryptogram version number VIS"
}
}
},
"CountryOfBirth": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Country of birth of the recipient"
},
"OCTNetworkResponse": {
"required": [
"actionCode",
"settlementInfo"
],
"type": "object",
"properties": {
"posData": {
"$ref": "#/components/schemas/OCTNetworkResponsePosData"
},
"vauData": {
"$ref": "#/components/schemas/NetworkResponseVauData"
},
"networkId": {
"$ref": "#/components/schemas/NetworkId"
},
"actionCode": {
"$ref": "#/components/schemas/ActionCode"
},
"approvalCode": {
"$ref": "#/components/schemas/ApprovalCode"
},
"persistentFX": {
"$ref": "#/components/schemas/PersistentFX"
},
"settlementInfo": {
"$ref": "#/components/schemas/OCTNetworkResponseSettlementInfo"
},
"originalActionCode": {
"$ref": "#/components/schemas/OriginalActionCode"
},
"prepaidBalanceData": {
"$ref": "#/components/schemas/PrepaidBalanceData"
},
"feeProgramIndicator": {
"$ref": "#/components/schemas/FeeProgramIndicator"
},
"cardResponseTokenData": {
"$ref": "#/components/schemas/OCTCardResponseTokenData"
},
"cardVerificationResults": {
"$ref": "#/components/schemas/OCTCardVerificationResults"
}
}
},
"VerificationPosData": {
"type": "object",
"properties": {
"panEntryMode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "2-digit code that identifies the method used to enter the cardholder account number",
"example": "01",
"default": "01"
},
"motoECIIndicator": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Identifies the level of security used in an electronic commerce transaction",
"example": "7"
},
"posConditionCode": {
"type": "string",
"description": "Code identifying transaction conditions at the point of sale or point of service",
"example": "51",
"default": "51"
},
"pointOfServiceCapability": {
"type": "object",
"properties": {
"terminalType": {
"type": "string",
"description": "1-digit code identifies the basic POS electronic terminal category",
"example": "1"
},
"terminalEntryCapability": {
"type": "string",
"description": "Recommended value for card not present is 5",
"example": "5",
"default": "5"
}
},
"description": "For CardPresent Transactions, this field is required"
},
"specialConditionIndicatorMerchant": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Cryptocurrency indicator with the value of “7” can be used to identify the purchase of cryptocurrency, thereby providing greater visibility to the issuers.\n1 – Purchase of Central Bank Digital Currency (CBDC) or Tokenized Deposits\n2 – Purchase of Stablecoin (fiat-backed)\n3 – Purchase of Blockchain Native Token/Coin\n4 – Purchase of Non-Fungible Token (NFT)\n7* - Purchase of Cryptocurrency\n",
"example": "7"
}
},
"description": "Point of Service data for Verification check"
},
"ExchangeRate": {
"type": "number",
"description": "Exchange rate applied to the transaction for currency conversion",
"format": "double",
"example": 1
},
"TransactionType": {
"maxLength": 30,
"minLength": 2,
"type": "string",
"description": "Type of the transaction"
},
"AFTTransactionDetail": {
"required": [
"businessApplicationId",
"clientReferenceId",
"localTransactionDateTime",
"posData",
"transactionAmount",
"transactionCurrencyCode"
],
"type": "object",
"properties": {
"fees": {
"$ref": "#/components/schemas/AFTTransactionFees"
},
"posData": {
"$ref": "#/components/schemas/AFTTransactionPosData"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AFTTransactionDetailAdditionalData"
}
},
"purposeOfPayment": {
"$ref": "#/components/schemas/PurposeOfPayment"
},
"routingNetworkId": {
"$ref": "#/components/schemas/RoutingNetworkId"
},
"clientReferenceId": {
"$ref": "#/components/schemas/ClientReferenceId"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"messageReasonCode": {
"$ref": "#/components/schemas/MessageReasonCode"
},
"transactionAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"riskAssessmentData": {
"$ref": "#/components/schemas/RiskAssessmentData"
},
"feeProgramIndicator": {
"$ref": "#/components/schemas/FeeProgramIndicator"
},
"senderSourceOfFunds": {
"$ref": "#/components/schemas/SenderSourceOfFunds"
},
"businessApplicationId": {
"$ref": "#/components/schemas/BusinessApplicationId"
},
"serviceProcessingType": {
"$ref": "#/components/schemas/AFTServiceProcessingType"
},
"transactionCurrencyCode": {
"description": "- Use a 3-digit numeric or 3-character alpha ISO currency code for currency of the sender.
- For Cross-border, originator can use this field for its chosen currency or the sender's card currency (refer to the billingCurrencyCode obtained from the Eligibility Check for Card API)*.
Adjust amount accordingly based on chosen transactionCurrencyCode.
*Note: This currency may not always be the local currency code of the recipient.
Refer to ISO Codes",
"allOf": [
{
"$ref": "#/components/schemas/TransactionCurrencyCode"
}
]
},
"enablerVerificationValue": {
"$ref": "#/components/schemas/EnablerVerificationValue"
},
"localTransactionDateTime": {
"$ref": "#/components/schemas/LocalTransactionDateTime"
},
"settlementServiceIndicator": {
"$ref": "#/components/schemas/SettlementServiceIndicator"
},
"originalTransactionIdentifier": {
"$ref": "#/components/schemas/SystemsTraceAuditNumber"
}
}
},
"SenderName": {
"maxLength": 30,
"minLength": 2,
"type": "string",
"description": "Full name of sender. Conditionally required when \"firstName\" and \"lastName\" are not provided. Must not contain exclusively numeric characters. Must not contain special symbols. Represents sender company name if sender is a company.\n",
"example": "John Smith"
},
"RecipientLastName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient last name. Conditionally required when \"name\" is not provided. The length of first name and last name combined must be at least 3 characters. Must not contain exclusively numeric characters. Must not contain special symbols. ISO20022 field name: Creditor Name.\n",
"example": "Doe"
},
"RecipientMiddleName": {
"maxLength": 35,
"minLength": 2,
"type": "string",
"description": "Recipient middle name",
"example": "Marie"
},
"ServiceProcessingType": {
"required": [
"requestType"
],
"type": "object",
"properties": {
"requestType": {
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"deferredDateTime": {
"maxLength": 12,
"minLength": 12,
"type": "string"
}
}
},
"SenderReferenceNumber": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Reference number of the sender",
"example": "SND-REF-12345"
},
"EligibilityRequestData": {
"required": [
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"type": "object",
"properties": {
"acquiringBin": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Bank Identification Number of the acquirer",
"example": "123"
},
"acquirerCountryCode": {
"maximum": 999,
"minimum": 1,
"type": "integer",
"description": "ISO numeric country code for the acquirer",
"example": 840
}
},
"description": "Originator details for eligibility check"
},
"transactionDetail": {
"required": [
"clientReferenceId"
],
"type": "object",
"properties": {
"card": {
"required": [
"accountNumber"
],
"type": "object",
"properties": {
"accountNumber": {
"maxLength": 19,
"minLength": 13,
"type": "string",
"description": "The primary account number for which eligibility is being checked",
"example": "4111111111111111"
},
"accountNumberType": {
"type": "string",
"description": "Type of account number being submitted",
"example": "DEFAULT",
"enum": [
"DEFAULT"
]
}
},
"description": "Card information to check eligibility for"
},
"criteria": {
"type": "array",
"description": "Criteria for eligibility check",
"items": {
"type": "object",
"properties": {
"accountType": {
"type": "string",
"description": "Type of the account",
"example": "CREDIT",
"enum": [
"DEBIT",
"CREDIT"
]
},
"routingNetworkId": {
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "Identifier for the routing network",
"example": "123"
}
}
}
},
"clientReferenceId": {
"maxLength": 12,
"minLength": 12,
"type": "string",
"description": "Reference identifier to tie multiple API calls with a single funds transfer transaction"
},
"initiatingPartyId": {
"type": "integer",
"description": "A unique identifier assigned by the initiating party for the API consumer",
"format": "int64",
"example": 987654321
},
"paymentCredentialReference": {
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of payment instrument.",
"example": "PCI_TOKEN_REFID",
"enum": [
"PCI_TOKEN_REFID",
"PHONE",
"EMAIL",
"DIRECTORY_ALIASID",
"PAYMENT_CREDENTIAL_ID"
]
},
"value": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "The value of the payment instrument. For \"PCI_TOKEN_REFID\", length is 1-75 and must accompany with \"requestorId\".
For \"PAYMENT_CREDENTIAL_ID\" length is 1-36 characters.
For \"PHONE\", \"EMAIL\", \"DIRECTORY_ALIASID\", length is 1-128 characters.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the '+' sign is not included. Below are some examples of phone numbers with different country codes -
| Country | Country Code | Examples |
|---|
| United States | 1 | 1650xxxxxxx |
| Ukraine | 380 | 38067xxxxxxx |
| Belarus | 375 | 37529xxxxxxx |
| Kazakhstan | 7 | 7701xxxxxxx |
| United Kingdom | 44 | 4478xxxxxxxx |
| Singapore | 65 | 659xxxxxxx |
| Hong Kong | 852 | 8529xxxxxxx |
| Kenya | 254 | 254701xxxxxx |
\"",
"example": "TOKEN123456789"
},
"requestorId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Conditional
Unique Merchant Identification assigned by Token Service Provider. Only required if type is PCI_TOKEN_REFID.",
"example": "MERCHANT123"
}
},
"description": "External reference to a payment credential"
}
},
"description": "Transaction details for eligibility check"
}
},
"description": "Request data for checking card eligibility\nConditional\nOnly one of 'card' and 'paymentCredentialReference' is provided in a request.\n"
},
"PrimaryAccountNumber": {
"maxLength": 19,
"minLength": 13,
"type": "string",
"description": "Primary account number of the recipient's card",
"example": "4123456789012345"
},
"SecondaryId": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "Used for C2B use cases in the CEMEA region where payee initiates the OCT to the payer. Used to obtain an Agreement Id for processing the request."
},
"OCTResponseCardAcceptor": {
"type": "object",
"properties": {
"merchantVerificationValue": {
"$ref": "#/components/schemas/MerchantVerificationValue"
}
}
},
"AFTRResponseData": {
"required": [
"originatorDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"$ref": "#/components/schemas/AFTRResponseOriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/AFTRResponseTransactionDetail"
}
},
"description": "Account Funding Transaction Reversal (AFTR) response data structure"
},
"MexicoNationalServiceData": {
"required": [
"reimbursementFee",
"reimbursementFeeTax"
],
"type": "object",
"properties": {
"irfType": {
"maxLength": 1,
"minLength": 1,
"type": "number",
"format": "string"
},
"accountType": {
"maxLength": 2,
"minLength": 2,
"type": "number",
"format": "string"
},
"irfCategoryCode": {
"maxLength": 2,
"minLength": 1,
"type": "number",
"format": "string"
},
"merchantFiscalId": {
"maxLength": 13,
"minLength": 1,
"type": "number",
"format": "string"
},
"reimbursementFee": {
"type": "number",
"description": "Fee amount for reimbursement",
"format": "double",
"example": 1.5
},
"reimbursementFeeTax": {
"type": "number",
"format": "double"
}
}
},
"AFTAdditionalAcceptor": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"description": "Multiple ids can be provided for additional Acceptor. Duplicate instance of same idType is not allowed eg. One instance of Gateways and RampProvider can be present in the same request but multiple instances of same idType like Gateways is not allowed.",
"items": {
"$ref": "#/components/schemas/AdditionalAcceptorId"
}
},
"foreignRetailerIndicator": {
"type": "string",
"description": "Identifies a foreign retailer under a marketplace and/or payment facilitator.
May also Identify a foreign Conversion Affiliate under a Ramp
This tag must contain either:
A – Conversion Affiliate is located in the same country as Ramp provider
B – Conversion Affiliate is located in a different country as Ramp provider"
}
}
},
"PersonName": {
"type": "object",
"properties": {
"lastName": {
"maxLength": 35,
"minLength": 2,
"type": "string"
},
"firstName": {
"maxLength": 35,
"minLength": 2,
"type": "string"
},
"middleName": {
"maxLength": 35,
"minLength": 2,
"type": "string"
}
}
},
"PaymentFacilitatorState": {
"maxLength": 3,
"minLength": 1,
"type": "string",
"description": "State of the payment facilitator",
"example": "CA"
},
"ServiceLocationCountry": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "ISO Country Code of the service location",
"example": "USA"
},
"VauFlag": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Flag indicating Visa AU status",
"example": "Y"
},
"OCTResponseData": {
"required": [
"originatorDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"$ref": "#/components/schemas/OCTResponseOriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/OCTResponseTransactionDetail"
}
},
"description": "Original Credit Transaction (OCT) response data structure"
},
"LowValueExemptionIndicator": {
"type": "string",
"description": "Low value exemption indicator",
"enum": [
"true",
"false"
]
},
"ReplacementCardExpirationDate": {
"maxLength": 7,
"minLength": 7,
"type": "string",
"description": "Expiration date of the replacement card",
"example": "2025-12"
},
"ForeignExchangeFee": {
"type": "number",
"description": "Foreign exchange fee",
"format": "double"
},
"RemoteCommerceAcceptorIdentifier": {
"maxLength": 150,
"minLength": 1,
"type": "string",
"description": "Remote commerce acceptor identifier",
"example": "RCA123456789"
},
"ScheduledPushFundsTransaction": {
"required": [
"dateTime",
"requestType"
],
"type": "object",
"properties": {
"dateTime": {
"type": "string",
"description": "Date and time when the transaction will be processed by Visa. Format - CCYYMMDDHHMM",
"format": "date-time"
},
"requestType": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Request type for the scheduled transaction"
}
}
},
"SenderAccountNumber": {
"maxLength": 34,
"minLength": 1,
"type": "string",
"description": "Conditional - This field is mandatory if senderReferenceNumber or paymentCredentialReference is not sent.
\nNote:\nClient should provide either a sender reference number or a sender account number but not both.\nClient should not send any PANs in this field for payout.\n",
"example": "A42434234S324234"
},
"AFTRTransactionDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "argentinaNationalServiceData
Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement."
},
"value": {
"$ref": "#/components/schemas/ArgentinaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "colombiaNationalServiceData
Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement"
},
"value": {
"$ref": "#/components/schemas/ColombiaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "mexicoNationalServiceData
Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement."
},
"value": {
"$ref": "#/components/schemas/MexicoNationalServiceData"
}
}
}
]
},
"Last4ofPAN": {
"maxLength": 4,
"minLength": 4,
"type": "string",
"description": "Last 4 digits of the Primary account number. It is returned when network token is provided as a payment instrument.",
"example": "4321"
},
"AFTSenderDetail": {
"type": "object",
"properties": {
"card": {
"$ref": "#/components/schemas/AFTSenderCard"
},
"name": {
"$ref": "#/components/schemas/SenderName"
},
"type": {
"$ref": "#/components/schemas/SenderType"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"lastName": {
"$ref": "#/components/schemas/SenderLastName"
},
"firstName": {
"$ref": "#/components/schemas/SenderFirstName"
},
"middleName": {
"$ref": "#/components/schemas/SenderMiddleName"
},
"occupation": {
"$ref": "#/components/schemas/Occupation"
},
"dateOfBirth": {
"$ref": "#/components/schemas/DateOfBirth"
},
"nationality": {
"$ref": "#/components/schemas/Nationality"
},
"contactEmail": {
"$ref": "#/components/schemas/SenderContactEmail"
},
"senderAddress": {
"$ref": "#/components/schemas/SenderAddress"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AFTSenderDetailAdditionalData"
}
},
"countryOfBirth": {
"$ref": "#/components/schemas/SenderCountryOfBirth"
},
"identificationList": {
"$ref": "#/components/schemas/SenderIdentificationList"
},
"PaymentCredentialReference": {
"$ref": "#/components/schemas/AftSenderPaymentCredentialReference"
}
},
"description": "Sender details for Account Funding Transaction. \nConditional\nOnly one of 'card' and 'paymentCredentialReference' is provided in a request.\nAn object MUST contain exactly one of either 'card' or 'paymentCredentialReference'.\n"
},
"RecipientReferenceNumber": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Reference number of the recipient"
},
"PaymentFacilitatorId": {
"maxLength": 11,
"minLength": 1,
"type": "string",
"description": "Unique identifier for the payment facilitator",
"example": "PF123456789"
},
"VisaRateProvided": {
"maxLength": 70,
"minLength": 1,
"type": "string",
"description": "Indicates the entity that provided the exchange rate used for the transaction",
"example": "VISA FX Rate"
},
"OCTTransactionPosData": {
"type": "object",
"properties": {
"pinData": {
"required": [
"pinBlockFormatCode",
"pinDataBlock"
],
"type": "object",
"properties": {
"pinDataBlock": {
"maxLength": 8,
"minLength": 8,
"type": "string",
"description": "PIN data block",
"format": "binary"
},
"zoneKeyIndex": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Zone key index"
},
"pinBlockFormatCode": {
"type": "integer",
"description": "PIN block format code"
}
}
},
"panEntryMode": {
"$ref": "#/components/schemas/PanEntryMode"
},
"motoECIIndicator": {
"$ref": "#/components/schemas/MotoECIIndicator"
},
"posConditionCode": {
"$ref": "#/components/schemas/PosConditionCode"
},
"chipConditionCode": {
"$ref": "#/components/schemas/ChipConditionCode"
},
"magneticStripeData": {
"type": "object",
"properties": {
"track1Data": {
"maxLength": 76,
"minLength": 1,
"type": "string",
"description": "Track 1 data from magnetic stripe"
},
"track2Data": {
"maxLength": 19,
"minLength": 1,
"type": "string",
"description": "Track 2 data from magnetic stripe",
"format": "binary"
}
}
},
"chipTransactionIndicator": {
"$ref": "#/components/schemas/ChipTransactionIndicator"
},
"pointOfServiceCapability": {
"required": [
"terminalEntryCapability",
"terminalType"
],
"type": "object",
"properties": {
"terminalType": {
"maximum": 9,
"minimum": 0,
"type": "integer",
"description": "Terminal type"
},
"terminalEntryCapability": {
"maximum": 9,
"minimum": 0,
"type": "integer",
"description": "Terminal entry capability"
}
}
},
"integratedCircuitCardData": {
"$ref": "#/components/schemas/IntegratedCircuitCardData"
},
"specialConditionIndicatorMerchant": {
"$ref": "#/components/schemas/SpecialConditionIndicatorMerchant"
},
"chipAuthenticationReliabilityIndicator": {
"$ref": "#/components/schemas/ChipAuthenticationReliabilityIndicator"
}
},
"description": "Point of Service data for Original Credit Transaction"
},
"OCTCardAcceptorAddress": {
"required": [
"city",
"country"
],
"type": "object",
"properties": {
"city": {
"maxLength": 13,
"minLength": 1,
"type": "string",
"description": "City of card acceptor"
},
"state": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "State or province of card acceptor"
},
"county": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "County of card acceptor"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Country of card acceptor"
},
"postalCode": {
"maxLength": 9,
"minLength": 1,
"type": "string",
"description": "Postal or zip code of card acceptor"
},
"addressLine": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Street address of card acceptor"
}
},
"description": "Card acceptor address for Original Credit Transaction"
},
"SourceCurrencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string"
},
"ColombiaNationalServiceData": {
"required": [
"countryCodeNationalService",
"nationalNetReimbursementFeeBaseAmount"
],
"type": "object",
"properties": {
"addValueTaxAmount": {
"type": "number",
"description": "Tax amount value",
"format": "double",
"example": 8
},
"addValueTaxReturn": {
"type": "number",
"format": "double"
},
"taxAmountConsumption": {
"type": "number",
"description": "a",
"format": "double"
},
"nationalNetMiscAmount": {
"type": "number",
"format": "double"
},
"emvTransactionIndicator": {
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"costTransactionIndicator": {
"maxLength": 1,
"minLength": 1,
"type": "string"
},
"nationalChargebackReason": {
"type": "integer"
},
"nationalReimbursementFee": {
"type": "number",
"description": "a",
"format": "double"
},
"nationalNetMiscAmountType": {
"maxLength": 1,
"type": "string",
"description": "Optional string with a length of 1 character"
},
"countryCodeNationalService": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-digit numeric or 3-character alpha for national service data
Refer to ISO Codes",
"example": "484 MEX"
},
"nationalNetReimbursementFeeBaseAmount": {
"type": "number",
"description": "Base amount for net reimbursement fee calculation",
"format": "double",
"example": 98.5
}
}
},
"Address": {
"type": "object",
"properties": {
"city": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "City of sender's address"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Country of sender's address"
},
"stateCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "State code of sender's address"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Postal code of sender's address"
},
"addressLine1": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "First line of the recipient's address"
},
"addressLine2": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Second line of sender's address"
}
}
},
"AuthenticationData": {
"type": "object",
"properties": {
"cavv": {
"maxLength": 40,
"minLength": 40,
"type": "string",
"description": "Cardholder authentication verification value"
},
"cvv2": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Card verification value"
},
"tavv": {
"maxLength": 40,
"minLength": 40,
"type": "string",
"description": "Transaction authentication verification value"
}
}
},
"OCTPaymentFacilitator": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/PaymentFacilitatorId"
},
"name": {
"$ref": "#/components/schemas/PaymentFacilitatorName"
},
"address": {
"$ref": "#/components/schemas/PaymentFacilitatorAddress"
},
"additionalAcceptor": {
"$ref": "#/components/schemas/OCTAdditionalAcceptor"
}
},
"description": "Payment facilitator details for Original Credit Transaction"
},
"OCTCardAcceptor": {
"required": [
"address",
"id",
"name",
"terminalId"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/CardAcceptorId"
},
"name": {
"$ref": "#/components/schemas/CardAcceptorName"
},
"taxID": {
"$ref": "#/components/schemas/TaxID"
},
"address": {
"$ref": "#/components/schemas/OCTCardAcceptorAddress"
},
"terminalId": {
"$ref": "#/components/schemas/TerminalId"
},
"urlAddress": {
"$ref": "#/components/schemas/UrlAddress"
},
"legalBusinessName": {
"$ref": "#/components/schemas/CardAcceptorLegalBusinessName"
},
"contactInformation": {
"$ref": "#/components/schemas/CardAcceptorContactInformation"
},
"paymentFacilitator": {
"$ref": "#/components/schemas/OCTPaymentFacilitator"
},
"merchantCategoryCode": {
"$ref": "#/components/schemas/MerchantCategoryCode"
},
"serviceLocationDetails": {
"$ref": "#/components/schemas/OCTServiceLocationDetails"
},
"visaMerchantIdentifier": {
"$ref": "#/components/schemas/VisaMerchantIdentifier"
},
"merchantVerificationValue": {
"$ref": "#/components/schemas/MerchantVerificationValue"
}
},
"description": "Card acceptor details for Original Credit Transaction"
},
"SenderCityOfBirth": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Sender city of birth",
"example": "San Francisco"
},
"ExemptionReasonCode": {
"type": "array",
"items": {
"maxLength": 4,
"minLength": 4,
"type": "string",
"description": "Exemption reason code"
}
},
"TransactionDateTime": {
"type": "string",
"description": "Date and time of transaction",
"format": "date-time",
"example": "2023-06-15T10:30:00Z"
},
"PurposeOfPayment": {
"maxLength": 12,
"minLength": 1,
"type": "string",
"description": "Conditional.
Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market.
For India, Bangladesh, Egypt and Argentina-Purpose of payment is mandatory for all BAIs except CO,CI and MP
For Chile-Purpose of payment is mandatory for BAI-FD.
For Colombia-Purpose of payment is mandatory for BAI-AA and PP",
"example": "P2P"
},
"RecipientAuthenticationData": {
"type": "object",
"properties": {
"cvv2": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Card verification value"
}
}
},
"SenderCountryOfBirth": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Sender country of birth. Conditional (Refer to Payouts Endpoint Guide on country-specific required fields and lengths). Format: 3-digit numeric or 3-character ISO-3166 (Alpha-3) country code\n",
"example": "840 USA"
},
"UrlAddress": {
"maxLength": 256,
"minLength": 1,
"type": "string",
"description": "URL address of the card acceptor",
"example": "https://www.acmecorp.com"
},
"AdjustmentTransactionDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "argentinaNationalServiceData
Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement."
},
"value": {
"$ref": "#/components/schemas/ArgentinaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "colombiaNationalServiceData
Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement"
},
"value": {
"$ref": "#/components/schemas/ColombiaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "mexicoNationalServiceData
Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement."
},
"value": {
"$ref": "#/components/schemas/MexicoNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "digitalWalletProviderId
Optional.
Used to identify the digital wallet provider. V.I.P. does not edit the field; it also does not send it to the issuer processor nor does it return this field in the response."
},
"value": {
"maxLength": 11,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "dynamicCurrencyConversionIndicator
Optional.
Used to indicate if the merchant or the ATM acquirer has performed Dynamic Currency Conversion (DCC)."
},
"value": {
"maxLength": 1,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "rewardProgramIdentificationCode
Optional.
Used to identify the reward program."
},
"value": {
"maxLength": 6,
"minLength": 6,
"type": "string"
}
}
}
]
},
"FeeProgramIndicator": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Indicator for the fee program",
"example": "FPI"
},
"NetworkResponseVauData": {
"type": "object",
"properties": {
"vauFlag": {
"$ref": "#/components/schemas/VauFlag"
},
"accountStatus": {
"$ref": "#/components/schemas/AccountStatus"
},
"vauErrorReasonCode": {
"$ref": "#/components/schemas/VauErrorReasonCode"
},
"replacementCardAccountNumber": {
"$ref": "#/components/schemas/ReplacementCardAccountNumber"
},
"replacementCardExpirationDate": {
"$ref": "#/components/schemas/ReplacementCardExpirationDate"
}
}
},
"OriginalActionCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Action code of the last transaction if action code of present transaction is 94 for duplicate transaction.",
"example": "00"
},
"RiskAssessmentResults": {
"type": "object",
"properties": {
"exemptionReasonCode": {
"$ref": "#/components/schemas/ExemptionReasonCode"
},
"scpExemptionIndicator": {
"$ref": "#/components/schemas/ScpExemptionIndicator"
},
"traExemptionIndicator": {
"$ref": "#/components/schemas/TraExemptionIndicator"
},
"lowValueExemptionIndicator": {
"$ref": "#/components/schemas/LowValueExemptionIndicator"
},
"delegatedAuthenticationIndicator": {
"$ref": "#/components/schemas/DelegatedAuthenticationIndicator"
},
"trustedMerchantExemptionIndicator": {
"$ref": "#/components/schemas/TrustedMerchantExemptionIndicator"
}
}
},
"DateOfBirth": {
"type": "string",
"description": "Sender date of birth (Format: \"YYYY-MM-DD\", e.g. \"1980-02-01\"). ISO20022 field name: Creditor Birth Date.\n",
"format": "date"
},
"SenderLastName": {
"maxLength": 35,
"minLength": 2,
"type": "string",
"description": "Sender last name. Conditionally required when \"name\" is not provided. The length of first name and last name combined must be at least 3 characters. Must not contain exclusively numeric characters. Must not contain special symbols.\n",
"example": "Smith"
},
"ReimbursementAttribute": {
"type": "string",
"description": "Reimbursement attribute"
},
"TaxID": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Tax ID of the card acceptor",
"example": "123456789"
},
"RecipientType": {
"type": "string",
"description": "Identifies the type of recipient. ISO20022 field name: Creditor Identification Type.\n",
"example": "I",
"enum": [
"I",
"C"
]
},
"Card": {
"type": "object",
"properties": {
"merchantId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Conditional-Required to be sent along with \"PCI_TOKEN_REFID\""
},
"accountType": {
"type": "string",
"description": "This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.
00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account",
"enum": [
"00",
"10",
"20",
"30",
"40"
]
},
"accountNumber": {
"maxLength": 75,
"minLength": 1,
"type": "string",
"description": "For \"DEFAULT\" PAN/Token can be entered from 13-19 characters."
},
"expirationDate": {
"$ref": "#/components/schemas/CardExpiryDate"
},
"accountNumberType": {
"type": "string",
"enum": [
"DEFAULT",
"ALIAS",
"PCI_TOKEN_REFID",
"PAYNAME"
]
}
}
},
"IdType": {
"type": "string",
"description": "Type of identification type.",
"enum": [
"TRANSACTION_IDENTIFIER",
"CLIENT_REFERENCE_ID"
]
},
"ReimbursementFee": {
"type": "number",
"description": "Fee amount for reimbursement",
"format": "double",
"example": 1.5
},
"GivPreviouslyUpdatedFlag": {
"type": "string",
"description": "Flag indicating if the Guaranteed Issuer Value (GIV) was previously updated",
"example": "N"
},
"SettlementInfo": {
"required": [
"settlementResponsibilityFlag"
],
"type": "object",
"properties": {
"givUpdatedFlag": {
"$ref": "#/components/schemas/GivUpdatedFlag"
},
"settlementServiceFlag": {
"$ref": "#/components/schemas/SettlementServiceFlag"
},
"givPreviouslyUpdatedFlag": {
"$ref": "#/components/schemas/GivPreviouslyUpdatedFlag"
},
"settlementResponsibilityFlag": {
"$ref": "#/components/schemas/SettlementResponsibilityFlag"
}
}
},
"ResponseReasonCode": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Code indicating the reason for the response. This is used to provide additional information about the transaction status.\n"
},
"ChipAuthenticationReliabilityIndicator": {
"maximum": 9,
"minimum": 0,
"type": "number",
"description": "Chip authentication reliability indicator"
},
"AdditionalTokenRespInfo": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values is 1 (Token program).
This field will not be sent in the response if the transaction is ineligible for token services.",
"example": "Y"
},
"Id": {
"type": "integer",
"description": "Unique identifier for the transaction",
"format": "int64",
"example": 1234567890
},
"OCTResponseTransactionDetail": {
"required": [
"clientReferenceId",
"initiatingPartyId",
"networkResponse",
"status",
"transactionAmount",
"transactionCurrencyCode",
"transactionDateTime",
"transactionIdentifier"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/Status"
},
"settlementDate": {
"$ref": "#/components/schemas/SettlementDate"
},
"networkResponse": {
"$ref": "#/components/schemas/OCTNetworkResponse"
},
"clientReferenceId": {
"$ref": "#/components/schemas/ClientReferenceId"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"transactionAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"transactionDateTime": {
"$ref": "#/components/schemas/TransactionDateTime"
},
"serviceProcessingType": {
"$ref": "#/components/schemas/ServiceProcessingType"
},
"transactionIdentifier": {
"$ref": "#/components/schemas/TransactionIdentifier"
},
"transactionCurrencyCode": {
"$ref": "#/components/schemas/TransactionCurrencyCode"
},
"enablerVerificationValue": {
"$ref": "#/components/schemas/EnablerVerificationValue"
},
"transactionLinkIdentifier": {
"$ref": "#/components/schemas/TransactionLinkIdentifier"
}
}
},
"StatusIdentifier": {
"type": "string",
"description": "Status identifier"
},
"SenderContactNumber": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Sender contact number.",
"example": "+14155551234"
},
"AFTROriginatorDetail": {
"required": [
"acquirerCountryCode",
"acquiringBin",
"cardAcceptor"
],
"type": "object",
"properties": {
"acquiringBin": {
"$ref": "#/components/schemas/AcquiringBin"
},
"cardAcceptor": {
"$ref": "#/components/schemas/AFTRCardAcceptor"
},
"acquirerCountryCode": {
"$ref": "#/components/schemas/AcquirerCountryCode"
}
},
"description": "Originator details for Account Funding Transaction Reversal"
},
"SenderAddress": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Address of the sender"
},
"AdjustmentResponseData": {
"required": [
"transactionDetail"
],
"type": "object",
"properties": {
"transactionDetail": {
"required": [
"clientReferenceId",
"initiatingPartyId",
"networkResponse",
"status",
"transactionDateTime",
"transactionIdentifier"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the adjustment transaction",
"example": "PAYMENT_DELIVERED",
"enum": [
"PAYMENT_DELIVERED",
"PAYMENT_DECLINED",
"IN_PROGRESS"
]
},
"networkResponse": {
"required": [
"actionCode"
],
"type": "object",
"properties": {
"actionCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Action code returned by the network",
"example": "00"
},
"settlementInfo": {
"required": [
"settlementResponsibilityFlag"
],
"type": "object",
"properties": {
"givUpdatedFlag": {
"type": "string",
"description": "Flag indicating if GIV was updated",
"example": "N"
},
"settlementServiceFlag": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Flag for settlement service",
"example": "Y"
},
"givPreviouslyUpdatedFlag": {
"type": "string",
"description": "Flag indicating if GIV was previously updated",
"example": "N"
},
"settlementResponsibilityFlag": {
"type": "string",
"description": "Flag indicating settlement responsibility",
"example": "Y"
}
},
"description": "Settlement information"
},
"customerReference": {
"type": "string",
"description": "Customer reference information",
"example": "CUSTOMER123"
},
"merchantReference": {
"maxLength": 35,
"type": "string",
"description": "Merchant reference information",
"example": "MERCHANT-REF-12345"
},
"originalActionCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Original action code from the transaction being adjusted",
"example": "00"
},
"cardResponseTokenData": {
"type": "object",
"properties": {
"additionalTokenRespInfo": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Additional token response information",
"example": "A"
}
},
"description": "Token-related response data"
},
"masterCardMerchantPaymentGatewayId": {
"maxLength": 11,
"minLength": 1,
"type": "string",
"description": "MasterCard merchant payment gateway identifier",
"example": "MCPG123456"
},
"senderIdentificationNumberIndividual": {
"type": "string",
"description": "Individual identification number for the sender",
"example": "IND123456"
},
"recipientIdentificationNumberBusiness": {
"type": "string",
"description": "Business identification number for the recipient",
"example": "BIZ123456"
},
"cpsAuthorizationCharactersticIndicator": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "CPS authorization characteristic indicator",
"example": "Y"
}
},
"description": "Network response details"
},
"clientReferenceId": {
"maxLength": 12,
"minLength": 12,
"type": "string",
"description": "Client-generated unique transaction identifier",
"example": "ADJUST202505"
},
"initiatingPartyId": {
"type": "integer",
"description": "A unique identifier assigned by the initiating party for the API consumer",
"format": "int64",
"example": 987654321
},
"transactionDateTime": {
"type": "string",
"description": "Date and time when the transaction was processed",
"format": "date-time",
"example": "2025-05-20T14:30:45Z"
},
"serviceProcessingType": {
"type": "object",
"properties": {
"requestType": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Type of service processing request",
"example": "10"
}
},
"description": "Service processing type information"
},
"transactionIdentifier": {
"type": "integer",
"description": "Unique identifier assigned by Visa for the transaction",
"format": "int64",
"example": 1234567890123456
},
"enablerVerificationValue": {
"maxLength": 5,
"minLength": 5,
"type": "string",
"description": "Value used for verification by the enabler",
"example": "12345"
},
"transactionLinkIdentifier": {
"maxLength": 36,
"minLength": 1,
"type": "string",
"description": "Identifier linking related transactions",
"example": "TRX-LINK-123456"
}
},
"description": "Transaction details for the adjustment response"
}
},
"description": "Response data for card transaction adjustment"
},
"MasterCardElectronicCommerceIndicators": {
"maxLength": 19,
"minLength": 7,
"type": "string",
"description": "This field contains the security-level indicator for Mastercard issuer-authenticated transactions.\n"
},
"FeePrograms": {
"type": "object",
"properties": {
"surcharge": {
"type": "number",
"format": "double"
},
"nationalReimbursementFee": {
"type": "number",
"format": "double"
}
}
},
"CardAcceptor": {
"required": [
"id",
"terminalId"
],
"type": "object",
"properties": {
"id": {
"maxLength": 15,
"minLength": 1,
"type": "string",
"description": "Card acceptor ID"
},
"name": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Name of the card acceptor"
},
"address": {
"$ref": "#/components/schemas/CardAcceptorAddress"
},
"terminalId": {
"maxLength": 8,
"type": "string",
"description": "Identifier for the terminal at the card acceptor location",
"example": "TERM1234"
},
"legalBusinessName": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Legal business name of the card acceptor"
},
"paymentFacilitator": {
"type": "object",
"properties": {
"id": {
"maxLength": 11,
"minLength": 1,
"type": "string",
"description": "Payment facilitator ID",
"example": "PF123456789"
},
"name": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Payment facilitator name",
"example": "Payment Facilitator Inc"
},
"address": {
"type": "object",
"properties": {
"city": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "City",
"example": "San Francisco"
},
"state": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "State code",
"example": "CA"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Country code",
"example": "USA"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Postal code",
"example": "94105"
},
"addressLine": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Address line",
"example": "123 Market St"
}
}
},
"submerchantId": {
"maxLength": 15,
"minLength": 1,
"type": "string",
"description": "Submerchant ID",
"example": "SUB123456789012"
}
}
},
"merchantCategoryCode": {
"type": "number",
"description": "Merchant category code"
},
"merchantVerificationValue": {
"maxLength": 10,
"minLength": 10,
"type": "string",
"description": "Merchant verification value"
}
}
},
"ServiceLocationState": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "State of the service location"
},
"NationalReimbursementFee": {
"type": "number",
"description": "National reimbursement fee",
"format": "double"
},
"RoutingNetworkId": {
"maxLength": 30,
"minLength": 1,
"type": "string"
},
"AFTCardAcceptor": {
"required": [
"address",
"id",
"name",
"terminalId"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/CardAcceptorId"
},
"name": {
"$ref": "#/components/schemas/CardAcceptorName"
},
"taxID": {
"$ref": "#/components/schemas/TaxID"
},
"address": {
"$ref": "#/components/schemas/CardAcceptorAddress"
},
"terminalId": {
"$ref": "#/components/schemas/TerminalId"
},
"urlAddress": {
"$ref": "#/components/schemas/UrlAddress"
},
"legalBusinessName": {
"$ref": "#/components/schemas/CardAcceptorLegalBusinessName"
},
"merchantReference": {
"$ref": "#/components/schemas/MerchantReference"
},
"contactInformation": {
"$ref": "#/components/schemas/CardAcceptorContactInformation"
},
"paymentFacilitator": {
"$ref": "#/components/schemas/PaymentFacilitator"
},
"merchantCategoryCode": {
"$ref": "#/components/schemas/MerchantCategoryCode"
},
"serviceLocationDetails": {
"$ref": "#/components/schemas/ServiceLocationDetails"
},
"visaMerchantIdentifier": {
"$ref": "#/components/schemas/VisaMerchantIdentifier"
},
"merchantVerificationValue": {
"$ref": "#/components/schemas/MerchantVerificationValue"
},
"remoteCommerceAcceptorIdentifier": {
"$ref": "#/components/schemas/RemoteCommerceAcceptorIdentifier"
}
}
},
"DelegatedAuthenticationIndicator": {
"type": "string",
"description": "Delegated authentication indicator, valid values \"true\" or \"false\"",
"enum": [
"true",
"false"
]
},
"FxConversionRate": {
"type": "number",
"description": "Rate used to convert the transaction amount to the settlement amount when currencies differ",
"format": "double",
"example": 1.05
},
"RecipientDetailAddress": {
"type": "object",
"properties": {
"city": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Recipient address city. ISO20022 field name: Creditor Address Town Name.\n",
"example": "San Francisco"
},
"state": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Recipient address state or province. ISO20022 field name: Creditor Address Country Sub-division.\n",
"example": "CA"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Recipient address country. Format: 3-character ISO-3166 (Alpha-3) country code. ISO20022 field name: Creditor Address Country.\n",
"example": "USA"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Recipient address postal code. ISO20022 field name: Creditor Address Postal Code.\n",
"example": "94105"
},
"streetName": {
"maxLength": 70,
"minLength": 1,
"type": "string",
"description": "Recipient street name",
"example": "Main Street"
},
"addressLine1": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Recipient address line 1. ISO20022 field name: Creditor Address Line 1.\n",
"example": "123 Main Street"
},
"addressLine2": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Recipient address line 2. ISO20022 field name: Creditor Address Line 2.\n",
"example": "Suite 456"
},
"buildingNumber": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient building number",
"example": "123"
},
"subDivisionMinorCode": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient sub-division minor code",
"example": "SFO"
}
},
"description": "Address details of the recipient"
},
"AFTRCardAcceptor": {
"required": [
"id",
"terminalId"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/CardAcceptorId"
},
"terminalId": {
"$ref": "#/components/schemas/TerminalId"
},
"merchantVerificationValue": {
"$ref": "#/components/schemas/MerchantVerificationValue"
}
},
"description": "Card acceptor details for Account Funding Transaction Reversal"
},
"QueryTransactionDetail": {
"required": [
"clientReferenceId",
"networkResponse",
"status",
"transactionCurrencyCode",
"transactionDateTime",
"transactionIdentifier",
"transactionType"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/Status"
},
"posData": {
"type": "object",
"properties": {
"motoECIIndicator": {
"$ref": "#/components/schemas/MotoECIIndicator"
}
}
},
"rejectReason": {
"$ref": "#/components/schemas/RejectReason"
},
"approvedAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"processingDate": {
"$ref": "#/components/schemas/ProcessingDate"
},
"networkResponse": {
"$ref": "#/components/schemas/QueryNetworkResponse"
},
"transactionType": {
"$ref": "#/components/schemas/TransactionType"
},
"rejectReasonCode": {
"$ref": "#/components/schemas/RejectReasonCode"
},
"clientReferenceId": {
"$ref": "#/components/schemas/ClientReferenceId"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"transactionAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"feeProgramIndicator": {
"$ref": "#/components/schemas/FeeProgramIndicator"
},
"transactionDateTime": {
"$ref": "#/components/schemas/TransactionDateTime"
},
"serviceProcessingType": {
"$ref": "#/components/schemas/ServiceProcessingType"
},
"transactionIdentifier": {
"$ref": "#/components/schemas/TransactionIdentifier"
},
"transactionCurrencyCode": {
"$ref": "#/components/schemas/TransactionCurrencyCode"
},
"enablerVerificationValue": {
"$ref": "#/components/schemas/EnablerVerificationValue"
}
}
},
"OCTCardResponseTokenData": {
"type": "object",
"properties": {
"last4ofPAN": {
"$ref": "#/components/schemas/Last4ofPAN"
},
"tokenAssuranceMethod": {
"$ref": "#/components/schemas/TokenAssuranceMethod"
},
"additionalTokenRespInfo": {
"$ref": "#/components/schemas/AdditionalTokenRespInfo"
}
}
},
"AddressVerificationResult": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Address verification result"
},
"TokenAssuranceMethod": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Token assurance method"
},
"SenderIdentificationList": {
"required": [
"idNumber",
"idType"
],
"type": "array",
"items": {
"$ref": "#/components/schemas/SenderIdentification"
}
},
"VerificationCardAcceptor": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"maxLength": 15,
"minLength": 1,
"type": "string",
"description": "Identifier for the card acceptor",
"example": "Verification001"
},
"name": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Name of the cardAcceptor",
"example": "Verification TEST"
},
"address": {
"$ref": "#/components/schemas/VerificationCardAcceptorAddress"
},
"terminalId": {
"maxLength": 8,
"minLength": 1,
"type": "string",
"description": "The identifier for the terminal at a card acceptor location",
"example": "TERM0001"
}
},
"description": "The cardAcceptor is the merchant, funds transfer originator, or Visa internal application submitting the Payment Account Validation request"
},
"SchemeIdentifier": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Scheme identifier for the card, \"01\" Visa, \"02\" Other",
"example": "01",
"enum": [
"01",
"02"
]
},
"SenderType": {
"type": "string",
"description": "Identifies the type of sender - \"I\" for Individual, \"C\" for Company",
"example": "I",
"enum": [
"I",
"C"
]
},
"AncillarySenderDetailAddress": {
"type": "object",
"properties": {
"city": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "This field contains the city of the ancillary sender's address."
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "This field contains the 3-digit numeric or 3-character alpha ISO country code of the ancillary sender's address.
Refer to ISO Codes"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "This field contains the postal code of the ancillary sender's address."
},
"addressLine1": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "This field contains the first line of the ancillary sender's address."
},
"addressLine2": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "This field contains the second line of the ancillary sender's address."
}
}
},
"QueryResponseData": {
"required": [
"originatorDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"originatorDetail": {
"$ref": "#/components/schemas/QueryOriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/QueryTransactionDetail"
}
},
"description": "Query response data structure"
},
"TransactionCurrencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "ISO 4217 currency code",
"example": "USD"
},
"Nationality": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-digit numeric or 3-character alpha ISO country code of the nationality"
},
"AdditionalAcceptorId": {
"type": "object",
"properties": {
"idType": {
"type": "string",
"description": "Defines type of card Acceptor.
Duplicate instances of same idType is not allowed
Marketplace - Marketplace that facilitated the digital currency sale/purchase.
Gateways - Payment gateway that facilitated the digital currency sale/purchase.
StageDigitalWallet - Staged Digital Wallet that facilitated the digital currency sale/purchase.
RampProvider - Ramp provider that facilitated the digital currency sale/purchase.",
"enum": [
"Marketplace",
"Gateways",
"StagedDigitalWallet",
"RampProvider"
]
},
"idValue": {
"maxLength": 11,
"minLength": 1,
"type": "string",
"description": "Value of idType provided for additional acceptor"
}
}
},
"ScaEnvironmentOutageIndicator": {
"type": "string",
"description": "SCA environment outage indicator",
"enum": [
"true",
"false"
]
},
"TransactionAmount": {
"type": "number",
"description": "Transaction amount",
"format": "double",
"example": 123.45
},
"OCTTransactionDetail": {
"required": [
"businessApplicationId",
"clientReferenceId",
"localTransactionDateTime",
"transactionAmount",
"transactionCurrencyCode"
],
"type": "object",
"properties": {
"fees": {
"type": "object",
"properties": {
"surcharge": {
"$ref": "#/components/schemas/Surcharge"
}
}
},
"posData": {
"$ref": "#/components/schemas/OCTTransactionPosData"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OCTTransactionDetailAdditionalData"
}
},
"purposeOfPayment": {
"$ref": "#/components/schemas/PurposeOfPayment"
},
"routingNetworkId": {
"$ref": "#/components/schemas/NetworkId"
},
"clientReferenceId": {
"$ref": "#/components/schemas/ClientReferenceId"
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"messageReasonCode": {
"$ref": "#/components/schemas/MessageReasonCode"
},
"transactionAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"feeProgramIndicator": {
"$ref": "#/components/schemas/FeeProgramIndicator"
},
"senderSourceOfFunds": {
"$ref": "#/components/schemas/SenderSourceOfFunds"
},
"businessApplicationId": {
"$ref": "#/components/schemas/BusinessApplicationId"
},
"serviceProcessingType": {
"$ref": "#/components/schemas/ServiceProcessingType"
},
"transactionIdentifier": {
"$ref": "#/components/schemas/TransactionIdentifier"
},
"transactionCurrencyCode": {
"description": "3-digit numeric or 3-character alpha ISO currency code of the transaction as expressed in the amount field. This can be either:- The originator's chosen currency for the transaction OR
- The recipient's card currency (refer to the billingCurrencyCode obtained from the Eligibility Check for Card API)*
Adjust amount accordingly based on chosen transactionCurrencyCode.
*Note: This currency may not always be the local currency code of the recipient.
Refer to ISO Codes",
"allOf": [
{
"$ref": "#/components/schemas/TransactionCurrencyCode"
}
]
},
"enablerVerificationValue": {
"$ref": "#/components/schemas/EnablerVerificationValue"
},
"localTransactionDateTime": {
"$ref": "#/components/schemas/LocalTransactionDateTime"
},
"optionalResponseParameters": {
"maxLength": 400,
"type": "string",
"description": "Comma-separated list of optional response parameters to include in the response"
},
"settlementServiceIndicator": {
"$ref": "#/components/schemas/SettlementServiceIndicator"
}
},
"description": "Transaction details for Original Credit Transaction"
},
"AFTServiceProcessingType": {
"required": [
"requestType"
],
"type": "object",
"properties": {
"requestType": {
"maxLength": 2,
"minLength": 2,
"type": "string"
}
}
},
"ReplacementCardAccountNumber": {
"maxLength": 28,
"minLength": 1,
"type": "string",
"description": "Account number of the replacement card",
"example": "4123450000000000"
},
"CardAcceptorContactInformation": {
"type": "object",
"properties": {
"phoneNumber": {
"$ref": "#/components/schemas/CardAcceptorPhoneNumber"
},
"additionalContactDetails": {
"$ref": "#/components/schemas/CardAcceptorAdditionalContactDetails"
},
"customerServicePhoneNumber": {
"$ref": "#/components/schemas/CardAcceptorCustomerServicePhoneNumber"
}
}
},
"TransactionBase": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double"
},
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "currency code. refer to ISO currency code"
}
}
},
"RecipientDateOfBirth": {
"type": "string",
"description": "Recipient date of birth (Format: \"YYYY-MM-DD\", e.g. \"1980-02-01\"). ISO20022 field name: Creditor Birth Date.\n",
"format": "date"
},
"CPSAuthorizationCharacteristicIndicator": {
"type": "string",
"description": "CPS authorization characteristic indicator",
"example": "Y",
"enum": [
"Y",
"N"
]
},
"OriginalDataElements": {
"required": [
"acquiringBin",
"systemsTraceAuditNumber",
"transmissionDateTime"
],
"type": "object",
"properties": {
"acquiringBin": {
"$ref": "#/components/schemas/AcquiringBin"
},
"approvalCode": {
"maxLength": 6,
"minLength": 1,
"type": "string",
"description": "Approval code from the original transaction",
"example": "123456"
},
"transmissionDateTime": {
"type": "string",
"description": "Date and time of the original transaction transmission",
"format": "date-time",
"example": "2023-06-15T14:25:32Z"
},
"systemsTraceAuditNumber": {
"$ref": "#/components/schemas/SystemsTraceAuditNumber"
}
},
"description": "Data elements from the original transaction that is being reversed"
},
"CardAcceptorPhoneNumber": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Phone number of the card acceptor",
"example": "+1234567890"
},
"PurchaseIdentifier": {
"required": [
"referenceNumber",
"type"
],
"type": "object",
"properties": {
"type": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "This field should be populated with value 1 if sending the Request to Pay ID in the referenceNumber."
},
"referenceNumber": {
"maxLength": 25,
"type": "string",
"description": "This is the invoice number or some other reference for billing purposes.e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up."
}
}
},
"AFTRTransactionDetail": {
"required": [
"id",
"idType",
"localTransactionDateTime",
"transactionAmount",
"transactionCurrencyCode"
],
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"card": {
"type": "object",
"properties": {
"posData": {
"$ref": "#/components/schemas/PosData"
}
}
},
"fees": {
"$ref": "#/components/schemas/Fees"
},
"idType": {
"$ref": "#/components/schemas/IdType"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AFTRTransactionDetailAdditionalData"
}
},
"initiatingPartyId": {
"$ref": "#/components/schemas/InitiatingPartyId"
},
"transactionAmount": {
"$ref": "#/components/schemas/TransactionAmount"
},
"feeProgramIndicator": {
"$ref": "#/components/schemas/FeeProgramIndicator"
},
"transactionCurrencyCode": {
"description": "Use a 3-digit numeric or 3-character alpha ISO currency code for currency of the original transaction.
Refer to ISO Codes",
"allOf": [
{
"$ref": "#/components/schemas/TransactionCurrencyCode"
}
]
},
"enablerVerificationValue": {
"$ref": "#/components/schemas/EnablerVerificationValue"
},
"localTransactionDateTime": {
"$ref": "#/components/schemas/LocalTransactionDateTime"
}
},
"description": "Transaction details for Account Funding Transaction Reversal"
},
"ServiceLocationAddress": {
"type": "object",
"properties": {
"city": {
"$ref": "#/components/schemas/ServiceLocationCity"
},
"state": {
"$ref": "#/components/schemas/ServiceLocationState"
},
"country": {
"$ref": "#/components/schemas/ServiceLocationCountry"
},
"postalCode": {
"$ref": "#/components/schemas/ServiceLocationPostalCode"
}
}
},
"RecipientContactNumberType": {
"type": "string",
"description": "Type of contact number",
"example": "MOBILE",
"enum": [
"MOBILE",
"WORK",
"HOME"
]
},
"ErrorResponseWithKey": {
"type": "object",
"properties": {
"errorResponse": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
},
"AFTTransactionPosData": {
"required": [
"motoECIIndicator",
"panEntryMode",
"posConditionCode"
],
"type": "object",
"properties": {
"pinData": {
"$ref": "#/components/schemas/PinData"
},
"panEntryMode": {
"$ref": "#/components/schemas/PanEntryMode"
},
"posEnvironment": {
"$ref": "#/components/schemas/PosEnvironment"
},
"motoECIIndicator": {
"$ref": "#/components/schemas/MotoECIIndicator"
},
"posConditionCode": {
"$ref": "#/components/schemas/PosConditionCode"
},
"chipConditionCode": {
"$ref": "#/components/schemas/ChipConditionCode"
},
"magneticStripeData": {
"$ref": "#/components/schemas/MagneticStripeData"
},
"chipTransactionIndicator": {
"$ref": "#/components/schemas/ChipTransactionIndicator"
},
"pointOfServiceCapability": {
"$ref": "#/components/schemas/PointOfServiceCapability"
},
"integratedCircuitCardData": {
"$ref": "#/components/schemas/IntegratedCircuitCardData"
},
"specialConditionIndicatorMerchant": {
"$ref": "#/components/schemas/SpecialConditionIndicatorMerchant"
},
"chipAuthenticationReliabilityIndicator": {
"$ref": "#/components/schemas/ChipAuthenticationReliabilityIndicator"
}
}
},
"RecipientFirstName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient first name. Conditionally required when \"name\" is not provided. The length of first name and last name combined must be at least 3 characters. Must not contain exclusively numeric characters. Must not contain special symbols. ISO20022 field name: Creditor First Name.\n",
"example": "Jane"
},
"AccountFundingSource": {
"type": "string",
"description": "Source of funds for the transaction",
"example": "CREDIT",
"enum": [
"CREDIT",
"DEBIT",
"PREPAID"
]
},
"AFTRResponseOriginatorDetail": {
"type": "object",
"properties": {
"cardAcceptor": {
"$ref": "#/components/schemas/AFTRResponseCardAcceptor"
}
}
},
"CardAcceptorLegalBusinessName": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Legal business name of the card acceptor",
"example": "ACME Corporation"
},
"PaymentFacilitator": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/PaymentFacilitatorId"
},
"name": {
"$ref": "#/components/schemas/PaymentFacilitatorName"
},
"address": {
"$ref": "#/components/schemas/PaymentFacilitatorAddress"
},
"additionalAcceptor": {
"$ref": "#/components/schemas/AFTAdditionalAcceptor"
}
}
},
"RecipientContactEmail": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Recipient email address. ISO20022 field name - Ultimate Creditor Contact Email Address.",
"format": "email",
"example": "jane.doe@example.com"
},
"RecipientAccountNumber": {
"maxLength": 34,
"minLength": 1,
"type": "string",
"description": "Account number of the recipient"
},
"AFTOriginatorDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardPartnerIdCode
Conditional.
This field identifies a specific partnership agreement, generally between specific acceptors and issuers. may be used for transactions on accounts issued under co-branding agreements when one of the co-branding partners originates the transaction.
This field is conditionally required for all MasterCard transactions."
},
"value": {
"maxLength": 8,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardIndependentSalesOrganizationId
Conditional.
This field contains the \"Company ID\" that is assigned during the time of registration with Mastercard Connect as a service provider and must be provided by the acquirer.
This field is conditionally required for all MasterCard transactions."
},
"value": {
"maxLength": 11,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardSubMerchantId
Sub-Merchant ID containing the sponsored merchant ID. This field is conditionally required when a payment facilitator is involved and for all MasterCard transactions."
},
"value": {
"maxLength": 15,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardMerchantPaymentGatewayId
This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled."
},
"value": {
"maxLength": 11,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "merchantPseudoAbaNumber
This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.
Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service."
},
"value": {
"maxLength": 9,
"minLength": 9,
"type": "string"
}
}
}
]
},
"NetworkResponseSettlementInfo": {
"type": "object",
"properties": {
"givUpdatedFlag": {
"$ref": "#/components/schemas/GivUpdatedFlag"
},
"settlementServiceFlag": {
"$ref": "#/components/schemas/SettlementServiceFlag"
},
"givPreviouslyUpdatedFlag": {
"$ref": "#/components/schemas/GivPreviouslyUpdatedFlag"
},
"settlementResponsibilityFlag": {
"$ref": "#/components/schemas/SettlementResponsibilityFlag"
}
}
},
"AccountStatus": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Status of the account",
"example": "A"
},
"Surcharge": {
"type": "number",
"description": "Surcharge as assessed by the Originating Entity. Values must be included in the transactionAmount and should be in the same currency and format.",
"format": "double",
"example": 5
},
"MessageReasonCode": {
"type": "number",
"description": "Conditional.
Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD'",
"example": 123
},
"CardExpiryDate": {
"maxLength": 4,
"minLength": 4,
"pattern": "^(0[1-9]|1[0-2])(2[0-9]|3[0-9])$",
"type": "string",
"description": "Expiration date of the recipient's card in MMYY format",
"example": "1225"
},
"ServiceLocationCity": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "City of the service location",
"example": "Service City"
},
"AcquiringBin": {
"type": "integer",
"description": "Bank Identification Number of the acquirer",
"example": 412345
},
"PaymentFacilitatorAddress": {
"type": "object",
"properties": {
"city": {
"$ref": "#/components/schemas/PaymentFacilitatorCity"
},
"state": {
"$ref": "#/components/schemas/PaymentFacilitatorState"
},
"country": {
"$ref": "#/components/schemas/PaymentFacilitatorCountry"
},
"postalCode": {
"$ref": "#/components/schemas/PaymentFacilitatorPostalCode"
},
"addressLine": {
"$ref": "#/components/schemas/PaymentFacilitatorAddressLine"
}
}
},
"OCTCardVerificationResults": {
"type": "object",
"properties": {
"cvv2ResultCode": {
"$ref": "#/components/schemas/Cvv2ResultCode"
}
}
},
"SourceAmount": {
"type": "number",
"format": "double"
},
"ErrorInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"message": {
"type": "string",
"description": "Error message description"
}
}
},
"RecipientIdentificationList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecipientIdentification"
}
},
"Recipient": {
"required": [
"primaryAccountNumber"
],
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/RecipientName"
},
"address": {
"$ref": "#/components/schemas/RecipientAddress"
},
"cardExpiryDate": {
"$ref": "#/components/schemas/CardExpiryDate"
},
"primaryAccountNumber": {
"$ref": "#/components/schemas/PrimaryAccountNumber"
}
}
},
"OCTAdditionalAcceptor": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"description": "Multiple ids can be provided for additional Acceptor. Duplicate instance of same idType is not allowed eg. One instance of Gateways and RampProvider can be present in the same request but multiple instances of same idType like Gateways is not allowed.",
"items": {
"$ref": "#/components/schemas/AdditionalAcceptorId"
}
},
"foreignRetailerIndicator": {
"type": "string",
"description": "Identifies a foreign retailer under a marketplace and/or payment facilitator.
May also Identify a foreign Conversion Affiliate under a Ramp
This tag must contain either:
A – Conversion Affiliate is located in the same country as Ramp provider
B – Conversion Affiliate is located in a different country as Ramp provider"
}
}
},
"NetworkId": {
"type": "number",
"description": "Network identifieron which the transaction was prrocessed. Refer to network codes",
"example": 2
},
"PanEntryMode": {
"type": "number",
"description": "A 2-digit code that identifies the method used to enter the cardholder account number and card expiration date."
},
"CardData": {
"type": "object",
"properties": {
"accountNumber": {
"maxLength": 19,
"minLength": 13,
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date"
}
}
},
"IntegratedCircuitCardData": {
"maxLength": 255,
"minLength": 2,
"type": "string",
"description": "Integrated circuit card data"
},
"RecipientIdentification": {
"required": [
"idNumber",
"idType"
],
"type": "object",
"properties": {
"idType": {
"type": "string",
"description": "Type of identification document. Valid types include: CUID (Customer ID), NTID (National ID), PASN (Passport), DRLN (Driver License), TXIN (Tax ID), CPNY (Company ID), PRXY (Proxy ID)\n",
"example": "PASN",
"enum": [
"CUID",
"NTID",
"PASN",
"DRLN",
"TXIN",
"CPNY",
"PRXY",
"SSNB",
"ARNB",
"LAWE",
"MILI",
"TRVL",
"EMAL",
"PHON",
"BTHD"
]
},
"idNumber": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient identification number (issued by a government or similar authority). ISO20022 field name - \"Creditor Private Identification\" or \"Creditor Organisation Identification\".\n",
"example": "A1234567"
},
"idOwnerType": {
"type": "string",
"description": "Type of identification owner - Individual or Company",
"example": "I",
"enum": [
"I",
"C"
]
},
"idIssueCountry": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Recipient identification issuing country. Format: 3-digit numeric or 3-character alpha ISO country code. ISO20022 field name - \"Creditor Private Identification Issuer Country\" or \"Creditor Organisation Identification Issuer Country\".\n",
"example": "USA"
}
},
"description": "Recipient identification document details"
},
"ChipConditionCode": {
"type": "number",
"description": "Contains a code identifying chip conditions at the point of sale or point of service."
},
"NationalServiceData": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/ArgentinaNationalServiceData"
},
{
"$ref": "#/components/schemas/ColombiaNationalServiceData"
},
{
"$ref": "#/components/schemas/MexicoNationalServiceData"
}
]
},
"CardAuthenticationResults": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "A Visa-defined code indicating Online Card Authentication Method results. Refer to cardAuthenticationResults Refer to cardAuthenticationResults",
"example": "1"
},
"OCTSenderDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "localNameData
This object is used to provide the sender's local name data. This object is required for transactions where the sender's local name data is required."
},
"value": {
"$ref": "#/components/schemas/SenderLocalNameData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "contactInformationList
Contact Information list of sender.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/ContactInformationList"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "ancillarySenderDetails
Ancillary sender details.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/AncillarySenderDetails"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identificationNumberBusiness
Conditional.
This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)
Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions."
},
"value": {
"maxLength": 20,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "identificationNumberIndividual
This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains the customer’s VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments),
Note: If senderIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions.
If businessApplicationId has PS, then this field to be populated for Argentina domestic transaction."
},
"value": {
"maxLength": 13,
"minLength": 1,
"type": "string"
}
}
}
]
},
"MerchantReference": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Merchant reference number",
"example": "MR123456789"
},
"OCTOriginatorDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardPartnerIdCode
Conditional.
This field identifies a specific partnership agreement, generally between specific acceptors and issuers. may be used for transactions on accounts issued under co-branding agreements when one of the co-branding partners originates the transaction.
This field is conditionally required for all MasterCard transactions."
},
"value": {
"maxLength": 8,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardIndependentSalesOrganizationId
Conditional.
This field contains the \"Company ID\" that is assigned during the time of registration with Mastercard Connect as a service provider and must be provided by the acquirer.
This field is conditionally required for all MasterCard transactions."
},
"value": {
"maxLength": 11,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardSubMerchantId
Sub-Merchant ID containing the sponsored merchant ID. This field is conditionally required when a payment facilitator is involved and for all MasterCard transactions."
},
"value": {
"maxLength": 15,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardMerchantPaymentGatewayId
This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled."
},
"value": {
"maxLength": 11,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "merchantPseudoAbaNumber
This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.
Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service."
},
"value": {
"maxLength": 9,
"minLength": 9,
"type": "string"
}
}
}
]
},
"PaymentFacilitatorName": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Name of the payment facilitator",
"example": "Payment Facilitator Inc."
},
"AcquirerCountryCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Acquirer country code"
},
"ScpExemptionIndicator": {
"type": "string",
"description": "SCP exemption indicator",
"enum": [
"true",
"false"
]
},
"VerificationResponseData": {
"required": [
"cardVerificationDetail",
"transactionalDetail"
],
"type": "object",
"properties": {
"transactionDetail": {
"required": [
"clientReferenceId",
"initiatingPartyId"
],
"type": "object",
"properties": {
"approvalCode": {
"maxLength": 6,
"minLength": 1,
"type": "string",
"description": "Approval code from the Issuer",
"example": "123456"
},
"clientReferenceId": {
"maxLength": 12,
"minLength": 12,
"type": "string",
"description": "Reference identifier to tie multiple API calls with a single funds transfer transaction"
},
"initiatingPartyId": {
"type": "integer",
"description": "A unique identifier assigned by the initiating party for the API consumer",
"format": "int64",
"example": 987654321
},
"transactionIdentifier": {
"maxLength": 15,
"minLength": 15,
"type": "string",
"description": "Visa generated unique identifier for the transaction",
"example": "123456789012345"
}
}
},
"cardVerificationDetail": {
"required": [
"cardVerificationResult"
],
"type": "object",
"properties": {
"invalidReason": {
"type": "string",
"description": "Reason why card is invalid",
"example": "EXPIRED_CARD",
"enum": [
"UNKNOWN",
"LOST_CARD",
"STOLEN_CARD",
"EXPIRED_CARD",
"INVALID_ACCOUNT",
"CLOSED_ACCOUNT",
"CVV2_FAILURE",
"FRAUD",
"SUSPECTED_FRAUD",
"RESTRICTED_CARD",
"INVALID_CVV",
"CARD_BLOCKED",
"SECURITY_VIOLATION",
"TRANSACTION_NOT_PERMITTED",
"INVALID_TRANSACTION",
"INSUFFICIENT_FUNDS"
]
},
"cvvVerificationResult": {
"type": "string",
"description": "Result of the CVV2 validation for the primaryAccountNumber in the request",
"example": "MATCH",
"enum": [
"MATCH",
"NO_MATCH",
"NOT_PERFORMED"
]
},
"cardVerificationResult": {
"type": "string",
"description": "Result of the card verification process",
"example": "VALID",
"enum": [
"VALID",
"INVALID"
]
},
"nameVerificationResult": {
"type": "string",
"description": "Result of the account name matching performed by Account Name",
"example": "MATCH",
"enum": [
"MATCH",
"PARTIAL_MATCH",
"NO_MATCH",
"NOT_PERFORMED",
"NOT_SUPPORTED"
]
},
"cardAuthenticationResult": {
"type": "string",
"description": "A Visa-defined code indicating Online Card Authentication Method result",
"example": "VERIFIED",
"enum": [
"VERIFIED",
"FAILED",
"NOT_PERFORMED"
]
},
"addressVerificationResult": {
"type": "string",
"description": "Result of the Address Verification Service (AVS) validation for the Primary account number in the request when requested",
"example": "MATCH",
"enum": [
"MATCH",
"PARTIAL_MATCH_POSTALCODE",
"PARTIAL_MATCH_STREETADDRESS",
"NOT_VERIFIED",
"NOT_VERIFIED_RETRY"
]
},
"identityVerificationResult": {
"type": "object",
"properties": {
"idType": {
"type": "string",
"description": "Account holder ID type",
"example": "PSPN",
"enum": [
"NTID",
"PSPN",
"DRLN",
"TXIN"
]
},
"idVerificationResult": {
"type": "string",
"description": "Identity verification result",
"example": "VERIFIED",
"enum": [
"VERIFIED",
"NOT_PERFORMED",
"FAILED",
"NOT_SUPPORTED"
]
}
},
"description": "Identity verification details"
},
"lastNameVerificationResult": {
"type": "string",
"description": "Result of the account last name matching performed by Account Name",
"example": "MATCH",
"enum": [
"MATCH",
"PARTIAL_MATCH",
"NO_MATCH"
]
},
"firstNameVerificationResult": {
"type": "string",
"description": "Result of the account First name matching performed by Account Name",
"example": "MATCH",
"enum": [
"MATCH",
"PARTIAL_MATCH",
"NO_MATCH"
]
},
"middleNameVerificationResult": {
"type": "string",
"description": "Result of the account middle name matching performed by Account Name",
"example": "MATCH",
"enum": [
"MATCH",
"PARTIAL_MATCH",
"NO_MATCH"
]
},
"phoneNumberVerificationResult": {
"type": "string",
"description": "Card holder phone verification result from the issuer",
"example": "VERIFIED",
"enum": [
"VERIFIED",
"NOT_PERFORMED",
"FAILED"
]
},
"emailAddressVerificationResult": {
"type": "string",
"description": "Card holder Email Address Verification Results from the issuer",
"example": "VERIFIED",
"enum": [
"VERIFIED",
"NOT_PERFORMED",
"FAILED"
]
},
"cardholderAuthenticationVerificationResult": {
"type": "string",
"description": "If TAVV is provided in the request, its validation result will be provided in this field.\nFor future: This field will be extended to provide validation result for Cardholder Authentication Verification Value (CAVV).\n",
"example": "VERIFIED",
"enum": [
"VERIFIED",
"FAILED",
"NOT_PERFORMED"
]
}
},
"description": "Verification results for the card"
}
},
"description": "Response data for Verification check with card verification results"
},
"CardResponseTokenData": {
"type": "object",
"properties": {
"last4ofPAN": {
"$ref": "#/components/schemas/Last4ofPAN"
},
"minimumAccountRange": {
"$ref": "#/components/schemas/MinimumAccountRange"
},
"tokenAssuranceMethod": {
"$ref": "#/components/schemas/TokenAssuranceMethod"
},
"additionalTokenRespInfo": {
"$ref": "#/components/schemas/AdditionalTokenRespInfo"
}
}
},
"SettlementResponsibilityFlag": {
"type": "string",
"description": "Flag indicating the settlement responsibility",
"example": "Y"
},
"SettlementServiceIndicator": {
"maximum": 9,
"minimum": 0,
"type": "number",
"description": "Indicator for settlement service type"
},
"InitiatingPartyId": {
"type": "integer",
"description": "A unique identifier assigned by the initiating party for the API consumer",
"format": "int64",
"example": 987654321
},
"TransactionIdentifier": {
"type": "number",
"description": "Visa generated unique identifier for the transaction",
"format": "int64",
"example": 123456789012345
},
"VerificationCardHolder": {
"type": "object",
"properties": {
"name": {
"required": [
"lastName"
],
"type": "object",
"properties": {
"lastName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Last name of account or entity",
"example": "Smith"
},
"firstName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "First name of account or entity",
"example": "John"
},
"middleName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Middle name of account or entity",
"example": "Robert"
}
},
"description": "Card holder name to be validated with issuer"
},
"address": {
"required": [
"postalCode"
],
"type": "object",
"properties": {
"postalCode": {
"maxLength": 9,
"minLength": 1,
"type": "string",
"description": "Postal Code provided by the account holder",
"example": "94105"
},
"addressLine1": {
"maxLength": 40,
"minLength": 1,
"type": "string",
"description": "Address provided by the account holder",
"example": "123 Main Street"
}
},
"description": "Card holder address to be validated with issuer"
},
"ownerType": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Account owner type to identify if the name belongs to the primary or secondary account owner",
"example": "01"
},
"phoneNumber": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "Card holder Phone Number verified with the issuer",
"example": "+14155551234"
},
"emailAddress": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Card holder Email Address verified with the issuer",
"example": "john.smith@example.com"
},
"identificationList": {
"type": "array",
"description": "Used to validate the cardholder identity. Supported only in the LAC region. API calls have to be MLE enabled to use this.",
"items": {
"required": [
"idNumber",
"idType"
],
"type": "object",
"properties": {
"idType": {
"type": "string",
"description": "Type of identification",
"example": "PASN",
"enum": [
"NTID",
"PASN",
"DRLN",
"TXIN"
]
},
"idNumber": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "The identification value",
"example": "P1234567"
}
}
}
}
},
"description": "Card holder details for Verification check"
},
"AFTRequestData": {
"required": [
"originatorDetail",
"recipientDetail",
"senderDetail",
"transactionDetail"
],
"type": "object",
"properties": {
"senderDetail": {
"$ref": "#/components/schemas/AFTSenderDetail"
},
"recipientDetail": {
"$ref": "#/components/schemas/AFTRecipientDetail"
},
"originatorDetail": {
"$ref": "#/components/schemas/AFTOriginatorDetail"
},
"transactionDetail": {
"$ref": "#/components/schemas/AFTTransactionDetail"
}
}
},
"SpecialConditionIndicatorMerchant": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Cryptocurrency indicator with the value of “7” can be used to identify the purchase of cryptocurrency, thereby providing greater visibility to the issuers.\n - 1 – Purchase of Central Bank Digital Currency (CBDC) or Tokenized Deposits\n - 2 – Purchase of Stablecoin (fiat-backed)\n - 3 – Purchase of Blockchain Native Token/Coin\n - 4 – Purchase of Non-Fungible Token (NFT)\n - 7* - Purchase of Cryptocurrency\n"
},
"RecipientName": {
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "Full name of recipient. Conditionally required when \"firstName\" and \"lastName\" are not provided. Must not contain exclusively numeric characters. Must not contain special symbols.\n",
"example": "Jane Marie Doe"
},
"OCTRecipientDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "localNameData
This object is used to provide the recipient's local name data. This object is required for transactions where the recipient's local name data is required."
},
"value": {
"$ref": "#/components/schemas/RecipientLocalNameData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "contactInformationList
Contact Information list of recipient.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/ContactInformationList"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "ancillaryRecipientDetails
Ancillary recipient details.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped."
},
"value": {
"$ref": "#/components/schemas/AncillaryRecipientDetails"
}
}
}
]
},
"MerchantCategoryCode": {
"type": "number",
"description": "Four-digit number listed in ISO 18245",
"example": 6012
},
"OCTOriginatorDetail": {
"required": [
"acquirerCountryCode",
"acquiringBin",
"cardAcceptor"
],
"type": "object",
"properties": {
"acquiringBin": {
"$ref": "#/components/schemas/AcquiringBin"
},
"cardAcceptor": {
"$ref": "#/components/schemas/OCTCardAcceptor"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OCTOriginatorDetailAdditionalData"
}
},
"acquirerCountryCode": {
"$ref": "#/components/schemas/AcquirerCountryCode"
}
},
"description": "Originator details for Original Credit Transaction"
},
"OctSenderPaymentCredentialReference": {
"required": [
"type",
"value"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of payment instrument.",
"example": "PCI_TOKEN_REFID",
"enum": [
"PCI_TOKEN_REFID"
]
},
"value": {
"maxLength": 75,
"minLength": 1,
"type": "string",
"description": "The value of the payment instrument. For \"PCI_TOKEN_REFID\", length is 1-75 and must accompany with \"requestorId\".
",
"example": "TOKEN123456789"
},
"requestorId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Conditional
Unique Merchant Identification assigned by Token Service Provider. Only required if type is PCI_TOKEN_REFID.",
"example": "MERCHANT123"
}
},
"description": "External reference to a payment credential"
},
"VerificationCard": {
"required": [
"accountNumber",
"accountNumberType",
"expiryDate"
],
"type": "object",
"properties": {
"cvv2": {
"maxLength": 4,
"minLength": 3,
"type": "string",
"description": "The cvv2Value provided by the account holder",
"example": "123"
},
"tavv": {
"maxLength": 40,
"minLength": 1,
"type": "string",
"description": "Token authentication verification or token cryptogram value provided by the token provider for the card token in the request",
"example": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890ABCD"
},
"expiryDate": {
"maxLength": 7,
"minLength": 7,
"type": "string",
"description": "The expiration date for the primaryAccountNumber in the request",
"example": "2025-12"
},
"merchantId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Required if accountNumberType is PCI_TOKEN",
"example": "MERCHANT001"
},
"accountType": {
"type": "string",
"description": "This is used to identify the account type of the primaryAccountNumber in the request. Default is set to 00 if not provided. 00=Not applicable, 10=Saving account, 20=Checking account, 30=Credit card account, 40=Universal account",
"example": "30",
"default": "00",
"enum": [
"00",
"10",
"20",
"30",
"40"
]
},
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-digit numeric or 3-character alpha ISO currency code for the currency of the card",
"example": "USD 840"
},
"accountNumber": {
"maxLength": 75,
"minLength": 1,
"type": "string",
"description": "The primary account number for which account validations are being performed",
"example": "4111111111111111"
},
"accountNumberType": {
"type": "string",
"description": "Type of account number",
"example": "DEFAULT",
"enum": [
"DEFAULT",
"PCI_TOKEN",
"PAYNAME"
]
}
},
"description": "Card details for Verification check"
},
"NameValuePair": {
"required": [
"name",
"value"
],
"type": "object",
"properties": {
"name": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Name component of the name-value pair for additional data",
"example": "CustomField1"
},
"value": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Value component of the name-value pair for additional data",
"example": "CustomValue1"
}
}
},
"SenderIdentification": {
"type": "object",
"properties": {
"idType": {
"type": "string",
"description": "Type of identification document. Valid types include: CUID (Customer ID), NTID (National ID), PASN (Passport), DRLN (Driver License), TXIN (Tax ID), CPNY (Company ID), PRXY (Proxy ID), SSNB (Social Security Number), ARNB (Alien Registration Number), LAWE (Law Enforcement ID), MILI (Military ID), TRVL (Travel Document), EMAL (Email), PHON (Phone), BTHD (Date of Birth)\n",
"example": "PASN",
"enum": [
"CUID",
"NTID",
"PASN",
"DRLN",
"TXIN",
"CPNY",
"PRXY",
"SSNB",
"ARNB",
"LAWE",
"MILI",
"TRVL",
"EMAL",
"PHON",
"BTHD"
]
},
"idNumber": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Sender identification number (issued by a government or similar authority). Needs to be provided by Originating Entity along with the payment in certain markets.\n",
"example": "A1234567"
},
"idOwnerType": {
"type": "string",
"enum": [
"C",
"I"
]
},
"idIssueCountry": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Sender identification issuing country. Format: 3-digit numeric or 3-character alpha ISO country code.\n",
"example": "840 USA"
}
},
"description": "Sender identification document details"
},
"PayoutId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Unique identifier for the payout transaction"
},
"AFTOriginatorDetail": {
"required": [
"acquirerCountryCode",
"acquiringBin",
"cardAcceptor"
],
"type": "object",
"properties": {
"acquiringBin": {
"$ref": "#/components/schemas/AcquiringBin"
},
"cardAcceptor": {
"$ref": "#/components/schemas/AFTCardAcceptor"
},
"additionalData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AFTOriginatorDetailAdditionalData"
}
},
"acquirerCountryCode": {
"$ref": "#/components/schemas/AcquirerCountryCode"
}
}
},
"AFTTransactionDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "cpsAuthorizationCharacteristicsIndicator
Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).
Note: Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details."
},
"value": {
"maxLength": 1,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "digitalSecureRemotePaymentTokenCryptogram
This field contains Mastercard digital payment/Cryptogram data associated with the token."
},
"value": {
"maxLength": 28,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardUCAFCollectionIndicator
E-commerce indicator that Mastercard Universal Cardholder Authentication data is included in the message."
},
"value": {
"maxLength": 1,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardUCAFField
This field contains Mastercard e-commerce Universal Cardholder Authentication data in encrypted form. It may also contain Mastercard telephone order data"
},
"value": {
"maxLength": 32,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "memberComments
This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider."
},
"value": {
"maxLength": 254,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "vauFlag
Possible values are : Y (replacement occurred). N (No replacements)"
},
"value": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "argentinaNationalServiceData
Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement."
},
"value": {
"$ref": "#/components/schemas/ArgentinaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "colombiaNationalServiceData
Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement"
},
"value": {
"$ref": "#/components/schemas/ColombiaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "mexicoNationalServiceData
Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement."
},
"value": {
"$ref": "#/components/schemas/MexicoNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardWalletIdentifier
This field contains the Wallet Program Data generated by the PayPass Online platform or MasterPass platform"
},
"value": {
"maxLength": 3,
"minLength": 3,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "masterCardAuthenticationData
The first character contains Mastercard 3DS Program Protocol for 3DS. Please refer to the Mastercard specification for a list of valid values.
Next 36 characters contain the directory server transaction ID data"
},
"value": {
"maxLength": 37,
"minLength": 1,
"type": "string"
}
}
}
]
},
"CardEligibilityDetail": {
"required": [
"billingCurrencyCode",
"cardPlatformCode",
"cardTypeCode",
"issuerCountryCode",
"issuerName"
],
"type": "object",
"properties": {
"issuerName": {
"maxLength": 240,
"minLength": 1,
"type": "string",
"description": "Name of the issuing institution",
"example": "VISA TEST BANK"
},
"visaNetwork": {
"required": [
"comboCardRange",
"eligibilities"
],
"type": "object",
"properties": {
"eligibilities": {
"required": [
"crossBorder",
"domestic"
],
"type": "object",
"properties": {
"accountType": {
"type": "string",
"description": "Type of the account",
"example": "CREDIT",
"enum": [
"DEBIT",
"CREDIT"
]
},
"crossBorder": {
"required": [
"payin",
"payout"
],
"type": "object",
"properties": {
"payin": {
"type": "object",
"properties": {
"enabled": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Indicates if cross-border payin is enabled",
"example": "Y"
}
}
},
"payout": {
"required": [
"gambling",
"moneyTransfer",
"nonMoneyTransfer"
],
"type": "object",
"properties": {
"gambling": {
"type": "string",
"description": "Cross-border gambling eligibility",
"example": "NOT_ENABLED",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
},
"moneyTransfer": {
"type": "string",
"description": "Cross-border money transfer eligibility",
"example": "STANDARD",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
},
"authApprovalInd": {
"type": "string",
"description": "Authorization approval indicator for cross-border payouts",
"example": "READY",
"default": "NO_DATA",
"enum": [
"NO_DATA",
"READY",
"OPTIMIZED",
"NON-OPTIMIZED"
]
},
"nonMoneyTransfer": {
"type": "string",
"description": "Cross-border non-money transfer eligibility",
"example": "STANDARD",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
}
}
},
"domestic": {
"required": [
"payin",
"payout"
],
"type": "object",
"properties": {
"payin": {
"type": "object",
"properties": {
"enabled": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Indicates if domestic payin is enabled",
"example": "Y"
}
}
},
"payout": {
"required": [
"gambling",
"moneyTransfer",
"nonMoneyTransfer"
],
"type": "object",
"properties": {
"gambling": {
"type": "string",
"description": "Domestic gambling eligibility",
"example": "NOT_ENABLED",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
},
"moneyTransfer": {
"type": "string",
"description": "Domestic money transfer eligibility",
"example": "FAST_FUNDS",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
},
"nonMoneyTransfer": {
"type": "string",
"description": "Domestic non-money transfer eligibility",
"example": "STANDARD",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
}
}
}
}
}
}
}
},
"description": "Eligibility information for various transaction types"
},
"comboCardRange": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Indicates if the card is a combo card",
"example": "Y"
},
"cardSubTypeCode": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Code identifying the card subtype",
"example": "C"
},
"geoRestrictionInd": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Geographic restrictions indicator",
"example": "0"
},
"prepaidSubTypeCode": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Code identifying the prepaid card subtype",
"example": "PP"
},
"accountCurrencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-character alpha ISO currency code for the card account",
"example": "USD"
}
},
"description": "Visa network eligibility information"
},
"cardTypeCode": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Code identifying the card type",
"example": "C"
},
"nonVisaNetwork": {
"type": "array",
"description": "Non-Visa network eligibility information",
"items": {
"required": [
"eligibilities",
"networkId"
],
"type": "object",
"properties": {
"networkId": {
"type": "integer",
"description": "Identifier for the routing network",
"example": 123
},
"eligibilities": {
"required": [
"crossBorder",
"domestic"
],
"type": "object",
"properties": {
"domestic": {
"required": [
"payin",
"payout"
],
"type": "object",
"properties": {
"payin": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Domestic payin indicator",
"example": "Y"
},
"payout": {
"type": "string",
"description": "Domestic payout eligibility",
"example": "STANDARD",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
}
}
},
"gambling": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Gambling eligibility indicator",
"example": "Y"
},
"crossBorder": {
"required": [
"payin",
"payout"
],
"type": "object",
"properties": {
"payin": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Cross-border payin indicator",
"example": "Y"
},
"payout": {
"type": "string",
"description": "Cross-border payout eligibility",
"example": "STANDARD",
"enum": [
"STANDARD",
"FAST_FUNDS",
"NOT_ENABLED"
]
}
}
}
}
}
}
}
},
"cardPlatformCode": {
"maxLength": 2,
"minLength": 1,
"type": "string",
"description": "Code identifying the card platform",
"example": "P1"
},
"issuerCountryCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-character alpha ISO country code for the card issuer",
"example": "USA"
},
"billingCurrencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3-character alpha ISO currency code for billing",
"example": "USD"
},
"billingCurrencyCodeMinorDigits": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "Number of minor digits in the billing currency",
"example": "2"
}
},
"description": "Details about card eligibility for different transaction types across networks"
},
"AFTRResponseCardAcceptor": {
"type": "object",
"properties": {
"merchantVerificationValue": {
"$ref": "#/components/schemas/MerchantVerificationValue"
}
}
},
"AFTResponseCardVerificationResults": {
"type": "object",
"properties": {
"cavvResultCode": {
"$ref": "#/components/schemas/CavvResultCode"
},
"cvv2ResultCode": {
"$ref": "#/components/schemas/Cvv2ResultCode"
},
"addressVerification": {
"$ref": "#/components/schemas/AddressVerificationResult"
}
}
},
"Cvv2ResultCode": {
"maxLength": 1,
"minLength": 1,
"type": "string",
"description": "CVV2 result code"
},
"CardAcceptorAddress": {
"required": [
"city",
"country"
],
"type": "object",
"properties": {
"city": {
"maxLength": 13,
"minLength": 1,
"type": "string",
"description": "City of the Merchant/Originator."
},
"state": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Conditional
State or province of the Merchant/Originator.
Required if the cardAcceptor:address:country is \"US\" or \"CA\", for all cross border transactions when issuer is in Canada or Australia, and for all MasterCard transactions.
Note: For \"US\" or \"CA\", this field can contain either the full name of the state or the 2 character code of the state. For rest of the countries, if applicable, the field contains the state code of a maximum 6 characters length."
},
"county": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "County",
"example": "County Name"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "ISO Country Code. Refer to ISO Country Code"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Zip/Postal code of the Merchant/Originator.
Required if the cardAcceptor:address:country is \"US\" or \"CA\", for all cross border transactions when issuer is in Canada or Australia, and for all MasterCard transactions.
Note: For \"US\", \"CA\", and US territories (Puerto Rico/Guam/US Virgin Island/American Samoa/Northern Mariana Island), the maximum length of the field is 9 characters. For rest of the countries, the maximum length of the field is 8 characters."
},
"addressLine": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Street Address of merchant/acquirer."
}
}
},
"Fees": {
"type": "object",
"properties": {
"surcharge": {
"$ref": "#/components/schemas/Surcharge"
},
"nationalReimbursementFee": {
"$ref": "#/components/schemas/NationalReimbursementFee"
}
}
},
"MiddleName": {
"maxLength": 35,
"minLength": 2,
"type": "string",
"description": "Middle name of the recipient"
},
"OCTTransactionDetailAdditionalData": {
"anyOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "purchaseIdentifier
This is the invoice number or some other reference for billing purposes.e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up."
},
"value": {
"$ref": "#/components/schemas/PurchaseIdentifier"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "customerReference
Conditional.
This field contains a value that identifies the customer.
This field needs to be populated for Argentina domestic transaction where businessApplicationId is \"PS\"."
},
"value": {
"maxLength": 17,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "secondaryId
secondaryId is used for C2B use case in the CEMEA region where payee initiates the OCT to the payer. The merchant or acquirer may use this field to obtain an Agreement Id in order to process the request."
},
"value": {
"maxLength": 28,
"minLength": 1,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "sourceAmount
Conditional.
Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity."
},
"value": {
"type": "number"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "sourceCurrencyCode
Conditional.
3-digit numeric or 3-character alpha ISO currency code for currency of the sourceAmount field.
Refer to ISO Codes "
},
"value": {
"maxLength": 3,
"minLength": 3,
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "vauFlag
Possible values are : Y (replacement occurred). N (No replacements)"
},
"value": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "argentinaNationalServiceData
Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement."
},
"value": {
"$ref": "#/components/schemas/ArgentinaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "colombiaNationalServiceData
Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement"
},
"value": {
"$ref": "#/components/schemas/ColombiaNationalServiceData"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "mexicoNationalServiceData
Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement."
},
"value": {
"$ref": "#/components/schemas/MexicoNationalServiceData"
}
}
}
]
},
"ApprovalCode": {
"maxLength": 6,
"minLength": 1,
"type": "string",
"description": "Approval code from the processing network",
"example": "12345A"
},
"Contact": {
"type": "object",
"properties": {
"contactType": {
"type": "string",
"enum": [
"PHONE"
]
},
"contactValue": {
"maxLength": 16,
"minLength": 1,
"type": "string"
}
}
},
"AFTResponseCardAcceptor": {
"type": "object",
"properties": {
"merchantVerificationValue": {
"$ref": "#/components/schemas/MerchantVerificationValue"
}
}
},
"RecipientIdentificationNumberIndividual": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Unique identifier for the recipient. This is used to identify the recipient in the system. Conditional - Required in certain markets.\n"
},
"PinData": {
"required": [
"pinBlockFormatCode",
"pinDataBlock"
],
"type": "object",
"properties": {
"pinDataBlock": {
"maxLength": 16,
"minLength": 1,
"type": "string",
"description": "PIN data block",
"format": "binary"
},
"zoneKeyIndex": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Zone key index"
},
"pinBlockFormatCode": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "PIN block format code"
}
}
},
"AFTTransactionFees": {
"type": "object",
"properties": {
"surcharge": {
"$ref": "#/components/schemas/Surcharge"
},
"foreignExchangeFee": {
"$ref": "#/components/schemas/ForeignExchangeFee"
},
"nationalReimbursementFee": {
"$ref": "#/components/schemas/NationalReimbursementFee"
}
}
},
"RecipientLocalNameData": {
"required": [
"encodingFormat",
"languageCode"
],
"type": "object",
"properties": {
"lastName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient's last name in local language."
},
"aliasName": {
"maxLength": 70,
"minLength": 1,
"type": "string",
"description": "Recipient's alias name in local language."
},
"firstName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient's first name in local language."
},
"middleName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "Recipient's middle name in local language."
},
"languageCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "3 characters ISO 639 language code. Example 'heb' for Hebrew."
},
"encodingFormat": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "01 = UTF-8"
}
}
},
"PointOfServiceCapability": {
"required": [
"terminalEntryCapability",
"terminalType"
],
"type": "object",
"properties": {
"terminalType": {
"maximum": 9,
"minimum": 0,
"type": "integer",
"description": "Terminal type"
},
"terminalEntryCapability": {
"maximum": 9,
"minimum": 0,
"type": "integer",
"description": "Terminal entry capability"
},
"acceptsPartialAuthorizations": {
"type": "integer",
"description": "Accepts partial authorizations",
"enum": [
null,
null
]
}
}
},
"AcnvAuthenticationData": {
"type": "object",
"properties": {
"cvv2": {
"maxLength": 4,
"minLength": 1,
"type": "string",
"description": "Card verification value"
},
"tavv": {
"maxLength": 40,
"minLength": 40,
"type": "string",
"description": "Transaction authentication verification value"
}
}
},
"OCTServiceLocationDetails": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/ServiceLocationAddress"
}
},
"description": "Service location details for Original Credit Transaction"
},
"ContactEmail": {
"maxLength": 99,
"minLength": 1,
"type": "string",
"description": "Contact email of the recipient"
},
"IdCode": {
"maxLength": 15,
"type": "string",
"description": "Identification code for the card acceptor",
"example": "VMT123456789"
},
"OriginatorDetailAddress": {
"required": [
"country"
],
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "Originating Entity City",
"example": "SAN FRANCISCO"
},
"state": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Originating Entity State Code. Required if Originating Entity country is US or Canada.",
"example": "CA"
},
"county": {
"type": "string",
"description": "Originating Entity Country Sub Division Minor code",
"example": "ALAMEDA"
},
"country": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Originating Entity country code.",
"example": "USA"
},
"postalCode": {
"maxLength": 10,
"minLength": 5,
"type": "string",
"description": "Originating Entity Postal Code. Required if Originating Entity country is US or Canada.",
"example": "94105"
},
"addressLine": {
"type": "string",
"description": "Originating Entity address line",
"example": "123 MAIN STREET"
},
"originatorId": {
"type": "string",
"description": "An alphanumeric field that uniquely identifies the Originating Entity. For Push to Card transactions, should populate Card Acceptor ID (CAID).",
"example": "ORIG12345678"
},
"originatorName": {
"type": "string",
"description": "The name of the merchant or originating entity sending the payment instruction to Visa.",
"example": "ACME PAYMENTS"
},
"originatorLegalBusinessName": {
"type": "string",
"description": "The legal business name of the merchant or originating entity sending the payment instruction to Visa.",
"example": "ACME CORPORATION INC."
}
},
"description": "Address details of the originator"
},
"GivUpdatedFlag": {
"type": "string",
"description": "Flag indicating if the Guaranteed Issuer Value (GIV) was updated in this transaction",
"example": "N"
},
"AncillarySenderDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "This field identifies if the contact information is for a business or an individual. The valid value are: 'B' for Business and 'I' for Individual."
},
"address": {
"$ref": "#/components/schemas/AncillarySenderDetailAddress"
},
"lastName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "This field contains ancillary sender's last name"
},
"firstName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "This field contains ancillary sender's first name"
},
"middleName": {
"maxLength": 35,
"minLength": 1,
"type": "string",
"description": "This field contains ancillary sender's middle name"
}
}
}
},
"responses": {
"OCTResponse": {
"description": "Successful OCT transaction response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OCTResponseData"
}
}
}
},
"409ErrorResponse": {
"description": "Conflict",
"content": {
"application/problem+json": {}
}
},
"500ErrorResponse": {
"description": "Internal Server Error",
"content": {
"application/problem+json": {}
}
},
"403ErrorResponse": {
"description": "Request is forbidden",
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"properties": {
"errorResponse": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
}
}
}
},
"404ErrorResponse": {
"description": "Resource not found",
"content": {
"application/problem+json": {}
}
},
"429ErrorResponse": {
"description": "Too Many Requests",
"content": {
"application/problem+json": {}
}
},
"401ErrorResponse": {
"description": "Request is unauthorized",
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"properties": {
"errorResponse": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
}
]
}
}
}
}
}
},
"400ErrorResponses": {
"description": "Comprehensive array of errors",
"content": {
"application/problem+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"AFTResponse": {
"description": "Successful AFT transaction response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AFTResponseData"
}
}
}
},
"503ErrorResponse": {
"description": "Service Unavailable",
"content": {
"application/problem+json": {}
}
},
"AFTRResponse": {
"description": "Successful AFT transaction response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AFTRResponseData"
}
}
}
}
},
"parameters": {},
"examples": {},
"requestBodies": {
"OCTRequest": {
"description": "Request body for creating OCT push funds transfer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OCTRequestData"
}
}
},
"required": true
},
"AFTRequest": {
"description": "Request body for creating AFT pull funds transfer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AFTRequestData"
}
}
},
"required": true
},
"AFTRRequest": {
"description": "Request body for creating AFT Reversal",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AFTRRequestData"
}
}
},
"required": true
}
},
"headers": {},
"callbacks": {}
},
"webhooks": {},
"x-tagGroups": [
{
"name": "API Reference",
"tags": [
"Eligibility"
]
}
]
}
```