{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/KennethCool/3D_Secure_V2/1.0.1"},{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/KennethCool/3dsv2MPGS/1.0.1"},{"description":"Development server","url":"https://test4:8000/s3d2/v1"}],"info":{"description":"3DS Version2 Authentication APIs provided by 3DS Requester Server. Currently APIs only support Payment transactions and do not support card maintenaince. Only web browsers are supported while mobile apps are not supported.","version":"1.0.1","title":"3DS Version2 Authentication API","contact":{"email":"techsupport@cardaccess.com.au"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"developers","description":"Operations available to regular developers"}],"paths":{"/brw/init/":{"post":{"summary":"Initialize authentication","description":"Initialize authentication","responses":{"201":{"description":"Initialization result returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitAuthResponse"}}}},"400":{"description":"invalid input, object invalid"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"500":{"description":"Unexpected system error."}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitAuthRequest"}}},"description":"Initialize authentication - determing the 3DS2 version"}}},"/brw/":{"post":{"summary":"Payer Authentication","description":"Payer Authentication","responses":{"201":{"description":"Authentication result returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationResponse"}}}},"400":{"description":"invalid input, object invalid"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"500":{"description":"Unexpected system error."}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthRequest"}}},"description":"Transaction to authenticate"}}},"/retrieve/":{"post":{"description":"Retrieve the details of a transaction","responses":{"201":{"description":"Transaction details returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAuthStatusResponse"}}}},"400":{"description":"invalid input, object invalid"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"500":{"description":"Unexpected system error."}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRequest"}}},"description":"To retrieve transaction status"}}}},"components":{"schemas":{"BaseRequest":{"type":"object","required":["casAggId","casMerId"],"properties":{"casAggId":{"description":"CAS aggregator Id","type":"string","example":"0"},"casMerId":{"type":"string","description":"CAS merchant id","example":"2004"},"isTest":{"type":"boolean","description":"If it is a test request. It is assumed to be False if it is not present."}}},"InitAuthRequest":{"allOf":[{"$ref":"#/components/schemas/BaseRequest"},{"type":"object","required":["transaction"],"properties":{"transaction":{"$ref":"#/components/schemas/InitTransaction"},"order":{"$ref":"#/components/schemas/Order"}}}]},"RootTransaction":{"type":"object","required":["transactionId"],"properties":{"transactionId":{"type":"string","example":"A0987_654321","description":"A unique identifier for this transaction to distinguish it from any other transactions of a merchant. If order.id is present, the combination of order.id and transactionId must be unique per merchant; if order.id is not present, the transactionId must be unique per merchant. It can consist of any characters.","minLength":1,"maxLength":40}}},"BaseTransaction":{"allOf":[{"$ref":"#/components/schemas/RootTransaction"},{"type":"object"}],"description":"Payment transaction.","required":["currency"],"properties":{"currency":{"type":"string","minLength":3,"maxLength":3,"pattern":"^[A-Z]{3}$","example":"AUD","description":"If the currency of the order is provided, this one will be ignored. The currency of the transaction expressed as an ISO 4217 alpha code, e.g. USD"}}},"InitTransaction":{"allOf":[{"$ref":"#/components/schemas/BaseTransaction"},{"type":"object","required":["card"],"properties":{"reference":{"type":"string","description":"Information about this transaction.","minLength":1,"maxLength":40},"authentication":{"$ref":"#/components/schemas/InitAuthentication"},"card":{"$ref":"#/components/schemas/InitCard"}}}]},"InitAuthentication":{"type":"object","required":["indicator"],"properties":{"indicator":{"type":"string","enum":["01","02","03","04","05","06"],"minLength":2,"maxLength":2,"description":"Indicates the type of Authentication request. It is the 3DS Requestor Authentication Indicator per EMV spec as below. If it is not present, the Requester Server will assume it is a Payment transaction. 01 - Payment transaction 02 - Recurring transaction 03 - Instalment transaction 04 - Add card 05 - Maintain card 06 - Cardholder verification as part of EMV token ID","default":"01"}}},"BaseOrder":{"type":"object","description":"It does not have a property of currency since currency is under Transaction.","properties":{"id":{"type":"string","description":"A unique identifier for this order to distinguish it from any other order that the merchant creates. That means it is unique per casMerId. When integration with MPGS, it occurs as the orderid in the MPGS URL. It can consist of any characters.","example":"A0987_654321","minLength":1,"maxLength":40}}},"Order":{"allOf":[{"$ref":"#/components/schemas/BaseOrder"},{"type":"object"}],"properties":{"reference":{"type":"string","description":"The identifier of the order. For example, a shopping cart number, an order number, or an invoice number.","minLength":1,"maxLength":40}}},"OrderSupply":{"description":"For American Express cards, providing more details of the order supply can increase the chances of 3D Secure v2 frictionless flow.","type":"object","properties":{"preorder":{"description":"Indicates that the purchase includes merchandise with a future availability or release date.","type":"boolean","example":false},"preorderAvailabilityDate":{"description":"The date that preordered items are expected to be available. Provide this field if the payer is ordering items before you have them available for purchase.  Data must comply with ISO 8601 extended date format, YYYY-MM-DD.","type":"string","format":"date","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","example":"2021-12-31"},"reorder":{"description":"Indicates that the purchase includes merchandise that the payer has previously ordered.","type":"boolean","example":true}}},"AuthOrder":{"allOf":[{"$ref":"#/components/schemas/BaseOrder"},{"type":"object"}],"properties":{"supply":{"$ref":"#/components/schemas/OrderSupply"}}},"InitCard":{"type":"object","required":["accountNumber"],"properties":{"accountNumber":{"type":"string","description":"Account number that will be used in the authorisation request for payment transactions. It may be represented by PAN, token.","minLength":9,"maxLength":19,"example":"5123450000000008"}}},"Card":{"allOf":[{"$ref":"#/components/schemas/InitCard"},{"type":"object"}],"required":["expiryDate"],"properties":{"expiryDate":{"type":"string","format":"MMYY","pattern":"^\\d{4}$","example":"1021"}}},"Authentication":{"type":"object","required":["redirectResponseUrl"],"properties":{"redirectResponseUrl":{"description":"The URL to which a client wants to redirect the payer after completing the payer authentication process. This will be a URL on a client's website, with the URL encoded as defined in RFC3986. This means special characters such spaces, hyphens, etc must be encoded.","type":"string","pattern":"^https.*","minLength":12,"example":"https://app.cardaccess.com.au"}}},"Browser":{"description":"Detailed information about the payer's browser.","type":"object","required":["userAgent","javaScriptEnabled"],"properties":{"userAgent":{"description":"Required when a payer uses a browser. The User-Agent header of the browser the customer used to place the order.For example, MOZILLA/4.0 (COMPATIBLE; MSIE 5.0; WINDOWS 95). Data can consist of any characters.","type":"string","minLength":1,"maxLength":255,"example":"MOZILLA/4.0"},"challengeWindowSize":{"type":"string","enum":["01","02","03","04","05"],"default":"04","description":"It is per EMV spec as below. If it is not present, the Requester Server will use the configuration of this merchant in the MDS 3DS Product. 01 is 250 x 400 '02' is 390 x 400 '03' is 500 x 600 '04' is 600 x 400 '05' is Full screen"},"acceptHeaders":{"type":"string","minLength":1,"maxLength":2048,"example":"application/json"},"colorDepth":{"type":"integer","format":"int32","minimum":1,"maximum":48},"javaEnabled":{"description":"Indicates whether or not the payer's browser supports Java.","type":"boolean"},"javaScriptEnabled":{"description":"Indicates whether or not the payer's browser supports JavaScript.","type":"boolean"},"language":{"type":"string","minLength":1,"maxLength":8,"example":"en-US"},"screenHeight":{"type":"integer","format":"int32","minimum":1,"maximum":999999,"example":640},"screenWidth":{"type":"integer","format":"int32","minimum":1,"maximum":999999,"example":480},"timeZone":{"type":"integer","format":"int32","example":840},"ipAddress":{"type":"string","minLength":7,"maxLength":15,"example":"127.0.0.1"}}},"Device":{"description":"Information about the device used by the payer for this transaction.","type":"object","required":["browser"],"properties":{"browser":{"$ref":"#/components/schemas/Browser"}}},"AuthTransaction":{"allOf":[{"$ref":"#/components/schemas/BaseTransaction"},{"type":"object"}],"description":"Authentication could be optional but actually a must when interacting with MPGS API. So is Card.","required":["amount","authentication","card","device"],"properties":{"amount":{"type":"number","minimum":0,"maximum":9.999999999999E10,"description":"The amount for the transaction. It is decimal and in dollars.","example":1.99},"authentication":{"$ref":"#/components/schemas/Authentication"},"card":{"$ref":"#/components/schemas/Card"},"device":{"$ref":"#/components/schemas/Device"}}},"Challenge":{"type":"object","properties":{"preference":{"type":"string","enum":["01","02","03","04","09"],"description":"Indicates whether a challenge is requested for this transaction. Its value is per EMV spec as below. If it is not present, the Requester Server will use the configuration value in the MDS 3DS Product of the merchant. 01 No preference 02  No challenge requested 03  Challenge requested (3DS Requestor preference) 04  Challenge requested (Mandate) 05  No challenge requested (transactional risk analysis is already performed) 06  No challenge requested (Data share only) 07  No challenge requested (strong consumer authentication is already performed) 08  No challenge requested (utilise whitelist exemption if no challenge required) 09  Challenge requested (whitelist prompt requested if challenge required)"}}},"ShippingContact":{"type":"object","properties":{"email":{"type":"string","description":"The field format restriction ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses.","example":"aa@bb.com"}}},"Shipping":{"description":"For American Express cards, providing more details of the shipping can increase the chances of 3D Secure v2 frictionless flow.","type":"object","properties":{"contact":{"$ref":"#/components/schemas/ShippingContact"},"method":{"type":"string","enum":["ELECTRONIC","GROUND","NOT_SHIPPED","OVERNIGHT","PICKUP","PRIORITY","SAME_DAY"],"example":"PICKUP"}}},"CustomerAccountHistory":{"type":"object","properties":{"creationDate":{"type":"string","description":"Data must comply with ISO 8601 extended date format, YYYY-MM-DD.","format":"date","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","example":"2021-12-31"},"lastUpdated":{"type":"string","description":"Data must comply with ISO 8601 extended date format, YYYY-MM-DD","format":"date","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","example":"2021-12-31"},"passwordLastChanged":{"type":"string","description":"Data must comply with ISO 8601 extended date format, YYYY-MM-DD","format":"date","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","example":"2021-12-31"},"addCardAttempts":{"type":"integer","minimum":0,"maximum":99},"annualActivity":{"type":"integer","minimum":0,"maximum":999},"recentActivity":{"type":"integer","description":"The number of transactions (successful and abandoned) that have been requested in the last 24 hours for all payment methods stored against this customer account.","minimum":0,"maximum":99},"shippingAddressDate":{"type":"string","description":"Data must comply with ISO 8601 extended date format, YYYY-MM-DD","format":"date","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$","example":"2021-12-31"},"suspiciousActivity":{"type":"boolean","description":"Have you experienced suspicious or fraudulent activity on the account in the past.","example":false}}},"CustomerAccountAuthentication":{"type":"object","properties":{"method":{"description":"The method that a merchant used to authenticate the payer.","type":"string","enum":["CUSTOMER_ACCOUNT_LOGIN","FEDERATED_IDENTITY_LOGIN","FIDO_AUTHENTICATION","ISSUER_ACCOUNT_LOGIN","NONE","THIRD_PARTY_ACCOUNT_LOGIN"]},"time":{"type":"string","format":"date-time","description":"An instant in time expressed in ISO8601 date + time format - \"YYYY-MM-DDThh:mm:ss.SSSZ\"","example":"2021-12-31T23:59:59.000Z"}}},"CustomerAccount":{"type":"object","description":"Providing more details of the customer account can increase the chances of 3D Secure v2 frictionless flow.","properties":{"history":{"$ref":"#/components/schemas/CustomerAccountHistory"},"authentication":{"$ref":"#/components/schemas/CustomerAccountAuthentication"}}},"Customer":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/CustomerAccount"}}},"AuthRequest":{"allOf":[{"$ref":"#/components/schemas/BaseRequest"},{"type":"object"}],"required":["transaction"],"properties":{"transaction":{"$ref":"#/components/schemas/AuthTransaction"},"order":{"$ref":"#/components/schemas/AuthOrder"},"shipping":{"$ref":"#/components/schemas/Shipping"},"customer":{"$ref":"#/components/schemas/Customer"},"challenge":{"$ref":"#/components/schemas/Challenge"}}},"OrderRetrieve":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"A unique identifier for this order to distinguish it from any other order that the merchant creates. That means it is unique per casMerId. When integration with MPGS, it occurs as the orderid in the MPGS URL.","example":"0987654321","minLength":1,"maxLength":40}}},"RetrieveRequest":{"allOf":[{"$ref":"#/components/schemas/BaseRequest"},{"type":"object","required":["transaction"],"properties":{"transaction":{"$ref":"#/components/schemas/RootTransaction"},"order":{"$ref":"#/components/schemas/OrderRetrieve"}}}]},"RedirectOfInitAuth":{"description":"This is used by the issuer's Access Control Server (ACS) to obtain additional information about the payer's browser to assist their risk assessment process. See EMVCo specification for details.","type":"object","required":["methodPostData","methodUrl"],"properties":{"methodPostData":{"description":"Base64 URL encoded frame contents to be posted to the methodUrl. This is used by the issuer's Access Control Server (ACS) to obtain additional information about the payer's browser to assist their risk assessment process. See EMVCo specification for details.","type":"string","format":"byte","minLength":3,"maxLength":1000},"methodUrl":{"description":"The URL provided by the issuer to which you must post the data provided in authentication.3ds2.methodPostData. See EMVCo specification for details.","type":"string","pattern":"^https.*","minLength":12}}},"BaseS3d1":{"type":"object","description":"Information about payer authentication using 3-D Secure authentication version1.","required":["veResEnrolled"],"properties":{"veResEnrolled":{"type":"string","example":"Y","minLength":1,"maxLength":1,"description":"It can be 'Y', 'N' or 'U'."}}},"S3d1":{"allOf":[{"$ref":"#/components/schemas/BaseS3d1"},{"type":"object"}],"description":"Information about payer authentication using 3-D Secure authentication version1.","properties":{"paResStatus":{"type":"string","minLength":1,"maxLength":1,"description":"It can be 'Y', 'N', 'A', or 'U'. Indicates the result of payer authentication with the issuer."}}},"BaseS3d2":{"type":"object","description":"Information about payer authentication using 3-D Secure authentication version2.","properties":{"protocolVersion":{"type":"string","example":"2.1.0","minLength":1,"maxLength":20,"description":"The version of the EMV 3-D Secure protocol used to perform 3-D Secure authentication, in the format specified by EMVCo."},"methodSupported":{"type":"string","example":"SUPPORTED","description":"Indicates if the issuer's Access Control Server (ACS) support the method call."}}},"S3d2":{"allOf":[{"$ref":"#/components/schemas/BaseS3d2"},{"type":"object"}],"description":"Information about payer authentication using 3-D Secure authentication version2.","properties":{"transactionStatus":{"type":"string","minLength":1,"maxLength":1,"example":"C","description":"Indicates the result of payer authentication with the issuer. This is the value returned in the transaction status field from the issuer Access Control Server (ACS). Refer to the EMVCo specification for 3-D Secure. For example, 'Y', 'C', 'N', 'U', 'A', 'R'. 'Y' or 'A' - frictionless flow; 'C' - challenge flow. 'Y' - successful. 'R' - rejected. 'A' - attempted."},"statusReasonCode":{"type":"string","minLength":2,"maxLength":2,"example":"04","description":"Conditional. A code indicating the reason for the transaction status returned in authentication.3ds2.transactionStatus. Refer to the EMVCo specification for 3-D Secure.  You must provide this when authentication.3ds2.transactionStatus returns 'N', 'U', or 'R'. It is transStatusReason in EMV spec."},"3dsServerTransactionId":{"type":"string","minLength":1,"maxLength":50,"example":"8c4a911c-289a-46c2-a615-887e1cc01a6a","description":"The field contains the unique identifier assigned by the 3DS Server for this authentication. This is referred to in the EMVCo specification for 3-D Secure as threeDSServerTransID."},"acsTransactionId":{"type":"string","minLength":36,"maxLength":36,"description":"A unique transaction identifier assigned by the Access Control Server to identify the 3DS transaction.","example":"03f80096-fe69-4f96-9491-50b504802e00"},"directoryServerId":{"type":"string","minLength":10,"maxLength":10,"description":"Unique identifier for the Directory Server (also called Registered Application Provider Identifier or RID). Registered Application Provider Identifier (RID) that is unique to the Payment System. RIDs are defined by the ISO 7816-5 standard.","example":"A999999999"},"requestorId":{"type":"string","minLength":1,"maxLength":35,"description":"The unique identifier assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer. Do not provide this value for Mastercard SecureCode or Verified by Visa, For these authentication schemes, it will be generated by the gateway.","example":"MAS00001_INT_MPGS_MTTESTCASKW"},"requestorName":{"type":"string","minLength":1,"maxLength":40,"description":"The unique name assigned to the merchant by the card scheme directory server when the merchant registered to use 3-D Secure authentication version 2 with their acquirer. Do not provide this value for Mastercard SecureCode or Verified by Visa, For these authentication schemes, it will be generated by the gateway.","example":"CAS Kw test"}}},"RootAuthenticationOfResponse":{"type":"object","properties":{"authenticationStatus":{"type":"string","enum":["AUTHENTICATION_ATTEMPTED","AUTHENTICATION_AVAILABLE","AUTHENTICATION_EXEMPT","AUTHENTICATION_FAILED","AUTHENTICATION_NOT_IN_EFFECT","AUTHENTICATION_NOT_SUPPORTED","AUTHENTICATION_PENDING","AUTHENTICATION_REJECTED","AUTHENTICATION_REQUIRED","AUTHENTICATION_SUCCESSFUL","AUTHENTICATION_UNAVAILABLE"],"example":"AUTHENTICATION_AVAILABLE","description":"When integration with MPGS, the values are defined by the authenticationstatus field of MPGS APIs. More detailed definitions are as below, which come from the MPGS APIs. 'AUTHENTICATION_ATTEMPTED' Payer authentication was attempted and a proof of authentication attempt was obtained. 'AUTHENTICATION_AVAILABLE' Payer authentication is available for the payment method provided. When it occurs in the /brw/init/ response, it means the card is 3DS v1 or 3DS v2 enrolled. 'AUTHENTICATION_EXEMPT' Exemption from the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area has been claimed or granted. 'AUTHENTICATION_FAILED' The payer was not authenticated. You should not proceed with this transaction. 'AUTHENTICATION_NOT_IN_EFFECT' There is no authentication information associated with this transaction. 'AUTHENTICATION_NOT_SUPPORTED' The requested authentication method is not supported for this payment method. 'AUTHENTICATION_PENDING' Payer authentication is pending completion of a challenge process. When it occurs in the /brw/ response, it means a 3DS v2 challenge flow, or 3DS v1 fallback. 'AUTHENTICATION_REJECTED' The issuer rejected the authentication request and requested that you do not attempt authorization of a payment. 'AUTHENTICATION_REQUIRED' Payer authentication is required for this payment, but was not provided. 'AUTHENTICATION_SUCCESSFUL' The payer was successfully authenticated. When it occurs in the /brw/ response, it means a frictionless flow. 'AUTHENTICATION_UNAVAILABLE' The payer was not able to be authenticated due to a technical or other issue."}}},"BaseAuthenticationOfResponse":{"allOf":[{"$ref":"#/components/schemas/RootAuthenticationOfResponse"},{"type":"object"}],"properties":{"redirectHtml":{"description":"A collection of parameters required to produce the UI for payer authentication. It includes HTML and JavaScript, which can be put on a cardholder's payment page. In the response of /brw/init/ it is to provide the issuer's Access Control Server (ACS) additional information about the payer's browser to assist their risk assessment process. In the response of /brw it is the redirection UI of the payer's browser to the issuer's Access Control Server (ACS) for 3-D Secure authentication. A client has two choices. He can use this which is simple, or use the raw parameters in the RedirectOfInitAuth or RedirectOfAuthResponse in a customiszed way.","type":"string","minLength":0,"maxLength":40960}}},"AuthenticationOfInitAuthResponse":{"allOf":[{"$ref":"#/components/schemas/BaseAuthenticationOfResponse"},{"type":"object"}],"description":"s3d2 will be present if the card is enrolled in 3DS V2. s3d1 will be present if the card is enrolled in 3DS V1.","properties":{"redirect":{"$ref":"#/components/schemas/RedirectOfInitAuth"},"s3d1":{"$ref":"#/components/schemas/BaseS3d1"},"s3d2":{"$ref":"#/components/schemas/BaseS3d2"}}},"Error":{"type":"object","description":"Information on possible error conditions that may occur while processing an operation using the API. If it is present, the other fileds including gatewayCode, gatewayRecommendation, authentication can be not present.","properties":{"cause":{"type":"string","example":"INVALID_REQUEST","description":"The value can be the one returned from S3D server, or generated by S3D requester server. Possible values - 'INVALID_REQUEST' The request was rejected because it did not conform to the API protocol. 'REQUEST_REJECTED' The request was rejected due to security reasons such as firewall rules, expired certificate, etc. 'SERVER_BUSY' The server did not have enough resources to process the request at the moment. 'SERVER_FAILED' There was an internal system failure 'SERVER_CONNECTION_ERROR'. 'SERVER_TIMEOUT'. 'FAIL_RESPONSE' 'INVALID_RESPONSE' 'INVALID_JSON_RESPONSE'"}}},"Response":{"type":"object","required":["result"],"description":"If the property error is present, the other optional fields will not be present.","properties":{"result":{"type":"string","enum":["FAILURE","PENDING","SUCCESS","UNKNOWN","ERROR","ABNORMAL"],"example":"SUCCESS","description":"A system-generated high level overall result of the operation. 'FAILURE' - The operation was declined or rejected by the 3DS server, acquirer or issuer 'PENDING' - The operation is currently in progress or pending processing 'SUCCESS' - The operation was successfully processed 'UNKNOWN' - The result of the operation is unknown 'ABNORMAL' - The fields of the operation result are not consistent per 3DS server specifications."},"gatewayCode":{"description":"Summary of the success or otherwise of the operation. When integrating with MPGS, the values are defined by the gatewaycode field of MPGS APIs.","type":"string","enum":["ABORTED","ACQUIRER_SYSTEM_ERROR","APPROVED","APPROVED_AUTO","APPROVED_PENDING_SETTLEMENT","AUTHENTICATION_FAILED","AUTHENTICATION_IN_PROGRESS","BALANCE_AVAILABLE","BALANCE_UNKNOWN","BLOCKED","CANCELLED","DECLINED","DECLINED_AVS","DECLINED_AVS_CSC","DECLINED_CSC","DECLINED_DO_NOT_CONTACT","DECLINED_INVALID_PIN","DECLINED_PAYMENT_PLAN","DECLINED_PIN_REQUIRED","DEFERRED_TRANSACTION_RECEIVED","DUPLICATE_BATCH","EXCEEDED_RETRY_LIMIT","EXPIRED_CARD","INSUFFICIENT_FUNDS","INVALID_CSC","LOCK_FAILURE","NOT_ENROLLED_3D_SECURE","NOT_SUPPORTED","NO_BALANCE","PARTIALLY_APPROVED","PENDING","REFERRED","SUBMITTED","SYSTEM_ERROR","TIMED_OUT","UNKNOWN","UNSPECIFIED_FAILURE"],"example":"AUTHENTICATION_IN_PROGRESS"},"gatewayRecommendation":{"type":"string","enum":["ATTEMPT_WITH_AUTHENTICATION","DO_NOT_PROCEED","PROCEED"],"description":"The value is returned from S3D server. When integrating with MPGS, the values are defined by the gatewayRecommendation field of MPGS APIs. 'PROCEED' - Proceed with the next step in processing this payment by either Authenticating the payer using the Authenticate Payer operation, or Submitting the payment request as the payer is sufficiently authenticated, or updating card details. 'DO_NOT_PROCEED' - Do not proceed using this card. This will be presented if the gateway fails the request, but there is no apparent way for this transaction to succeed.","example":"PROCEED"},"error":{"$ref":"#/components/schemas/Error"}}},"InitAuthResponse":{"allOf":[{"$ref":"#/components/schemas/Response"},{"type":"object"}],"properties":{"authentication":{"$ref":"#/components/schemas/AuthenticationOfInitAuthResponse"}}},"RedirectOfAuthResponse":{"type":"object","required":["acsUrl","cReq"],"properties":{"acsUrl":{"type":"string","pattern":"^https.*","minLength":12},"cReq":{"type":"string","format":"byte","minLength":0,"maxLength":4000}}},"AuthenticationOfResponse":{"allOf":[{"$ref":"#/components/schemas/BaseAuthenticationOfResponse"},{"type":"object"}],"description":"s3d2 will be present if the card is enrolled in 3DS V2. s3d1 will be present if the card is enrolled in 3DS V1.","properties":{"acsEci":{"type":"string","minLength":1,"maxLength":2},"authenticationValue":{"type":"string","format":"byte","minLength":28,"maxLength":32,"description":"Allowed length 28 or 32"},"dsTransactionId":{"type":"string","minLength":1,"maxLength":50,"description":"A unique identifier for the 3-D Secure authentication transaction.For 3DS version 1, this field corresponds to the XID. The XID is an identifier generated by the gateway on behalf of the merchant. For 3DS version 2, this field corresponds to the identifier assigned by the scheme directory server."},"s3d1":{"$ref":"#/components/schemas/S3d1"},"s3d2":{"$ref":"#/components/schemas/S3d2"}}},"AuthenticationOfAuthResponse":{"allOf":[{"$ref":"#/components/schemas/AuthenticationOfResponse"},{"type":"object"}],"properties":{"redirect":{"$ref":"#/components/schemas/RedirectOfAuthResponse"}}},"AuthenticationResponse":{"allOf":[{"$ref":"#/components/schemas/Response"},{"type":"object"}],"properties":{"authentication":{"$ref":"#/components/schemas/AuthenticationOfAuthResponse"}}},"TransactionOfRetrieveResponse":{"type":"object"},"RetrieveAuthStatusResponse":{"allOf":[{"$ref":"#/components/schemas/Response"},{"type":"object"}],"properties":{"authentication":{"$ref":"#/components/schemas/AuthenticationOfResponse"},"transaction":{"$ref":"#/components/schemas/TransactionOfRetrieveResponse"}}}},"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"responses":{"UnauthorizedError":{"description":"Authentication information is missing or invalid","headers":{"WWW_Authenticate":{"schema":{"type":"string"}}}}}},"security":[{"basicAuth":[]}]}