{"openapi":"3.0.2","info":{"version":"23.2.0","title":"Payments API Reference","description":"The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://natwestpayments-api-docs.readme.io/docs/overview.","termsOfService":"https://www.tylbynatwest.com/website-terms"},"servers":[{"url":"https://prod.emea.api.fiservapps.com/sandbox/ipp/payments-gateway/v2","description":"Sandbox Environment"},{"url":"https://prod.emea.api.fiservapps.com/ipp/payments-gateway/v2","description":"Production Environment"}],"tags":[{"name":"Authentication","description":"Authentication"},{"name":"Payment","description":"Payment"},{"name":"Order","description":"Order"},{"name":"Payment Schedules","description":"Payment Schedules"},{"name":"Payment Token","description":"Payment Token"},{"name":"Verification","description":"Verification"},{"name":"Information Lookup","description":"Information Lookup"}],"paths":{"/payments":{"post":{"tags":["Payment"],"security":[{"Api-Key":[]}],"x-proxy-name":"Create Primary Transaction","summary":"Generate a primary transaction","description":"Use this to originate a financial transaction like a sale, preauthorization, or credit.","operationId":"submitPrimaryTransaction","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/MessageAuthenticationValueParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrimaryTransactionGroup"},"examples":{"PaymentCardSaleTransaction":{"summary":"PaymentCardSaleTransaction","value":{"requestType":"PaymentCardSaleTransaction","transactionAmount":{"total":12.04,"currency":"GBP"},"paymentMethod":{"paymentCard":{"number":"5424180279791732","securityCode":"977","expiryDate":{"month":"12","year":"24"}}},"storedCredentials":{"sequence":"FIRST","scheduled":true}}},"PaymentCardPreAuthTransaction":{"summary":"PaymentCardPreAuthTransaction","value":{"requestType":"PaymentCardPreAuthTransaction","transactionAmount":{"total":12.04,"currency":"GBP"},"paymentMethod":{"paymentCard":{"number":"5424180279791732","securityCode":"977","expiryDate":{"month":"12","year":"24"}}},"splitShipment":{"totalCount":1,"finalShipment":true},"incrementalFlag":false}},"PaymentCardPayerAuthTransaction":{"summary":"PaymentCardPayerAuthTransaction","value":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentCardPayerAuthTransaction","paymentMethod":{"paymentCard":{"number":"5424180279791732","securityCode":"977","expiryDate":{"month":"12","year":"24"}}}}},"PaymentTokenPreAuthTransaction":{"summary":"PaymentTokenPreAuthTransaction","value":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentTokenPreAuthTransaction","paymentMethod":{"paymentToken":{"value":"1235325235236","function":"DEBIT","securityCode":"977"}},"splitShipment":{"totalCount":1,"finalShipment":true}}},"PaymentTokenSaleTransaction":{"summary":"PaymentTokenSaleTransaction","value":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentTokenSaleTransaction","paymentMethod":{"paymentToken":{"value":"1235325235236","function":"DEBIT","securityCode":"977"}},"storedCredentials":{"sequence":"FIRST","scheduled":true}}},"WalletSaleTransaction":{"summary":"WalletSaleTransaction","value":{"requestType":"WalletSaleTransaction","transactionAmount":{"total":23,"currency":"GBP"},"walletPaymentMethod":{"walletType":"EncryptedApplePayWalletPaymentMethod","encryptedApplePay":{"data":"NdCmVw5nMjQq746HYc/VbiZcQZ/zFzeEcM1wVMPruEG4/C/EFhobSkwB5JZJU+t6JuDVXUBiRYuOOC8FTYd+qIm6ckktid9aiGh0f2NDP0INSr59QXmr389RonyUfRYKnBmwsh5UqtI7Iz0AmMtl1PWMdxcCewtjuffs79ahTnFgXsRN+ynuhyDfbdRanlTnYKGoTeVh9eJfheJ1wquO+jiGj+npJ/Oh9bAdlw7iEHrYO2aUkgaMyXZ3foXRAJeimQVQS1y8lU1PPq62zpPrFzidbnnU5fK25pvGFjOdmLsBELZPk5thQEkSaA9p1LSKzWSesHhi0BxZaFPXSA6ANXvYIU2AT0lG+0O0w1URA5Sinyj3YDZVqjuir6rzNN9bB2U2nTQnKMbuGLMS20K8fUKZN/YLJh+AtE6J69+VVSU95mE1nOb8hyabz6E5RmnC5Ze2k6F/hQ75ig==","header":{"applicationDataHash":"94ee059335e587e501cc4bf90613e0814f00a7b08bc7c648fd865a2af6a22cc2","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiaU1SbkYTJy/j5L1t51vtGDh4KlNl5MFPWzo/C8r0WcrktWriz5pdRaDVUDvU++KlDu2iuQsd2xSNKJlFscbDQ==","publicKeyHash":"YmSWN7lj4+A6fVJVPicP8TgS7gI7ougD8rEWB5LXtMM=","transactionId":"31323334353637"},"signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIB0zCCAXkCAQEwCQYHKoZIzj0EATB2MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTkoxFDASBgNVBAcMC0plcnNleSBDaXR5MRMwEQYDVQQKDApGaXJzdCBEYXRhMRIwEAYDVQQLDAlGaXJzdCBBUEkxGzAZBgNVBAMMEmQxZHZ0bDEwMDAuMWRjLmNvbTAeFw0xNTA3MjMxNjQxMDNaFw0xOTA3MjIxNjQxMDNaMHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErnHhPM18HFbOomJMUiLiPL7nrJuWvfPy0Gg3xsX3m8q0oWhTs1QcQDTT+TR3yh4sDRPqXnsTUwcvbrCOzdUEeTAJBgcqhkjOPQQBA0kAMEYCIQDrC1z2JTx1jZPvllpnkxPEzBGk9BhTCkEB58j/Cv+sXQIhAKGongoz++3tJroo1GxnwvzK/Qmc4P1K2lHoh9biZeNhAAAxggFUMIIBUAIBATB7MHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tAgEBMA0GCWCGSAFlAwQCAQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTUwODEyMTczMTAwWjAvBgkqhkiG9w0BCQQxIgQgJyjKLiGQo3I1ZbfHSmF2XCZ8dNlcZyohziuXO48EKwgwCgYIKoZIzj0EAwIESDBGAiEAznKDYEz9MsC+r1g6e4LR1DTaQOl+X2rVNkWnKDpc1EQCIQCmK48ChHoz4HWnUnW5XqaGWOUXKHQvUgeqFr/jgBUzegAAAAAAAA==","applicationData":"VEVTVA==","merchantId":"order-1","version":"EC_v1"}},"paymentFacilitator":{"externalMerchantId":"12345","paymentFacilitatorId":"123123123","saleOrganizationId":"123124214","name":"First Reseller","subMerchantData":{"mcc":"1432","legalName":"First Merchant","timezone":"Europe/London","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"},"document":{"type":"NATIONAL_IDENTITY","number":"12345666544"},"merchantId":"12435325235","merchantVerificationValue":1122}}}},"WalletPreAuthTransaction":{"summary":"WalletPreAuthTransaction","value":{"requestType":"WalletPreAuthTransaction","transactionAmount":{"total":23,"currency":"GBP"},"walletPaymentMethod":{"walletType":"EncryptedGooglePayWalletPaymentMethod","encryptedGooglePay":{"data":{"encryptedMessage":"8nxjB9mr2tWZeDRQRcGN91UUnb7AioGp3oRo8kmQ6lyvJZiqD7PJlbRCYElNqUmr6Z8zK7b2gO9MKOjpnTCqH0qAe2vuIlwNXB60M2Lh7Qfl3bVgWzwF/FfFcenVW381hoItYi8AjWnWoydz1XMTEv2qhqUG03mEnRXdMyDyk6KKZXoW8Qc0p1F1thbxxu8weU8CZbZsWGGTjB42cilIqLVbribcOAG8Oas1AcgefFsu2hwp4gdSuOg7wmeSV7XKsGQzzVy85qtjuqET2XYzJE3K/Wh9QKkhu5P9Ms5s1+Smr2IjRyidqQa88SxQplrVoo9+PvT0bxFcMspBmO3pLkuaZSUBy++dL2fefcxNJvGCFfFhdxW9DojuuQxgpeu7RAQUsGLyFmr/4ZfBxt882xTmpX9MRx5CAudl9qUgBfKdwWwMX35qSbDTm1ju5XXzNh94VebjD3bB9Zj8qgbmUOr/+6OQLhoFJyBCXgx3EEH8hBwNVFrss/SLwQvFhZh62eO6lOtnmbOtP1yTDDVqGDBfai5SwAmM+KTcc9SGv/xDC+cWe8ck+aCBkG4HoRPapUVMZ3JIgV7yzTsVLJE\\\\u003d\\\\","ephemeralPublicKey":"BGH3fRFdoAobYrAlxnZOCYzkH84Cna92IZxtgsU36CMDaqSaDYb9/LsY8qw+vMtlBnwsUg/YVMOeeKp+qDkOWb4\\\\u003d\\\\","tag":"nvmOUNpnOTZULLhMxT/hWCHzH/4f7gGpfvQgwl3p8ng\\\\u003d\\\\"},"intermediateSigningKey":{"signedKey":{"keyValue":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/1+3HBVSbdv+j7NaArdgMyoSAM43yRydzqdg1TxodSzA96Dj4Mc1EiKroxxunavVIvdxGnJeFViTzFvzFRxyCw\\u003d\\u003d","keyExpiration":123581321345589},"signatures":["MEYCIQDcXCoB4fYJF3EolxrE2zB+7THZCfKA7cWxSztKceXTCgIhAN/d5eBgx/1A6qKBdH0IS7/aQ7dO4MuEt26OrLCUxZnl"]},"signature":"MEUCIFWTRWUZAOM5nfJC79FtJm56olnbwG4H5uWWxAUWAquiAiEA24j/BcOroeISsdJzYsyoVi8wzu4tnmKw+jdsGfuvPko=","version":"ECv1"}},"splitShipment":{"totalCount":1,"finalShipment":true},"incrementalFlag":false}}}}},"description":"Accepted request types: PaymentCardCreditTransaction, PaymentCardForcedTicketTransaction, PaymentCardSaleTransaction, PaymentCardPreAuthTransaction, PaymentCardPayerAuthTransaction,  PaymentTerminalSaleTransaction, PaymentTerminalCreditTransaction, PaymentTerminalPreAuthTransaction, PaymentTokenCreditTransaction, PaymentTokenPreAuthTransaction, PaymentTokenSaleTransaction, SepaSaleTransaction, SepaCreditTransaction, WalletSaleTransaction, and WalletPreAuthTransaction.","required":true},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}}},"/payments/{transaction-id}":{"get":{"tags":["Payment"],"security":[{"Api-Key":[]}],"x-proxy-name":"Transaction Inquiry","summary":"Retrieve the state of a transaction.","description":"Use this query to get the current state of an existing transaction.","operationId":"transactionInquiry","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/TransactionIdParam"},{"$ref":"#/components/parameters/StoreIdParam"}],"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}},"patch":{"tags":["Payment"],"security":[{"Api-Key":[]}],"x-proxy-name":"Finalize Secure Transaction","operationId":"finalizeSecureTransaction","summary":"Update a payment and continue processing","description":"Use this to handle a redirect response, updating the transaction and continuing processing.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/TransactionIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationUpdateRequestGroup"}}},"required":true,"description":"Accepted request types: Secure3DInitiateRequest, Secure3DAuthenticationUpdateRequest, Secure3D10AuthenticationUpdateRequest and Secure3D21AuthenticationUpdateRequest."},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}},"post":{"tags":["Payment"],"security":[{"Api-Key":[]}],"x-proxy-name":"Secondary Transaction","summary":"Perform a secondary transaction","description":"Use this to perform a  subsequent transaction, e.g. void, postAuth or return.","operationId":"submitSecondaryTransaction","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/TransactionIdParam"},{"$ref":"#/components/parameters/StoreIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/SecondaryTransaction"},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}}},"/payments/action/{transaction-id}":{"patch":{"tags":["Payment"],"security":[{"Api-Key":[]}],"x-proxy-name":"Perform an update on an existing Transaction","operationId":"submitUpdateTransaction","summary":"Perform update on an existing transaction","description":"Perform an update on an existing transaction. This function is only applicable for an existing preAuth transaction.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/TransactionIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransaction"}}},"required":true},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}}},"/payments/apm/{transaction-id}":{"post":{"tags":["Payment APM"],"security":[{"Api-Key":[]}],"x-proxy-name":"Submit Action","summary":"Perform an apm action","description":"Use this to perform an action on an existing transaction.","operationId":"submitApmAction","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/TransactionIdParam"},{"$ref":"#/components/parameters/StoreIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}}},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TransactionResponse"},{"$ref":"#/components/schemas/OrderResponse"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}},"patch":{"tags":["Payment APM"],"security":[{"Api-Key":[]}],"x-proxy-name":"Perform an action on an existing Transaction","operationId":"submitApmUpdateTransaction","summary":"Perform action on existing APM transaction","description":"Perform an action on an existing APM transaction.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/TransactionIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransaction"}}},"required":true},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}}},"/orders/{order-id}":{"post":{"tags":["Order"],"security":[{"Api-Key":[]}],"x-proxy-name":"Order-Based Secondary Transactions","summary":"Perform return or postAuth secondary transactions","description":"Use this to perform a subsequent transaction, e.g. postAuth or return using an order ID as a reference.","operationId":"submitSecondaryTransactionFromOrder","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/OrderIdParam"}],"requestBody":{"$ref":"#/components/requestBodies/SecondaryTransaction"},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/TransactionGatewayDeclined"},"422":{"$ref":"#/components/responses/TransactionEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}},"get":{"tags":["Order"],"security":[{"Api-Key":[]}],"x-proxy-name":"Order Inquiry","summary":"Retrieve the state of an order","description":"Use this query to get the current state of an existing order.","operationId":"orderInquiry","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/OrderIdParam"},{"$ref":"#/components/parameters/StoreIdParam"}],"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"},"502":{"$ref":"#/components/responses/EndpointCommunicationError"}}}},"/payment-schedules":{"post":{"tags":["Payment Schedules"],"security":[{"Api-Key":[]}],"x-proxy-name":"Schedule Creation","summary":"Create gateway payment schedule","description":"Use this to create a payment schedule managed by the gateway.","operationId":"createPaymentSchedule","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"}],"requestBody":{"$ref":"#/components/requestBodies/PaymentSchedulesRequest"},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSchedulesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"The attempted action is not valid according to gateway rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSchedulesErrorResponse"}}}},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"description":"The endpoint declined the transaction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSchedulesErrorResponse"}}}},"500":{"$ref":"#/components/responses/ServerError"}}}},"/payment-schedules/{order-id}":{"get":{"tags":["Payment Schedules"],"security":[{"Api-Key":[]}],"x-proxy-name":"Schedule Inquiry","summary":"View a gateway payment schedule","description":"Use this to view details of a payment schedule managed by the gateway.","operationId":"inquiryPaymentSchedule","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/OrderIdParam"},{"$ref":"#/components/parameters/StoreIdParam"}],"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecurringPaymentDetailsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"500":{"$ref":"#/components/responses/ServerError"}}},"delete":{"tags":["Payment Schedules"],"security":[{"Api-Key":[]}],"x-proxy-name":"Schedule Cancel","summary":"Cancel a gateway payment schedule","description":"Use this to cancel a payment schedule managed by the gateway.","operationId":"cancelPaymentSchedule","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/OrderIdParam"},{"$ref":"#/components/parameters/StoreIdParam"}],"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSchedulesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/GatewayDeclined"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"422":{"$ref":"#/components/responses/EndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"}}},"patch":{"tags":["Payment Schedules"],"security":[{"Api-Key":[]}],"x-proxy-name":"Schedule Update","summary":"Update a gateway payment schedule","description":"Use this to update a payment schedule managed by the gateway.","operationId":"updatePaymentSchedule","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/OrderIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSchedulePatchRequestGroup"}}}},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSchedulesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/GatewayDeclined"},"422":{"$ref":"#/components/responses/EndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/payment-tokens":{"post":{"tags":["Payment Token"],"security":[{"Api-Key":[]}],"x-proxy-name":"Token Creation","operationId":"createPaymentToken","summary":"Create a payment token from a payment card","description":"Use this to create a payment token to safely store sensitive credit card information.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/AccessTokenParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenizationRequestGroup"}}},"required":true,"description":"Accepted request types: PaymentCardPaymentTokenizationRequest, PaymentDevicePaymentTokenizationRequest, and ReferencedOrderPaymentTokenizationRequest."},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenizationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/PaymentTokenizationGatewayDeclined"},"422":{"$ref":"#/components/responses/PaymentTokenizationEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"}}},"patch":{"tags":["Payment Token"],"security":[{"Api-Key":[]}],"x-proxy-name":"Token Update","operationId":"updatePaymentToken","summary":"Update one or more payment tokens","description":"Use this update one or more payment tokens.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/AccessTokenParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCardPaymentTokenUpdateRequest"}}},"required":true,"description":"Accepted request type: PaymentCardPaymentTokenUpdateRequest."},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenUpdateResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/PaymentTokenizationGatewayDeclined"},"422":{"$ref":"#/components/responses/PaymentTokenizationEndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/payment-tokens/{token-id}":{"get":{"tags":["Payment Token"],"security":[{"Api-Key":[]}],"x-proxy-name":"Get Token Source Details","operationId":"getPaymentTokenDetails","summary":"Get payment card details associated with token","description":"Get payment card details associated with token.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/AccessTokenParam"},{"$ref":"#/components/parameters/TokenIdParam"},{"$ref":"#/components/parameters/StoreIdParam"},{"$ref":"#/components/parameters/PaymentMethodTypeParam"}],"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenizationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}},"delete":{"tags":["Payment Token"],"security":[{"Api-Key":[]}],"x-proxy-name":"Token Deletion","operationId":"deletePaymentToken","summary":"Delete a payment token","description":"Use this to delete a payment token.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"},{"$ref":"#/components/parameters/AccessTokenParam"},{"$ref":"#/components/parameters/TokenIdParam"},{"$ref":"#/components/parameters/StoreIdParam"},{"$ref":"#/components/parameters/PaymentMethodTypeParam"}],"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenizationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/card-verification":{"post":{"tags":["Verification"],"security":[{"Api-Key":[]}],"x-proxy-name":"Card Verification","operationId":"verifyCard","summary":"Verify a payment card","description":"Use this to perform card verification for a payment card. Use the account-verification endpoint instead for this request.","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardVerificationRequest"}}},"required":true,"description":"Accepted request type: CardVerificationRequest."},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/GatewayDeclined"},"422":{"$ref":"#/components/responses/EndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/account-verification":{"post":{"tags":["Verification"],"security":[{"Api-Key":[]}],"x-proxy-name":"Account Verification","operationId":"verifyAccount","summary":"Verify a payment card or payment token","description":"Use this to perform an account verification for a payment card or payment token","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountVerificationRequestGroup"}}},"required":true,"description":"Accepted request type: PaymentCardVerificationRequest and PaymentTokenVerificationRequest."},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/GatewayDeclined"},"422":{"$ref":"#/components/responses/EndpointDeclined"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/card-information":{"post":{"tags":["Information Lookup"],"security":[{"Api-Key":[]}],"x-proxy-name":"Card Info Lookup","summary":"Card Information Lookup","description":"Use this to look up card related information such as issuer country, card function and card brand.","operationId":"cardInfoLookup","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardInfoLookupRequest"}}},"description":"Accepted request type: CardInfoLookupRequest.","required":true},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardInfoLookupResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}},"/account-information":{"post":{"tags":["Information Lookup"],"security":[{"Api-Key":[]}],"x-proxy-name":"Account Info Lookup","summary":"Account Information Lookup","description":"Use this to look up card related information associated with a payment card or payment token.","operationId":"lookupAccount","parameters":[{"$ref":"#/components/parameters/ContentTypeParam"},{"$ref":"#/components/parameters/ClientRequestIdParam"},{"$ref":"#/components/parameters/ApiKeyParam"},{"$ref":"#/components/parameters/TimestampParam"},{"$ref":"#/components/parameters/MessageSignatureParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountInfoLookupRequestGroup"}}},"description":"Accepted request type: PaymentCardInfoLookupRequest and PaymentTokenInfoLookupRequest","required":true},"responses":{"200":{"description":"Success response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardInfoLookupResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"403":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"securitySchemes":{"Api-Key":{"name":"Api-Key","type":"apiKey","in":"header","description":"Authorization value in header (obtain from developer portal)"}},"parameters":{"ContentTypeParam":{"name":"Content-Type","schema":{"type":"string","enum":["application/json"],"default":"application/json"},"in":"header","required":true,"description":"Content type."},"ClientRequestIdParam":{"name":"Client-Request-Id","schema":{"type":"string"},"in":"header","required":true,"description":"A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format."},"MessageAuthenticationValueParam":{"name":"Message-Authentication-Value","schema":{"type":"string"},"in":"header","description":"The Message Authentication Value (MAC) is optional header and it is only required for Card Present transactions or transactions originated from Terminals. The OpenAPI Header parameter format for the message authentication value of the complete payload follows the pattern <MAC>;<derivation algo>;<mac algo>;<key index>[;<key name>][;<key version>].\n1. Derivation Algo: This refers to the algorithm used for key derivation. The options are 'DUKPT2009'  which represents the Derived Unique Key Per Transaction (DUKPT) algorithm, as defined by  ANSI X9.24-2009 Annex A, and 'AESDUKPT128ECB', which signifies the AES DUKPT ECB algorithm with a  key length of 128 bits, as defined in ANSI X9.24-3-2017 Annex.\n2. Mac Algo: This points to the algorithm used for Message Authentication Code (MAC). There are two  options: 'RetailSHA256MAC' which indicates the Retail-CBC-MAC using SHA-256 (Secure Hash standard)  and an ASN.1 Object Identifier: id-retail-cbc-mac-sha-256. The other option is 'SHA256CMACwithAES128',  which represents the CMAC (Cipher-based Message Authentication Code) as defined by NIST 800-38B -  May 2005. This option employs the Advanced Encryption Standard block cipher with a 128-bit  cryptographic key, as approved by FIPS 197 - November 6, 2001. The CMAC algorithm is computed on  the SHA-256 digest of the message.\nThe rest of the parameters include the 'key index', 'key name' (optional), and 'key version' (optional),  which are not specified here but contribute to the full formatting of the header parameter.\n"},"ApiKeyParam":{"name":"Api-Key","schema":{"type":"string"},"in":"header","required":true,"description":"Key given to merchant after boarding associating their requests with the appropriate app in Apigee."},"TimestampParam":{"name":"Timestamp","schema":{"type":"integer","format":"int64"},"in":"header","required":true,"description":"Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins)."},"MessageSignatureParam":{"name":"Message-Signature","schema":{"type":"string"},"in":"header","required":true,"description":"Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.","x-link":{"name":"How to Create Message Signature","link":"https://natwestpayments-api-docs.readme.io/docs/generate-a-message-signature"}},"AccessTokenParam":{"name":"Authorization","description":"The access token previously generated with the access-tokens call. Use the format 'Bearer {access-token}'.","schema":{"type":"string"},"in":"header","required":false},"TransactionIdParam":{"name":"transaction-id","schema":{"type":"string"},"in":"path","required":true,"description":"Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId."},"TransactionIdQueryParam":{"name":"transactionId","schema":{"type":"string"},"in":"query","required":false,"description":"Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId."},"OrderIdParam":{"name":"order-id","schema":{"type":"string"},"in":"path","required":true,"description":"Gateway order identifier as returned in the parameter orderId."},"OrderIdQueryParam":{"name":"orderId","schema":{"type":"string"},"in":"query","required":false,"description":"Gateway order identifier as returned in the parameter orderId."},"PaymentUrlIdQueryParam":{"name":"paymentUrlId","schema":{"type":"string"},"in":"query","required":false,"description":"The ID code from the payment URL."},"MerchantTransactionIdQueryParam":{"name":"merchantTransactionId","schema":{"type":"string"},"in":"query","required":false,"description":"Gateway merchant identifier as returned in the parameter merchantTransactionId."},"FromDateQueryParam":{"name":"fromDate","schema":{"type":"string"},"in":"query","required":true,"description":"The start date for payment URL in seconds since epoch."},"ToDateQueryParam":{"name":"toDate","schema":{"type":"string"},"in":"query","required":true,"description":"The end date for payment URL search query in seconds since epoch."},"StatusQueryParam":{"name":"status","schema":{"type":"string"},"in":"query","required":false,"description":"The status of payment URL."},"StoreIdParam":{"name":"storeId","schema":{"type":"string"},"in":"query","required":false,"description":"An optional outlet ID for clients that support multiple stores in the same developer app."},"PaymentMethodTypeParam":{"name":"payment-method","schema":{"$ref":"#/components/schemas/PaymentMethodType"},"in":"query","required":false,"description":"The type of the paymentMethod."},"TokenIdParam":{"name":"token-id","schema":{"type":"string"},"in":"path","required":true,"description":"Identifies a payment token."},"TransactionTimeQueryParam":{"name":"transactionTime","schema":{"type":"string"},"in":"query","required":false,"description":"The transaction time in seconds since epoch."}},"responses":{"BadRequest":{"description":"The request cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthenticated":{"description":"The request cannot be authenticated or was submitted with the wrong credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"The request was unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnsupportedMediaType":{"description":"Format that is not supported by the server for the HTTP method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The requested resource doesn't exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ServerError":{"description":"An unexpected internal server error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"EndpointCommunicationError":{"description":"There was a problem communicating with the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"GatewayDeclined":{"description":"There was a problem communicating with the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"EndpointDeclined":{"description":"There was a problem communicating with the endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"TransactionGatewayDeclined":{"description":"The attempted action is not valid according to gateway rules. For example, the merchant is not set-up or the order already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionErrorResponse"}}}},"TransactionEndpointDeclined":{"description":"The processor declined the transaction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionErrorResponse"}}}},"PaymentTokenizationGatewayDeclined":{"description":"The attempted action is not valid according to gateway rules. For example, when the gateway is too busy then the transaction is not processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenizationErrorResponse"}}}},"PaymentTokenizationEndpointDeclined":{"description":"The processor declined the transaction.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentTokenizationErrorResponse"}}}}},"requestBodies":{"SecondaryTransaction":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecondaryTransactionGroup"}}},"required":true,"description":"Accepted request types: PostAuthTransaction, VoidTransaction, VoidPreAuthTransactions, ReturnTransaction and PreAuthSecondaryTransaction."},"PaymentSchedulesRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentScheduleRequestGroup"}}},"required":true,"description":"Accepted request types: PaymentMethodPaymentSchedulesRequest and ReferencedOrderPaymentSchedulesRequest."},"PaymentSchedulesPatchRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentSchedulePatchRequestGroup"}}},"required":true,"description":"Accepted request types: PaymentMethodPaymentSchedulesPatchRequest and ReferencedOrderPaymentSchedulesPatchRequest."},"AuthenticationVerificationRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationUpdateRequestGroup"}}},"required":true}},"schemas":{"PrimaryTransactionGroup":{"x-hide-model":true,"type":"object","anyOf":[{"$ref":"#/components/schemas/PaymentCardSaleTransaction"},{"$ref":"#/components/schemas/PaymentCardPreAuthTransaction"},{"$ref":"#/components/schemas/PaymentCardPayerAuthTransaction"},{"$ref":"#/components/schemas/PaymentTokenPreAuthTransaction"},{"$ref":"#/components/schemas/PaymentTokenSaleTransaction"},{"$ref":"#/components/schemas/PaymentTokenPayerauthTransaction"},{"$ref":"#/components/schemas/WalletSaleTransaction"},{"$ref":"#/components/schemas/WalletPreAuthTransaction"},{"$ref":"#/components/schemas/ApmSaleTransaction"},{"$ref":"#/components/schemas/ApmPreAuthTransaction"}],"discriminator":{"propertyName":"requestType","mapping":{"PaymentCardSaleTransaction":"#/components/schemas/PaymentCardSaleTransaction","PaymentCardPreAuthTransaction":"#/components/schemas/PaymentCardPreAuthTransaction","PaymentTokenPreAuthTransaction":"#/components/schemas/PaymentTokenPreAuthTransaction","PaymentTokenSaleTransaction":"#/components/schemas/PaymentTokenSaleTransaction","WalletSaleTransaction":"#/components/schemas/WalletSaleTransaction","WalletPreAuthTransaction":"#/components/schemas/WalletPreAuthTransaction","ApmSaleTransaction":"#/components/schemas/ApmSaleTransaction","ApmPreAuthTransaction":"#/components/schemas/ApmPreAuthTransaction"}}},"SecondaryTransactionGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/PostAuthTransaction"},{"$ref":"#/components/schemas/VoidTransaction"},{"$ref":"#/components/schemas/VoidPreAuthTransactions"},{"$ref":"#/components/schemas/ReturnTransaction"},{"$ref":"#/components/schemas/PreAuthSecondaryTransaction"}],"discriminator":{"propertyName":"requestType","mapping":{"PostAuthTransaction":"#/components/schemas/PostAuthTransaction","VoidTransaction":"#/components/schemas/VoidTransaction","VoidPreAuthTransactions":"#/components/schemas/VoidPreAuthTransactions","ReturnTransaction":"#/components/schemas/ReturnTransaction","PreAuthSecondaryTransaction":"#/components/schemas/PreAuthSecondaryTransaction"}}},"AuthenticationUpdateRequestGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/Secure3DInitiateRequest"},{"$ref":"#/components/schemas/Secure3DAuthenticationUpdateRequest"},{"$ref":"#/components/schemas/Secure3D10AuthenticationUpdateRequest"},{"$ref":"#/components/schemas/Secure3D21AuthenticationUpdateRequest"}],"discriminator":{"propertyName":"authenticationType","mapping":{"Secure3DInitiateRequest":"#/components/schemas/Secure3DInitiateRequest","Secure3DAuthenticationUpdateRequest":"#/components/schemas/Secure3DAuthenticationUpdateRequest","Secure3D10AuthenticationUpdateRequest":"#/components/schemas/Secure3D10AuthenticationUpdateRequest","Secure3D21AuthenticationUpdateRequest":"#/components/schemas/Secure3D21AuthenticationUpdateRequest"}}},"PaymentScheduleRequestGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/PaymentMethodPaymentSchedulesRequest"},{"$ref":"#/components/schemas/ReferencedOrderPaymentSchedulesRequest"}],"discriminator":{"propertyName":"requestType","mapping":{"PaymentMethodPaymentSchedulesRequest":"#/components/schemas/PaymentMethodPaymentSchedulesRequest","ReferencedOrderPaymentSchedulesRequest":"#/components/schemas/ReferencedOrderPaymentSchedulesRequest"}}},"PaymentSchedulePatchRequestGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/PaymentMethodPaymentSchedulesPatchRequest"},{"$ref":"#/components/schemas/ReferencedOrderPaymentSchedulesPatchRequest"}],"discriminator":{"propertyName":"requestType","mapping":{"PaymentMethodPaymentSchedulesPatchRequest":"#/components/schemas/PaymentMethodPaymentSchedulesPatchRequest","ReferencedOrderPaymentSchedulesPatchRequest":"#/components/schemas/ReferencedOrderPaymentSchedulesPatchRequest"}}},"AccountInfoLookupRequestGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/PaymentCardInfoLookupRequest"},{"$ref":"#/components/schemas/PaymentTokenInfoLookupRequest"}],"discriminator":{"propertyName":"requestType","mapping":{"PaymentCardInfoLookupRequest":"#/components/schemas/PaymentCardInfoLookupRequest","PaymentTokenInfoLookupRequest":"#/components/schemas/PaymentTokenInfoLookupRequest"}}},"AccountVerificationRequestGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/PaymentCardVerificationRequest"},{"$ref":"#/components/schemas/PaymentTokenVerificationRequest"}],"discriminator":{"propertyName":"requestType","mapping":{"PaymentCardVerificationRequest":"#/components/schemas/PaymentCardVerificationRequest","PaymentTokenVerificationRequest":"#/components/schemas/PaymentTokenVerificationRequest"}}},"PaymentTokenizationRequestGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/PaymentCardPaymentTokenizationRequest"},{"$ref":"#/components/schemas/PaymentDevicePaymentTokenizationRequest"},{"$ref":"#/components/schemas/PaymentTokenInfoLookupRequest"}],"discriminator":{"propertyName":"requestType","mapping":{"PaymentCardPaymentTokenizationRequest":"#/components/schemas/PaymentCardPaymentTokenizationRequest","PaymentDevicePaymentTokenizationRequest":"#/components/schemas/PaymentDevicePaymentTokenizationRequest","ReferencedOrderPaymentTokenizationRequest":"#/components/schemas/ReferencedOrderPaymentTokenizationRequest"}}},"BasicResponse":{"description":"Contains apiTraceId and clientRequestId shared in all response types.","properties":{"clientRequestId":{"description":"Echoes back the value in the request header for tracking.","type":"string","example":"30dd879c-ee2f-11db-8314-0800200c9a66"},"apiTraceId":{"description":"Request identifier in API, can be used to request logs from the support team.","type":"string","example":"rrt-0bd552c12342d3448-b-ea-1142-12938318-7"},"responseType":{"$ref":"#/components/schemas/ResponseType"},"type":{"description":"Request object name, used to discriminate which object the request body is resolved to.","type":"string"}},"discriminator":{"propertyName":"type","mapping":{"errorResponse":"#/components/schemas/ErrorResponse","orderResponse":"#/components/schemas/OrderResponse","paymentTokenUpdateResponse":"#/components/schemas/PaymentTokenUpdateResponse","paymentTokenizationResponse":"#/components/schemas/PaymentTokenizationResponse","paymentSchedulesResponse":"#/components/schemas/PaymentSchedulesResponse","transactionResponse":"#/components/schemas/TransactionResponse","cardInfoLookupResponse":"#/components/schemas/CardInfoLookupResponse","paymentBrandResponse":"#/components/schemas/PaymentBrandResponse","availableIsoCountriesResponse":"#/components/schemas/AvailableIsoCountriesResponse","managedRedirectResponse":"#/components/schemas/ManagedRedirectResponse","getGuestCheckoutTokenCryptogramResponse":"#/components/schemas/GetGuestCheckoutTokenCryptogramResponse","getNetworkTokenCryptogramResponse":"#/components/schemas/GetNetworkTokenCryptogramResponse"}}},"ErrorResponse":{"description":"Response containing an error object.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"error":{"$ref":"#/components/schemas/Error"}}}]},"TransactionErrorResponse":{"description":"Transaction response with error field included.","allOf":[{"$ref":"#/components/schemas/TransactionResponse"},{"properties":{"error":{"$ref":"#/components/schemas/Error"}}}]},"PaymentSchedulesErrorResponse":{"description":"Payment schedules response with error field included.","allOf":[{"$ref":"#/components/schemas/PaymentSchedulesResponse"},{"properties":{"error":{"$ref":"#/components/schemas/Error"}}}]},"PaymentTokenizationErrorResponse":{"description":"Payment tokenization response with error field included.","allOf":[{"$ref":"#/components/schemas/PaymentTokenizationResponse"},{"properties":{"error":{"$ref":"#/components/schemas/Error"}}}]},"OrderErrorResponse":{"description":"Order response with error field included.","allOf":[{"$ref":"#/components/schemas/OrderResponse"},{"properties":{"error":{"$ref":"#/components/schemas/Error"}}}]},"OrderResponse":{"description":"Common object for primary and secondary payment request responses.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","example":"123456"},"numberOfInstallments":{"description":"Number of instalments for a sale transaction if the customer pays the total amount in multiple transactions.","type":"integer","format":"int32","minimum":1,"maximum":99,"example":3},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"},"transactions":{"description":"Required for some payment methods.","type":"array","items":{"$ref":"#/components/schemas/TransactionResponse"},"example":[{"transactionState":"AUTHORIZED","ipgTransactionId":"838916029301","transactionType":"SALE","transactionAmount":{"total":10.24,"currency":"GBP"},"storeId":"1109959991"}]},"additionalDetails":{"$ref":"#/components/schemas/AdditionalDetails"}},"example":{"orderId":"123456","billing":{"name":"John Doe","customerId":"1234567890","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"}},"shipping":{"name":"John Doe","contact":{"phone":"5555555555","mobilePhone":"5555555555","email":"john@test.com"},"address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"}},"mandate":{"reference":"3RBQVEE","url":"https://www.google.com","signatureDate":"2017-07-15","type":"SINGLE"}}}]},"PaymentTokenUpdateResponse":{"allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"requestStatus":{"description":"The status of the request.","type":"string","enum":["FAILED","SUCCESS","PARTIAL_SUCCESS"],"example":"SUCCESS"},"requestTime":{"description":"Time of the request.","type":"integer","format":"int64","example":1554308829345},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}},"example":{"requestStatus":"PARTIAL_SUCCESS","requestTime":1554308829345,"errors":[{"message":"HOSTED_DATA_ID4773410890807324. Invalid credit card number: CreditCard [cardNumber=4773410...7324, expirationMonth=12, expirationYear=2026"},{"message":"HOSTED_DATA_ID4773410888998888. Invalid credit card number: CreditCard [cardNumber=4773410...8888, expirationMonth=12, expirationYear=2026"}]}}]},"PaymentTokenizationResponse":{"allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"requestStatus":{"description":"The status of the request.","type":"string","enum":["DELETED","FAILED","SUCCESS","APPROVED","WAITING","VALIDATION_FAILED","DECLINED"],"example":"DELETED"},"requestTime":{"description":"Time of the request.","type":"integer","format":"int64","example":1554308829345},"brand":{"description":"Card brand.","type":"string","example":"VISA"},"country":{"description":"Country of the card issued.","type":"string","example":"Germany"},"paymentToken":{"$ref":"#/components/schemas/PaymentTokenDetails"},"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"networkToken":{"$ref":"#/components/schemas/NetworkToken"},"processor":{"$ref":"#/components/schemas/ProcessorData"},"tokenAlias":{"$ref":"#/components/schemas/TokenAlias"},"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","example":"R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d"},"ipgTransactionId":{"description":"The response transaction ID.","type":"string","maxLength":14,"example":"838916029301"},"merchantTransactionId":{"description":"The unique merchant transaction ID from the request header, if supplied.","type":"string","maxLength":40,"example":"lsk23532djljff3"},"additionalResponseData":{"$ref":"#/components/schemas/AdditionalResponseData"}},"example":{"requestStatus":"DELETED","requestTime":1554308829345,"brand":"VISA","country":"Germany","paymentToken":{"value":"234ljl124l12","reusable":true,"declineDuplicates":false,"last4":"4997","brand":"VISA","accountVerification":true,"type":"PAYMENT_CARD","networkTokenProvisionStatus":"QUEUED"},"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"03","year":"21"},"securityCode":"977"},"networkToken":{"value":"2343446334644554","expiryMonth":"12","expiryYear":"24"},"processor":{"referenceNumber":"117011573","authorizationCode":"OK1852","responseCode":"00","network":"DISC","associationResponseCode":"000","associationResponseMessage":"Requested function not supported","responseMessage":"APPROVAL","avsResponse":{"streetMatch":"NO_INPUT_DATA","postalCodeMatch":"NO_INPUT_DATA","associationAvsResponse":"Y"},"securityCodeResponse":"MATCHED"},"orderId":"R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d","ipgTransactionId":"838916029301","merchantTransactionId":"lsk23532djljff3"}}]},"PaymentSchedulesResponse":{"description":"Response from the gateway scheduler creation call.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"requestStatus":{"description":"Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details.","type":"string","enum":["SUCCESS","VALIDATION_FAILED","PROCESSING_FAILED","FAILURE","DECLINED"],"example":"SUCCESS"},"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","example":"123456"},"userId":{"type":"string","description":"This is the store's userID (not store-id) from where the product was purchased.","maxLength":128,"example":"1001"},"state":{"$ref":"#/components/schemas/RecurringPaymentState"},"transactionResponse":{"$ref":"#/components/schemas/TransactionResponse"}}}],"example":{"clientRequestId":"30dd879c-ee2f-11db-8314-0800200c9a66","apiTraceId":"rrt-0bd552c12342d3448-b-ea-1142-12938318-7","requestStatus":"SUCCESS","orderId":"ABC12345"}},"RecurringPaymentDetailsResponse":{"description":"Order response containing recurring payment details.","allOf":[{"$ref":"#/components/schemas/OrderResponse"},{"properties":{"recurringPaymentDetails":{"$ref":"#/components/schemas/RecurringPaymentDetails"},"industrySpecificExtensions":{"$ref":"#/components/schemas/IndustrySpecificExtensions"}}}],"example":{"clientRequestId":"30dd879c-ee2f-11db-8314-0800200c9a66","apiTraceId":"rrt-0bd552c12342d3448-b-ea-1142-12938318-7","orderId":"123456","billing":{"name":"John Doe","customerId":"1234567890","contact":{"email":"John.Doe@example.com","phone":"5555555555"}},"storeId":"1109959991","purchaseOrderNumber":"123055342","invoiceNumber":"96126098","creationDate":"2018-10-25","startDate":"2018-10-25","nextAttemptDate":"2018-10-25","transactionAmount":{"total":10.5,"currency":"GBP"},"frequency":{"every":3,"unit":"DAY"},"numberOfPayments":"10","runCount":"3","state":"Installed","comments":"This scheduled payment series is to pay for the thing"}},"TransactionResponse":{"description":"Common object for primary and secondary payment request responses.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"ipgTransactionId":{"description":"The response transaction ID.","type":"string","example":"838916029301"},"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","example":"123456"},"userId":{"type":"string","description":"This is the store's userID (not store-id) from where the product was purchased.","maxLength":128,"example":"1001"},"transactionType":{"$ref":"#/components/schemas/TransactionType"},"paymentToken":{"$ref":"#/components/schemas/PaymentTokenDetails"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"},"accountVerificationResponse":{"$ref":"#/components/schemas/AccountVerificationResponse"},"country":{"description":"Country of the card issuer.","type":"string","example":"USA"},"terminalId":{"description":"The terminal that is processing the transaction.","type":"string","example":"123456"},"merchantId":{"description":"The unique (on Acquirer level) mechant ID. Usually this value has been chosen from the merchant itself and will be used in communication with the endpoint.","type":"string","maxLength":30,"example":"199950008"},"merchantTransactionId":{"description":"The unique merchant transaction ID from the request header, if supplied.","type":"string","maxLength":40,"example":"lsk23532djljff3"},"transactionTime":{"description":"The transaction time in seconds since epoch.","type":"integer","format":"int64","example":1518811817},"approvedAmount":{"$ref":"#/components/schemas/TransactionAmount"},"transactionAmount":{"$ref":"#/components/schemas/TransactionAmount"},"transactionStatus":{"description":"This field is Deprecated. Point to 'transactionResult'.","type":"string","enum":["APPROVED","WAITING","PARTIAL","VALIDATION_FAILED","PROCESSING_FAILED","DECLINED"],"example":"APPROVED"},"transactionResult":{"description":"This is the result of the operation, unless transaction status that represent financial status of the transaction, this fields helps us to understand if the operation is successfully executed","type":"string","enum":["APPROVED","DECLINED","FAILED","WAITING","PARTIAL","FRAUD"],"example":"APPROVED"},"approvalCode":{"description":"Shows the transaction approvalcode.","type":"string","example":"N:-30031:No terminal setup"},"schemeResponseCode":{"description":"Shows the Scheme Response Code.","type":"string","example":"33"},"errorMessage":{"description":"Shows the transaction errorMessage.","type":"string","example":"000100: Tx was processed but response was not stored correctly"},"transactionState":{"description":"Shows the state of the current transaction.","type":"string","enum":["AUTHORIZED","CAPTURED","DECLINED","CHECKED","COMPLETED_GET","INITIALIZED","PENDING","READY","TEMPLATE","SETTLED","VOIDED","WAITING"],"example":"AUTHORIZED"},"paymentAccountReferenceNumber":{"description":"Payment Account Reference Number from response, if supplied.","type":"string","maxLength":30,"example":"1234001AB101112131415161718CV"},"secure3dResponse":{"$ref":"#/components/schemas/Secure3dResponse"},"standinResponseDetails":{"$ref":"#/components/schemas/StandinResponseDetails"},"redirectURL":{"description":"The endpoint redirection URL.","type":"string","example":"http://pay.issuer-bank.com/sessionID=123&sharedKey=456"},"authenticationResponse":{"$ref":"#/components/schemas/Secure3DAuthenticationResponse"},"schemeTransactionId":{"description":"The transaction ID received from schemes for the initial transaction of card on file flows.","type":"string","maxLength":40,"example":"019078743804756"},"transactionLinkIdentifier":{"description":"The unique Identifier sent from scheme to link all transactions for single order.","type":"string","maxLength":36,"example":"01236548543965"},"processor":{"$ref":"#/components/schemas/ProcessorData"},"additionalDetails":{"$ref":"#/components/schemas/AdditionalTransactionDetails"},"requiredActions":{"$ref":"#/components/schemas/RequiredActions"},"networkToken":{"$ref":"#/components/schemas/NetworkToken"},"emvData":{"description":"It includes the EMV data from the issuer response and it is Base64 encoded.","type":"string","maxLength":10000},"selectedInstallmentPlan":{"$ref":"#/components/schemas/InstallmentPlan"}}}],"example":{"clientRequestId":"30dd879c-ee2f-11db-8314-0800200c9a66","apiTraceId":"rrt-0c80a3403e2c2def0-d-ea-28805-6810951-2","ipgTransactionId":"838916029301","transactionType":"SALE","transactionTime":1518811817,"approvedAmount":{"total":10.24,"currency":"GBP"},"transactionAmount":{"total":10.24,"currency":"GBP","components":{"subtotal":8,"localTax":1,"shipping":1.24}},"transactionStatus":"APPROVED","transactionResult":"APPROVED","schemeTransactionId":"019078743804756","processor":{"responseCode":"00","responseMessage":"APPROVED","authorizationCode":"OK7118"},"plannedDueDate":"2022-03-03","requiredActions":{"requiredRedirectionData":{"url":"https://payment.thirdparty.com","headerParameters":{"headerParam1":"value1","headerParam2":"value2"},"method":"GET"},"requiredConsumerData":[{"hint":"Your 6-digit Code will be provided in your mobile application","validationExpression":"^\\\\d{6}$","key":"BLIK_CODE"}],"requiredIntegrationData":[{"hint":"Payment requires the user agent information on the browser/device.","key":"USER_AGENT"}]}}},"RecurringPaymentDetails":{"description":"Details about existing gateway schedule.","properties":{"storeId":{"description":"Store ID number.","type":"string","maxLength":20,"example":"1109959991"},"purchaseOrderNumber":{"description":"Purchase order number.","type":"string","example":"123055342"},"invoiceNumber":{"description":"Invoice number.","type":"string","example":"96126098"},"additionalDetails":{"$ref":"#/components/schemas/AdditionalDetails"},"creationDate":{"description":"This field should contain the date when recurring payment was created. The date can either the format Tue Jul 14 13:40:26 IST 2020 or YYYY/MM/DD.","type":"string","example":"Tue Jul 14 13:40:26 IST 2020"},"startDate":{"description":"In this field, the date of signature of the mandate must be in either the format Tue Jul 14 13:40:26 IST 2020 or YYYY/MM/DD.","type":"string","example":"Tue Jul 14 13:40:26 IST 2020"},"nextAttemptDate":{"description":"Next transaction process attempt date should be in either the format Tue Jul 14 13:40:26 IST 2020 or YYYY/MM/DD.","type":"string","example":"Tue Jul 14 13:40:26 IST 2020"},"transactionAmount":{"$ref":"#/components/schemas/Amount"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"},"frequency":{"$ref":"#/components/schemas/Frequency"},"numberOfPayments":{"description":"Number of times the recurring payment will process.","type":"integer","format":"int32","minimum":1,"maximum":999,"example":10},"runCount":{"description":"Times the recurring payment has already run.","type":"integer","format":"int32","minimum":0,"maximum":999,"example":10},"state":{"$ref":"#/components/schemas/RecurringPaymentState"},"additionalRecurringData":{"$ref":"#/components/schemas/AdditionalRecurringData"},"comments":{"description":"User supplied comments.","type":"string","example":"This scheduled payment series is to pay for the thing."}},"example":{"storeId":"1109959991","invoiceNumber":"96126098","creationDate":"2018-10-25","startDate":"2018-10-25","transactionAmount":{"total":10.24,"currency":"GBP"},"frequency":{"every":3,"unit":"DAY"},"numberOfPayments":10,"runCount":3,"state":"Installed","comments":"This scheduled payment series is to pay for the thing."}},"PaymentMethodPaymentSchedulesRequest":{"title":"PaymentMethodPaymentSchedulesRequest","description":"Request to create a new payment schedule using a payment method.","allOf":[{"$ref":"#/components/schemas/PaymentSchedulesRequest"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentSchedulesPaymentMethod"}}}],"example":{"requestType":"PaymentMethodPaymentSchedulesRequest","transactionAmount":{"total":25.24,"currency":"GBP"},"startDate":"2021-12-31","frequency":{"every":1,"unit":"MONTH"},"paymentMethod":{"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"12","year":"25"},"securityCode":"977","brand":"VISA"}}}},"ReferencedOrderPaymentSchedulesRequest":{"title":"ReferencedOrderPaymentSchedulesRequest","description":"Request to create a new payment schedule using a referenced order ID.","allOf":[{"$ref":"#/components/schemas/PaymentSchedulesRequest"},{"type":"object","required":["referencedOrderId"],"properties":{"referencedOrderId":{"description":"Order ID used to create recurring payment from existing transaction.","type":"string","pattern":"^(?!\\s*$).+","example":"R-f9c2c198-b7cc-491a-a711-93d22fd0e589"}}}],"example":{"requestType":"ReferencedOrderPaymentSchedulesRequest","referencedOrderId":"R-f9c2c198-b7cc-491a-a711-93d22fd0e589","startDate":"2021-12-31","numberOfPayments":10,"maximumFailures":1,"invoiceNumber":"96126098","purchaseOrderNumber":"123055342","transactionOrigin":"ECOM","dynamicMerchantName":"MyWebsite","frequency":{"every":1,"unit":"MONTH"},"transactionAmount":{"total":25.24,"currency":"GBP"},"clientLocale":{"language":"EN","country":"USA"}}},"PaymentMethodPaymentSchedulesPatchRequest":{"title":"PaymentMethodPaymentSchedulesPatchRequest","description":"Request to create a new payment schedule using a payment method.","allOf":[{"$ref":"#/components/schemas/PaymentSchedulesPatchRequest"},{"type":"object","properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentSchedulesPaymentMethod"}}}],"example":{"requestType":"PaymentMethodPaymentSchedulesPatchRequest","transactionAmount":{"total":25.24,"currency":"GBP"},"nextAttemptDate":"2021-12-31","frequency":{"every":1,"unit":"MONTH"},"paymentMethod":{"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"12","year":"25"},"securityCode":"977","brand":"VISA"}}}},"ReferencedOrderPaymentSchedulesPatchRequest":{"title":"ReferencedOrderPaymentSchedulesPatchRequest","description":"Request to create a new payment schedule using a referenced order ID.","allOf":[{"$ref":"#/components/schemas/PaymentSchedulesPatchRequest"},{"type":"object","required":["referencedOrderId"],"properties":{"referencedOrderId":{"description":"Order ID used to create recurring payment from existing transaction.","type":"string","pattern":"^(?!\\s*$).+","example":"R-f9c2c198-b7cc-491a-a711-93d22fd0e589"}}}],"example":{"requestType":"ReferencedOrderPaymentSchedulesPatchRequest","referencedOrderId":"R-f9c2c198-b7cc-491a-a711-93d22fd0e589","nextAttemptDate":"2021-12-31","numberOfPayments":10,"maximumFailures":1,"invoiceNumber":"96126098","purchaseOrderNumber":"123055342","transactionOrigin":"ECOM","dynamicMerchantName":"MyWebsite","frequency":{"every":1,"unit":"MONTH"},"transactionAmount":{"total":25.24,"currency":"GBP"},"clientLocale":{"language":"EN","country":"USA"}}},"PaymentSchedulesRequest":{"description":"Request to create a gateway schedule. Abstract class, do not use this class directly, use one of its children.","required":["requestType","transactionAmount","startDate","frequency"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the payment schedules request.","type":"string","example":"PaymentMethodPaymentSchedulesRequest"},"storeId":{"description":"Store ID number.","type":"string","maxLength":20,"example":"1109959991"},"userId":{"type":"string","description":"This is the store's userID (not store-id) from where the product was purchased.","maxLength":128,"example":"1001"},"startDate":{"description":"Date of mandate signature.","type":"string","format":"date","example":"2018-10-25"},"nextAttemptDate":{"description":"Date of next transaction process attempt.","type":"string","format":"date","example":"2018-10-25"},"numberOfPayments":{"description":"Number of times the recurring payment will process.","type":"integer","format":"int32","minimum":1,"maximum":999,"example":10},"maximumFailures":{"description":"Number of failures that can be encountered before re-tries cease.","type":"integer","format":"int32","minimum":1,"maximum":999,"example":1},"invoiceNumber":{"description":"Invoice number.","type":"string","example":"96126098"},"purchaseOrderNumber":{"description":"Purchase order number.","type":"string","example":"123055342"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"},"dynamicMerchantName":{"description":"Dynamic merchant name for the cardholder's statement.","type":"string","example":"MyWebsite"},"frequency":{"$ref":"#/components/schemas/Frequency"},"transactionAmount":{"$ref":"#/components/schemas/Amount"},"clientLocale":{"$ref":"#/components/schemas/ClientLocale"},"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","example":"123456"},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"},"industrySpecificExtensions":{"$ref":"#/components/schemas/IndustrySpecificExtensions"},"comments":{"description":"User supplied comments.","type":"string","example":"This scheduled payment series is to pay for the thing."}},"example":{"requestType":"PaymentMethodPaymentSchedulesRequest","startDate":"2021-12-31","nextAttemptDate":"2022-10-31","numberOfPayments":10,"maximumFailures":1,"invoiceNumber":"96126098","purchaseOrderNumber":"123055342","transactionOrigin":"ECOM","dynamicMerchantName":"MyWebsite","frequency":{"every":1,"unit":"MONTH"},"paymentMethod":{"paymentCard":{"number":"5426064000424979","expiryDate":{"month":"12","year":"25"},"securityCode":"147","cardFunction":"CREDIT"}},"transactionAmount":{"total":25.24,"currency":"GBP"},"clientLocale":{"language":"EN","country":"USA"}}},"PaymentSchedulesPatchRequest":{"description":"Request to create a gateway schedule. Abstract class, do not use this class directly, use one of its children.","required":["requestType","transactionAmount","frequency"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the payment schedules patch request.","type":"string","example":"PaymentMethodPaymentSchedulesPatchRequest"},"storeId":{"description":"Store ID number.","type":"string","pattern":"^[a-zA-Z0-9]+$","maxLength":20,"example":"1109959991"},"userId":{"type":"string","description":"This is the store's userID (not store-id) from where the product was purchased.","maxLength":128,"example":"1001"},"nextAttemptDate":{"description":"Date of next transaction process attempt.","type":"string","format":"date","example":"2022-10-25"},"numberOfPayments":{"description":"Number of times the recurring payment will process.","type":"integer","format":"int32","minimum":1,"maximum":999,"example":10},"maximumFailures":{"description":"Number of failures that can be encountered before re-tries cease.","type":"integer","format":"int32","minimum":1,"maximum":999,"example":1},"invoiceNumber":{"description":"Invoice number.","type":"string","pattern":"^[a-zA-Z0-9]+[a-zA-Z0-9\\/_-]*$","maxLength":48,"example":"96126098"},"purchaseOrderNumber":{"description":"Purchase order number.","type":"string","pattern":"^[a-zA-Z0-9]+[a-zA-Z0-9\\/_-]*$","maxLength":128,"example":"123055342"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"},"dynamicMerchantName":{"description":"Dynamic merchant name for the cardholder's statement.","type":"string","maxLength":100,"example":"MyWebsite"},"frequency":{"$ref":"#/components/schemas/Frequency"},"transactionAmount":{"$ref":"#/components/schemas/Amount"},"clientLocale":{"$ref":"#/components/schemas/ClientLocale"},"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","pattern":"^[a-zA-Z0-9]+[a-zA-Z0-9\\/_-]*$","maxLength":100,"example":"R-f9c2c198-b7cc-491a-a711-93d22fd0e589"},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"},"industrySpecificExtensions":{"$ref":"#/components/schemas/IndustrySpecificExtensions"},"comments":{"description":"User supplied comments.","type":"string","maxLength":1024,"example":"This scheduled payment series is to pay for the thing."}},"example":{"requestType":"PaymentMethodPaymentSchedulesPatchRequest","nextAttemptDate":"2022-10-31","numberOfPayments":10,"maximumFailures":1,"invoiceNumber":"96126098","purchaseOrderNumber":"123055342","transactionOrigin":"ECOM","dynamicMerchantName":"MyWebsite","frequency":{"every":1,"unit":"MONTH"},"paymentMethod":{"paymentCard":{"number":"5426064000424979","expiryDate":{"month":"12","year":"25"},"securityCode":"147","cardFunction":"CREDIT"}},"transactionAmount":{"total":25.24,"currency":"GBP"},"clientLocale":{"language":"EN","country":"USA"}}},"Frequency":{"description":"How often payments are sent.","required":["every","unit"],"properties":{"every":{"description":"Rate of frequency.","type":"integer","format":"int32","minimum":1,"maximum":1000,"example":10},"unit":{"description":"Unit which defines the frequency.","type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"example":"MONTH"}},"example":{"every":3,"unit":"DAY"}},"ClientLocale":{"description":"Country and language of client.","required":["language","country"],"properties":{"language":{"description":"Language used by client.","type":"string","pattern":"^(?!\\s*$).+","example":"en"},"country":{"description":"Country of the client.","type":"string","pattern":"^(?!\\s*$).+","example":"GB"}},"example":{"language":"en","country":"GB"}},"AccessTokenRequest":{"description":"Access token generation request.","required":["domain","token","publicKeyRequired"],"properties":{"domain":{"description":"Domain name.","type":"string","example":"somedomain.com"},"token":{"description":"The token value.","type":"string","example":"gfgF92JHDJFjxcJHCQ23IbI12D"},"publicKeyRequired":{"description":"Indicates whether public key is requested or not.","type":"boolean","example":true}},"example":{"domain":"somedomain.com","token":"gfgF92JHDJFjxcJHCQ23IbI12D","publicKeyRequired":false}},"AccessTokenResponse":{"description":"Access token generation response.","properties":{"tokenId":{"description":"Access token for authentication.","type":"string","example":"gliF92ypj9cKRWUP8lpRIbI3bhNf"},"status":{"description":"The token status.","type":"string","example":"ACTIVE"},"issuedOn":{"description":"Access token issued time in milliseconds.","type":"string","example":"1579021570941"},"expiresInSeconds":{"description":"Access token expiration time.","type":"string","example":"899"},"publicKeyBase64":{"description":"Public key to encrypt data.","type":"string","example":"LS0tLS1CRUdJTiBQLbnFSNXRnVmc4U08LS1FTkQgUFVCTElDIEtFWS0tLS0t"},"algorithm":{"description":"Encyption algorithym. One way ECDH 256 bit key.","type":"string","example":"RSA/NONE/PKCS1PADDING"},"clientRequestId":{"description":"Echoes back the value from the request header for tracking.","type":"string","example":"30dd879c-ee2f-11db-8314-0800200c9a66"}},"example":{"tokenId":"gliF92ypj9cKRWUP8lpRIbI3bhNf","status":"ACTIVE","issuedOn":"1579021570941","expiresInSeconds":"899","publicKeyBase64":"LS0tLS1CRUdJTiBQLbnFSNXRnVmc4U08LS1FTkQgUFVCTElDIEtFWS0tLS0t","algorithm":"RSA/NONE/PKCS1PADDING","clientRequestId":"30dd879c-ee2f-11db-8314-0800200c9a66"}},"CardVerificationRequest":{"description":"Request to verify card validity. Only one payment card data is accepted for processing transaction either PaymantCard or PaymentCardEncrypted","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"},"billingAddress":{"$ref":"#/components/schemas/Address"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"}},"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"paymentCard":{"number":"4035874000424977","expiryDate":{"month":"12","year":"25"},"securityCode":"977"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"},"billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"}}},"AccountVerificationRequest":{"description":"Request to verify payment card or payment token. Abstract class, do not use this class directly, use one of its children.","type":"object","required":["requestType"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the account verification request.","type":"string","example":"PaymentCardVerificationRequest"},"billingAddress":{"$ref":"#/components/schemas/Address"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"},"merchantTransactionId":{"description":"The unique merchant transaction ID from the request, if supplied.","type":"string","maxLength":40,"example":"lsk23532djljff3"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"},"additionalDetails":{"$ref":"#/components/schemas/AdditionalDetails"},"accountOwner":{"$ref":"#/components/schemas/AccountOwner"}},"example":{"requestType":"PaymentCardVerificationRequest","paymentCard":{"number":"4035874000424977","expiryDate":{"month":"12","year":"25"},"securityCode":"977"},"billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"},"accountOwner":{"firstName":"Pete","middleName":"Maverick","lastName":"Mitchell"}}},"PaymentCardVerificationRequest":{"title":"PaymentCardVerificationRequest","description":"Used to request account verification using a payment card. The expiryDate in paymentCard object is required to perform a PaymentCardVerificationRequest. Only one payment card data is accepted for processing transaction either PaymantCard or PaymentCardEncrypted","allOf":[{"$ref":"#/components/schemas/AccountVerificationRequest"},{"type":"object","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"}}}],"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"requestType":"PaymentCardVerificationRequest","paymentCard":{"number":"4035874000424977","expiryDate":{"month":"12","year":"25"},"securityCode":"977"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"},"billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"}}},"PaymentTokenVerificationRequest":{"title":"PaymentTokenVerificationRequest","description":"Used to request account verification using a payment token.","allOf":[{"$ref":"#/components/schemas/AccountVerificationRequest"},{"type":"object","required":["paymentToken"],"properties":{"paymentToken":{"$ref":"#/components/schemas/UsePaymentToken"}},"example":{"requestType":"PaymentTokenVerificationRequest","paymentToken":{"value":"1235325235236","function":"DEBIT","securityCode":"977"},"billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"}}}]},"ReferencedOrderPaymentTokenizationRequest":{"title":"ReferencedOrderPaymentTokenizationRequest","description":"Used to generate payment tokens with an existing order ID.","allOf":[{"$ref":"#/components/schemas/PaymentTokenizationRequest"},{"type":"object","required":["referencedOrderId"],"properties":{"referencedOrderId":{"description":"Retrieves the payment instrument information from an existing order.","type":"string","pattern":"^(?!\\s*$).+","example":"R-f9c2c198-b7cc-491a-a711-93d22fd0e589"}}}],"example":{"requestType":"ReferencedOrderPaymentTokenizationRequest","createToken":{"value":"234ljl124l12","reusable":true,"declineDuplicates":false},"referencedOrderId":"R-f9c2c198-b7cc-491a-a711-93d22fd0e589","accountVerification":true}},"PaymentCardPaymentTokenizationRequest":{"title":"PaymentCardPaymentTokenizationRequest","description":"Used to generate payment tokens during payment. Only one payment card data is accepted for processing transaction either PaymantCard or PaymentCardEncrypted","allOf":[{"$ref":"#/components/schemas/PaymentTokenizationRequest"},{"type":"object","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"}}}],"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"requestType":"PaymentCardPaymentTokenizationRequest","paymentCard":{"number":"4035874000424977","expiryDate":{"month":"12","year":"25"},"securityCode":"977"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"},"billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"},"createToken":{"value":"234ljl124l12","reusable":true,"declineDuplicates":false},"accountVerification":true}},"PaymentDevicePaymentTokenizationRequest":{"title":"PaymentDevicePaymentTokenizationRequest","description":"Used to generate payment tokens during payment using a payment device.","allOf":[{"$ref":"#/components/schemas/PaymentTokenizationRequest"},{"type":"object","required":["paymentDevice"],"properties":{"paymentDevice":{"$ref":"#/components/schemas/PaymentDevice"}}}],"example":{"requestType":"PaymentDevicePaymentTokenizationRequest","paymentDevice":{"deviceType":"SWIPE","data":"02A600C0170018008292;5424********1732=1810?*B73CD8C26233D4FFEC5500ED394439D97DDA5F530942D21D0000000000000000000000000000000000000000363434543035353734326299492410027300000260DC03","securityCode":"977","cardholderName":"First Cardholder","cardFunction":"CREDIT","brand":"VISA"},"billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"},"createToken":{"value":"234ljl124l122","reusable":true,"declineDuplicates":false},"accountVerification":true}},"PaymentCardPaymentTokenUpdateRequest":{"title":"PaymentCardPaymentTokenUpdateRequest","description":"Request to update payment token for one or more cards.","required":["requestType","paymentTokens"],"properties":{"requestType":{"description":"Object name of tokenization request.","type":"string","example":"PaymentCardPaymentTokenUpdateRequest"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"},"paymentTokens":{"description":"List of payment tokens to be updated in the request.","type":"array","minItems":1,"maxItems":1000,"items":{"$ref":"#/components/schemas/UpdatePaymentToken"}}},"example":{"requestType":"PaymentCardPaymentTokenUpdateRequest","paymentTokens":[{"value":"1751905117310026","reusable":true,"declineDuplicates":false,"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"03","year":"25"},"securityCode":"977"}},{"value":"9877hkhk68688888ffgh","reusable":true,"declineDuplicates":false,"paymentCard":{"number":"4012000033330026","expiryDate":{"month":"10","year":"22"},"securityCode":"123"}}]}},"PaymentTokenizationRequest":{"title":"PaymentTokenizationRequest","description":"Used to generate payment tokens. Abstract class, do not use this class directly, use one of its children.","discriminator":{"propertyName":"requestType"},"required":["requestType","createToken"],"properties":{"requestType":{"type":"string","description":"Object name of tokenization request.","example":"PaymentCardPaymentTokenizationRequest"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"},"billingAddress":{"$ref":"#/components/schemas/Address"},"createToken":{"$ref":"#/components/schemas/CreatePaymentToken"},"accountVerification":{"description":"If the account should be verified prior to token creation.","type":"boolean","default":false,"example":true},"merchantTransactionId":{"description":"The unique merchant transaction ID from the request, if supplied.","type":"string","maxLength":40,"example":"lsk23532djljff3"},"additionalDetails":{"$ref":"#/components/schemas/AdditionalDetails"}},"example":{"requestType":"PaymentCardPaymentTokenizationRequest","paymentCard":{"number":"4012000033330026","expiryDate":{"month":"12","year":"24"}},"createToken":{"reusable":true,"declineDuplicates":false},"accountVerification":false,"additionalDetails":{"operatorId":"OPERATOR_ID_123XXX","salesSystemId":"W-EU-H3866-FLS2"}}},"UsePaymentToken":{"description":"Payment token usage details.","required":["value"],"properties":{"value":{"description":"Client-supplied payment token value.","type":"string","pattern":"^(?!\\s*$).+","example":"1235325235236"},"tokenOriginStoreId":{"description":"The ID of a same store (or) sibling store in a hierarchy for which the token was originally created.","type":"string","maxLength":20,"example":"12345500001"},"function":{"$ref":"#/components/schemas/CardFunction"},"securityCode":{"description":"Card verification value/number.","type":"string","minLength":3,"maxLength":4,"example":"977"},"expiryDate":{"$ref":"#/components/schemas/Expiration"},"fundingCardNumber":{"$ref":"#/components/schemas/fundingCardNumber"}},"example":{"value":"1235325235236","tokenOriginStoreId":"12345500001","function":"DEBIT","securityCode":"977","expiryDate":{"month":"12","year":"24"}}},"PaymentTokenDetails":{"description":"Response details for payment token creation.","allOf":[{"$ref":"#/components/schemas/CreatePaymentToken"},{"type":"object","properties":{"last4":{"description":"The last 4 numbers of a payment card.","type":"string","example":"4997"},"brand":{"description":"Card brand, only for tokenization with payment.","type":"string","example":"VISA"},"accountVerification":{"description":"If the account the token was created from has been verified.","type":"boolean","example":true},"type":{"description":"Indicates the type of tokenization source.","type":"string","example":"PAYMENT_CARD"},"networkTokenProvisionStatus":{"$ref":"#/components/schemas/NetworkTokenProvisionStatus"},"error":{"$ref":"#/components/schemas/Error"}}}],"example":{"value":"234ljl124l12","reusable":true,"declineDuplicates":false,"last4":"4997","brand":"VISA","accountVerification":true,"type":"PAYMENT_CARD","networkTokenProvisionStatus":"QUEUED"}},"CreatePaymentToken":{"description":"Use this model to create a payment token.","properties":{"value":{"description":"Client-supplied payment token value. Only applicable for DataVault tokenization scheme.","type":"string","example":"234ljl124l12"},"reusable":{"description":"If the token is reusable.","type":"boolean","default":true,"example":true},"declineDuplicates":{"description":"Decline duplicate payment info if client token is supplied.","type":"boolean","default":false,"example":false},"customWalletRegistration":{"$ref":"#/components/schemas/CustomWalletRegistration"}},"example":{"value":"234ljl124l12","reusable":true,"declineDuplicates":false,"customWalletRegistration":{"walletType":"BANCONTACT_WALLET","authenticationMethods":["USERNAME_PASSWORD_PIN"]}}},"UpdatePaymentToken":{"description":"Use this model to Update payment token. Only one payment card data is accepted for processing transaction either PaymantCard or PaymentCardEncrypted","required":["value"],"properties":{"value":{"description":"Client-supplied payment token value.","type":"string","example":"234ljl124l12"},"reusable":{"description":"If the token is reusable.","type":"boolean","default":true,"example":true},"declineDuplicates":{"description":"Decline duplicate payment info if client token is supplied.","type":"boolean","default":false,"example":false},"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"}},"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"value":"3425345345yygg","reusable":true,"declineDuplicates":false,"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"12","year":"24","securityCode":"977"},"fundingCardNumber":{"bin":"542418","last4":"1732"}},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"}}},"SourceOfFundsType":{"description":"Source Of Funds Type. This field identifies type of account from which the funds will be transferred.","type":"string","enum":["CREDIT_ACCOUNT","DEBIT_ACCOUNT","PREPAID_ACCOUNT","CASH","DEPOSIT_ACCOUNT","MOBILE_MONEY_ACCOUNT"],"example":"DEBIT_ACCOUNT"},"CardFunction":{"description":"Card function. This field is required when performing transactions for Brazil merchants.","type":"string","enum":["CREDIT","DEBIT","PREPAID","VOUCHER","UNDEFINED"],"example":"DEBIT"},"EncryptionType":{"description":"This field provides information about encryption type which has been used by merchant to encrypt original card data.","type":"string","enum":["JWE"],"example":"JWE"},"NetworkTokenProvisionStatus":{"description":"This field provides the status of the NetworkToken being provisioned for the supplied PAN.","type":"string","enum":["REQUESTED","PROVISIONED","QUEUED"],"example":"QUEUED"},"ResponseType":{"description":"The type of the response.","type":"string","enum":["BadRequest","Unauthenticated","Unauthorized","NotFound","GatewayDeclined","EndpointDeclined","ServerError","EndpointCommunicationError","UnsupportedMediaType"],"example":"Unauthenticated"},"ProcessorData":{"description":"Model for processor data.","properties":{"referenceNumber":{"description":"Reference transaction ID.","type":"string","example":"811720726601"},"authorizationCode":{"description":"Code returned to confirm transaction.","type":"string","example":"OK7118"},"responseCode":{"description":"Response code from endpoints.","type":"string","example":"00"},"network":{"description":"Network used for transaction.","type":"string","example":"NYCE"},"associationResponseCode":{"description":"Raw response code from issuer.","type":"string","example":"000"},"associationResponseMessage":{"description":"Indicates the processor association message.","type":"string","example":"Requested function not supported"},"responseMessage":{"description":"Message returned from endpoints.","type":"string","example":"Amount specified exceeds allowable limit."},"avsResponse":{"$ref":"#/components/schemas/AVSResponse"},"cardholderInfoResponse":{"$ref":"#/components/schemas/CardholderInfoResponse"},"securityCodeResponse":{"description":"Code returned for CVV.","type":"string","enum":["MATCHED","NOT_MATCHED","NOT_PROCESSED","NOT_PRESENT","NOT_CERTIFIED","NOT_CHECKED"],"example":"NOT_MATCHED"},"merchantAdviceCodeIndicator":{"description":"Code to map merchant advice code to ISO specification.","type":"string","pattern":"[0-9]{2}","example":"01"},"merchantAdviceMessage":{"description":"Information about the merchant advice code.","type":"string","example":"The issuer recognizes the product as a consumer non-reloadable prepaid card"},"paymentAccountReferenceNumber":{"description":"Information about the payment account Reference number.","type":"string","example":"0846343434"},"responseIndicator":{"description":"Indicates whether the transaction was routed through the payment card's own network or through a different network.","type":"string","example":"0100"},"debitReceiptNumber":{"description":"Receipt number from debit network provider.","type":"string","example":"123456"},"transactionIntegrityClass":{"description":"MasterCard provided Transaction Integrity Class for Point of Sale (POS) Purchase and Purchase with Cash Back transactions initiated on the Authorization Platform.","type":"string","example":"A1"},"taxRefundData":{"$ref":"#/components/schemas/TaxRefundData"}},"example":{"responseCode":"00","responseMessage":"APPROVED","authorizationCode":"OK7118","network":"NYCE"}},"Error":{"description":"Error information.","properties":{"code":{"description":"Uniquely identifies an error condition. Client applications need to read and handle errors based on this.","type":"string","example":"2303"},"message":{"description":"A generic description of the error condition.","type":"string","example":"Invalid credit card number"},"details":{"description":"Detailed information about message format errors.","type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"}},"declineReasonCode":{"description":"Information about the decline reason.","type":"string","example":"Do not try again"}},"example":{"code":"2303","message":"Invalid credit card number"}},"ErrorDetails":{"description":"Detailed information about message format errors.","type":"object","properties":{"field":{"description":"The property or attribute associated with the error.","type":"string","example":"PaymentCard.number"},"message":{"description":"Information specific to a property or attribute.","type":"string","example":"may not be null"}}},"PaymentCardPayerAuthTransaction":{"title":"PaymentCardPayerAuthTransaction","description":"Request to create payer auth primary transaction.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentCardPaymentMethod"},"authenticationRequest":{"$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"createToken":{"$ref":"#/components/schemas/CreatePaymentToken"}}}],"example":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentCardPayerAuthTransaction","paymentMethod":{"paymentCard":{"number":"5424180279791732","securityCode":"977","expiryDate":{"month":"12","year":"24"}}},"createToken":{"reusable":true,"declineDuplicates":false}}},"ApmTransaction":{"description":"Interface for requests containing terminalID.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/ApmPaymentMethod"},"integrationData":{"description":"Integration data to provide information from the application.","type":"array","items":{"$ref":"#/components/schemas/IntegrationData"}},"consumerData":{"description":"Integration data provided by the payer.","type":"array","items":{"$ref":"#/components/schemas/ConsumerData"}},"terminalId":{"description":"Terminal ID is only needed for special use cases, e.g. to check attestation status.","type":"string","minLength":6,"maxLength":32,"example":"123456789"}}}]},"ApmSaleTransaction":{"title":"ApmSaleTransaction","description":"Request to create sale transaction using an alternative payment method (see methods supported by this transaction type below).","allOf":[{"$ref":"#/components/schemas/ApmTransaction"}],"example":{"transactionAmount":{"total":"40","currency":"GBP"},"requestType":"ApmSaleTransaction","paymentMethod":{"type":"NATWEST_PAYIT"},"integrationData":[{"item":"RETURN_URL","value":"https://clientdomain.com/orderDetails"},{"item":"PAYER_IP","value":"1.1.1.1"}],"consumerData":[{"item":"EMAIL_ADDRESS","value":"consumer@email.com"}],"terminalId":"123456789"}},"ApmPreAuthTransaction":{"title":"ApmPreAuthTransaction","description":"Request to create preAuth transaction using an alternative payment method (see methods supported by this transaction type below).","allOf":[{"$ref":"#/components/schemas/ApmTransaction"}],"example":{"transactionAmount":{"total":"40","currency":"GP"},"requestType":"ApmPreAuthTransaction","paymentMethod":{"type":"NATWEST_PAYIT"},"integrationData":[{"item":"RETURN_URL","value":"https://clientdomain.com/orderDetails"},{"item":"PAYER_IP","value":"1.1.1.1"}],"consumerData":[{"item":"EMAIL_ADDRESS","value":"consumer@email.com"}],"terminalId":"123456789"}},"WalletSaleTransaction":{"title":"WalletSaleTransaction","description":"Request to create sale primary transaction using digital wallet.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["walletPaymentMethod"],"properties":{"walletPaymentMethod":{"$ref":"#/components/schemas/WalletPaymentMethod"},"authenticationRequest":{"description":"3DS authentication is only applicable for GooglePay and for specific resellers.","$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"description":"3DS authorization is only applicable for GooglePay and for specific resellers.","$ref":"#/components/schemas/AuthenticationResult"},"paymentFacilitator":{"$ref":"#/components/schemas/PaymentFacilitator"},"senderReceiverInfo":{"$ref":"#/components/schemas/SenderReceiverInfo"}}}],"example":{"requestType":"WalletSaleTransaction","walletPaymentMethod":{"walletType":"EncryptedApplePayWalletPaymentMethod","encryptedApplePay":{"data":"NdCmVw5nMjQq746HYc/VbiZcQZ/zFzeEcM1wVMPruEG4/C/EFhobSkwB5JZJU+t6JuDVXUBiRYuOOC8FTYd+qIm6ckktid9aiGh0f2NDP0INSr59QXmr389RonyUfRYKnBmwsh5UqtI7Iz0AmMtl1PWMdxcCewtjuffs79ahTnFgXsRN+ynuhyDfbdRanlTnYKGoTeVh9eJfheJ1wquO+jiGj+npJ/Oh9bAdlw7iEHrYO2aUkgaMyXZ3foXRAJeimQVQS1y8lU1PPq62zpPrFzidbnnU5fK25pvGFjOdmLsBELZPk5thQEkSaA9p1LSKzWSesHhi0BxZaFPXSA6ANXvYIU2AT0lG+0O0w1URA5Sinyj3YDZVqjuir6rzNN9bB2U2nTQnKMbuGLMS20K8fUKZN/YLJh+AtE6J69+VVSU95mE1nOb8hyabz6E5RmnC5Ze2k6F/hQ75ig==","header":{"applicationDataHash":"94ee059335e587e501cc4bf90613e0814f00a7b08bc7c648fd865a2af6a22cc2","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiaU1SbkYTJy/j5L1t51vtGDh4KlNl5MFPWzo/C8r0WcrktWriz5pdRaDVUDvU++KlDu2iuQsd2xSNKJlFscbDQ==","publicKeyHash":"YmSWN7lj4+A6fVJVPicP8TgS7gI7ougD8rEWB5LXtMM=","transactionId":"31323334353637"},"signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIB0zCCAXkCAQEwCQYHKoZIzj0EATB2MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTkoxFDASBgNVBAcMC0plcnNleSBDaXR5MRMwEQYDVQQKDApGaXJzdCBEYXRhMRIwEAYDVQQLDAlGaXJzdCBBUEkxGzAZBgNVBAMMEmQxZHZ0bDEwMDAuMWRjLmNvbTAeFw0xNTA3MjMxNjQxMDNaFw0xOTA3MjIxNjQxMDNaMHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErnHhPM18HFbOomJMUiLiPL7nrJuWvfPy0Gg3xsX3m8q0oWhTs1QcQDTT+TR3yh4sDRPqXnsTUwcvbrCOzdUEeTAJBgcqhkjOPQQBA0kAMEYCIQDrC1z2JTx1jZPvllpnkxPEzBGk9BhTCkEB58j/Cv+sXQIhAKGongoz++3tJroo1GxnwvzK/Qmc4P1K2lHoh9biZeNhAAAxggFUMIIBUAIBATB7MHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tAgEBMA0GCWCGSAFlAwQCAQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTUwODEyMTczMTAwWjAvBgkqhkiG9w0BCQQxIgQgJyjKLiGQo3I1ZbfHSmF2XCZ8dNlcZyohziuXO48EKwgwCgYIKoZIzj0EAwIESDBGAiEAznKDYEz9MsC+r1g6e4LR1DTaQOl+X2rVNkWnKDpc1EQCIQCmK48ChHoz4HWnUnW5XqaGWOUXKHQvUgeqFr/jgBUzegAAAAAAAA==","applicationData":"VEVTVA==","merchantId":"order-1","version":"EC_v1"}},"paymentFacilitator":{"externalMerchantId":"12345","paymentFacilitatorId":"123123123","saleOrganizationId":"123124214","name":"First Reseller","subMerchantData":{"mcc":"1432","legalName":"First Merchant","timezone":"Europe/London","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"},"document":{"type":"NATIONAL_IDENTITY","number":"12345666544"},"merchantId":"12435325235","merchantVerificationValue":"001122"}}}},"WalletPreAuthTransaction":{"title":"WalletPreAuthTransaction","description":"Request to create preAuth primary transaction using digital wallet.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["walletPaymentMethod"],"properties":{"walletPaymentMethod":{"$ref":"#/components/schemas/WalletPaymentMethod"},"authenticationRequest":{"description":"3DS authentication is only applicable for GooglePay and for specific resellers.","$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"description":"3DS authorization is only applicable for GooglePay and for specific resellers.","$ref":"#/components/schemas/AuthenticationResult"},"splitShipment":{"$ref":"#/components/schemas/SplitShipment"},"paymentFacilitator":{"$ref":"#/components/schemas/PaymentFacilitator"},"decrementalFlag":{"$ref":"#/components/schemas/DecrementalPreAuthFlag"},"incrementalFlag":{"$ref":"#/components/schemas/IncrementalPreAuthFlag"}}}],"example":{"requestType":"WalletPreAuthTransaction","walletPaymentMethod":{"walletType":"EncryptedGooglePayWalletPaymentMethod","encryptedGooglePay":{"data":{"encryptedMessage":"8nxjB9mr2tWZeDRQRcGN91UUnb7AioGp3oRo8kmQ6lyvJZiqD7PJlbRCYElNqUmr6Z8zK7b2gO9MKOjpnTCqH0qAe2vuIlwNXB60M2Lh7Qfl3bVgWzwF/FfFcenVW381hoItYi8AjWnWoydz1XMTEv2qhqUG03mEnRXdMyDyk6KKZXoW8Qc0p1F1thbxxu8weU8CZbZsWGGTjB42cilIqLVbribcOAG8Oas1AcgefFsu2hwp4gdSuOg7wmeSV7XKsGQzzVy85qtjuqET2XYzJE3K/Wh9QKkhu5P9Ms5s1+Smr2IjRyidqQa88SxQplrVoo9+PvT0bxFcMspBmO3pLkuaZSUBy++dL2fefcxNJvGCFfFhdxW9DojuuQxgpeu7RAQUsGLyFmr/4ZfBxt882xTmpX9MRx5CAudl9qUgBfKdwWwMX35qSbDTm1ju5XXzNh94VebjD3bB9Zj8qgbmUOr/+6OQLhoFJyBCXgx3EEH8hBwNVFrss/SLwQvFhZh62eO6lOtnmbOtP1yTDDVqGDBfai5SwAmM+KTcc9SGv/xDC+cWe8ck+aCBkG4HoRPapUVMZ3JIgV7yzTsVLJE\\\\u003d\\\\","ephemeralPublicKey":"BGH3fRFdoAobYrAlxnZOCYzkH84Cna92IZxtgsU36CMDaqSaDYb9/LsY8qw+vMtlBnwsUg/YVMOeeKp+qDkOWb4\\\\u003d\\\\","tag":"nvmOUNpnOTZULLhMxT/hWCHzH/4f7gGpfvQgwl3p8ng\\\\u003d\\\\"},"intermediateSigningKey":{"signedKey":{"keyValue":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/1+3HBVSbdv+j7NaArdgMyoSAM43yRydzqdg1TxodSzA96Dj4Mc1EiKroxxunavVIvdxGnJeFViTzFvzFRxyCw\\u003d\\u003d","keyExpiration":"123581321345589"},"signatures":"[\"MEYCIQDcXCoB4fYJF3EolxrE2zB+7THZCfKA7cWxSztKceXTCgIhAN/d5eBgx/1A6qKBdH0IS7/aQ7dO4MuEt26OrLCUxZnl\"]"},"signature":"MEUCIFWTRWUZAOM5nfJC79FtJm56olnbwG4H5uWWxAUWAquiAiEA24j/BcOroeISsdJzYsyoVi8wzu4tnmKw+jdsGfuvPko=","version":"ECv1"}},"splitShipment":{"totalCount":1,"finalShipment":true}}},"PaymentTokenPreAuthTransaction":{"title":"PaymentTokenPreAuthTransaction","description":"Request to create pre-auth transaction using payment token.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentTokenPaymentMethod"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"},"splitShipment":{"$ref":"#/components/schemas/SplitShipment"},"settlementSplit":{"$ref":"#/components/schemas/SettlementSplit"},"authenticationRequest":{"$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"decrementalFlag":{"$ref":"#/components/schemas/DecrementalPreAuthFlag"},"incrementalFlag":{"$ref":"#/components/schemas/IncrementalPreAuthFlag"},"authOptimization":{"$ref":"#/components/schemas/AuthOptimization"}}}],"example":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentTokenPreAuthTransaction","paymentMethod":{"paymentToken":{"value":"1235325235236","function":"DEBIT","securityCode":"977"}},"splitShipment":{"totalCount":1,"finalShipment":true},"incrementalFlag":false,"authOptimizationOverride":"Override"}},"PaymentTokenSaleTransaction":{"title":"PaymentTokenSaleTransaction","description":"Request to create sale transaction using payment token.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentTokenPaymentMethod"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"},"settlementSplit":{"$ref":"#/components/schemas/SettlementSplit"},"authenticationRequest":{"$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"authOptimization":{"$ref":"#/components/schemas/AuthOptimization"},"senderReceiverInfo":{"$ref":"#/components/schemas/SenderReceiverInfo"}}}],"example":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentTokenSaleTransaction","paymentMethod":{"paymentToken":{"value":"1235325235236","function":"DEBIT","securityCode":"977"}},"storedCredentials":{"sequence":"FIRST","scheduled":true},"authOptimizationOverride":"Override"}},"PaymentTokenPayerauthTransaction":{"title":"PaymentTokenPayerauthTransaction","description":"Request to create payerauth transaction using payment token.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentTokenPaymentMethod"},"authenticationRequest":{"$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"}}}],"example":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentTokenPayerauthTransaction","paymentMethod":{"paymentToken":{"value":"1235325235236","function":"DEBIT","securityCode":"977"}}}},"PaymentCardPreAuthTransaction":{"title":"PaymentCardPreAuthTransaction","description":"Request to create pre-auth transaction using credit card.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentCardPaymentMethod"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"},"createToken":{"$ref":"#/components/schemas/CreatePaymentToken"},"splitShipment":{"$ref":"#/components/schemas/SplitShipment"},"settlementSplit":{"$ref":"#/components/schemas/SettlementSplit"},"authenticationRequest":{"$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"decrementalFlag":{"$ref":"#/components/schemas/DecrementalPreAuthFlag"},"incrementalFlag":{"$ref":"#/components/schemas/IncrementalPreAuthFlag"},"authOptimization":{"$ref":"#/components/schemas/AuthOptimization"},"parDataRequested":{"$ref":"#/components/schemas/PaymentAccountReferenceFlag"}}}],"example":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentCardPreAuthTransaction","paymentMethod":{"paymentCard":{"number":"5424180279791732","securityCode":"977","expiryDate":{"month":"12","year":"24"}}},"splitShipment":{"totalCount":1,"finalShipment":true},"incrementalFlag":false,"authOptimizationOverride":"Override"}},"PaymentCardSaleTransaction":{"title":"PaymentCardSaleTransaction","description":"Request to create sale transaction using payment card.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentCardPaymentMethod"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"},"settlementSplit":{"$ref":"#/components/schemas/SettlementSplit"},"createToken":{"$ref":"#/components/schemas/CreatePaymentToken"},"authenticationRequest":{"$ref":"#/components/schemas/AuthenticationRequest"},"authenticationResult":{"$ref":"#/components/schemas/AuthenticationResult"},"authOptimization":{"$ref":"#/components/schemas/AuthOptimization"},"parDataRequested":{"$ref":"#/components/schemas/PaymentAccountReferenceFlag"},"senderReceiverInfo":{"$ref":"#/components/schemas/SenderReceiverInfo"}}}],"example":{"transactionAmount":{"total":12.04,"currency":"GBP"},"requestType":"PaymentCardSaleTransaction","paymentMethod":{"paymentCard":{"number":"5424180279791732","securityCode":"977","expiryDate":{"month":"12","year":"24"}}},"storedCredentials":{"sequence":"FIRST","scheduled":true},"authOptimizationOverride":"Override"}},"PaymentDevicePreAuthTransaction":{"title":"PaymentDevicePreAuthTransaction","description":"Request to create pre-auth transaction using decrypted card details from payment device. The transaction origin will be fixed as PHONE when data is manually entered into the device and as RETAIL when data is entered into the device via swipe.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentDevicePaymentMethod"},"createToken":{"$ref":"#/components/schemas/CreatePaymentToken"},"settlementSplit":{"$ref":"#/components/schemas/SettlementSplit"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"},"splitShipment":{"$ref":"#/components/schemas/SplitShipment"},"decrementalFlag":{"$ref":"#/components/schemas/DecrementalPreAuthFlag"},"incrementalFlag":{"$ref":"#/components/schemas/IncrementalPreAuthFlag"}}}],"example":{"requestType":"PaymentDevicePreAuthTransaction","transactionAmount":{"total":12.04,"currency":"GBP"},"paymentMethod":{"paymentDevice":{"deviceType":"SWIPE","data":"02A600C0170018008292;5424********1732=1810?*B73CD8C26233D4FFEC5500ED394439D97DDA5F530942D21D0000000000000000000000000000000000000000363434543035353734326299492410027300000260DC03","securityCode":"977","cardholderName":"First Cardholder","cardFunction":"CREDIT","brand":"VISA"}},"incrementalFlag":false}},"PaymentDeviceSaleTransaction":{"title":"PaymentDeviceSaleTransaction","description":"Request to create sale transaction using decrypted card details from payment device. The transaction origin will be fixed as PHONE when data is manually entered into the device and as RETAIL when data is entered into the device via swipe.","allOf":[{"$ref":"#/components/schemas/PrimaryTransaction"},{"type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentDevicePaymentMethod"},"createToken":{"$ref":"#/components/schemas/CreatePaymentToken"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"},"senderReceiverInfo":{"$ref":"#/components/schemas/SenderReceiverInfo"}}}],"example":{"requestType":"PaymentDeviceSaleTransaction","transactionAmount":{"total":12.04,"currency":"GBP"},"paymentMethod":{"paymentDevice":{"deviceType":"SWIPE","data":"02A600C0170018008292;5424********1732=1810?*B73CD8C26233D4FFEC5500ED394439D97DDA5F530942D21D0000000000000000000000000000000000000000363434543035353734326299492410027300000260DC03","securityCode":"977","cardholderName":"First Cardholder","cardFunction":"CREDIT","brand":"VISA"}},"deprecated":true}},"SenderInfo":{"description":"Sender information for a disbursement transaction.","properties":{"name":{"description":"Sender name.","type":"string","maxLength":30,"pattern":"^(?!\\s*$).+","example":"Franklin D. Roosevelt"},"firstName":{"description":"First Name.","type":"string","maxLength":35,"pattern":"^(?!\\s*$).+","example":"John"},"middleName":{"description":"Middle Name.","type":"string","maxLength":35,"pattern":"^(?!\\s*$).+","example":"Doe"},"lastName":{"description":"Last Name.","type":"string","maxLength":35,"pattern":"^(?!\\s*$).+","example":"Doe"},"streetAddress":{"description":"Sender street address.","type":"string","maxLength":50,"pattern":"^(?!\\s*$).+","example":"5565 Glenridge Connector"},"city":{"description":"Sender city.","type":"string","maxLength":25,"pattern":"^(?!\\s*$).+","example":"Atlanta"},"stateCode":{"description":"Sender state.","type":"string","pattern":"[A-Z0-9]{2,3}","example":"GA"},"countryCode":{"description":"Sender country code.","type":"string","pattern":"[A-Z]{2}","example":"US"},"postalCode":{"description":"Sender postal code.","type":"string","pattern":"^(?![\\s-])[a-zA-Z0-9\\s-]{1,9}[a-zA-Z0-9]$","example":"30342-3456"},"phoneNumber":{"description":"Sender phone number. This field allows phone number including optional plus sign, country codes and commonly used separators like space, dot, hyphen and parenthesis.","type":"string","pattern":"^\\+?(\\d{1,3})?[-.\\s]?(\\(?\\d{1,4}\\)?)?[-.\\s]?\\d{1,4}[-.\\s]?\\d{1,4}[-.\\s]?\\d{1,9}$","example":"+91-8992664532"},"birthDate":{"description":"Sender date of birth (YYYYMMDD).","type":"string","pattern":"^([0-9]{4})(1[0-2]|0[1-9])(3[01]|0[1-9]|[12][0-9])$","example":"19560121"},"referenceNumber":{"description":"Sender reference number.","type":"string","maxLength":19,"pattern":"^(?!\\s*$).+","example":"123456"},"accountNumber":{"description":"Sender account number.","type":"string","maxLength":19,"pattern":"^(?!\\s*$).+","example":"135246"},"accountType":{"$ref":"#/components/schemas/AccountType"},"participationId":{"description":"Sender participation id.","type":"string","maxLength":30,"pattern":"^(?!\\s*$).+","example":"123456789123456789123456789123"}},"example":{"name":"Franklin Sender Roosevelt","firstName":"John","middleName":"Doe","lastName":"Lincoln","streetAddress":"5565 Glenridge Connector","city":"Atlanta","stateCode":"GA","countryCode":"US","postalCode":"30342","phoneNumber":"4044040740","birthDate":"19560121","referenceNumber":"12345678","accountNumber":"135246","accountType":"EMAIL","participationId":"123456789123456789123456789123"}},"ReceiverInfo":{"description":"Receiver information for a funding transaction.","properties":{"name":{"description":"Receiver name.","type":"string","maxLength":70,"pattern":"^(?!\\s*$).+","example":"George Washington"},"firstName":{"description":"First Name.","type":"string","maxLength":35,"pattern":"^(?!\\s*$).+","example":"John"},"middleName":{"description":"Middle Name.","type":"string","maxLength":35,"pattern":"^(?!\\s*$).+","example":"Doe"},"lastName":{"description":"Last Name.","type":"string","maxLength":35,"pattern":"^(?!\\s*$).+","example":"Doe"},"streetAddress":{"description":"Receiver street address.","type":"string","maxLength":50,"pattern":"^(?!\\s*$).+","example":"5565 Glenridge Connector"},"city":{"description":"Receiver city.","type":"string","maxLength":25,"pattern":"^(?!\\s*$).+","example":"Atlanta"},"stateCode":{"description":"Receiver state.","type":"string","pattern":"[A-Z0-9]{2,3}","example":"GA"},"countryCode":{"description":"Receiver country code.","type":"string","pattern":"[A-Z]{2}","example":"US"},"postalCode":{"description":"Receiver postal code.","type":"string","pattern":"^(?![\\s-])[a-zA-Z0-9\\s-]{1,9}[a-zA-Z0-9]$","example":"30342-3456"},"phoneNumber":{"description":"Receiver phone number. This field allows phone number including optional plus sign, country codes and commonly used separators like space, dot, hyphen and parenthesis.","type":"string","pattern":"^\\+?(\\d{1,3})?[-.\\s]?(\\(?\\d{1,4}\\)?)?[-.\\s]?\\d{1,4}[-.\\s]?\\d{1,4}[-.\\s]?\\d{1,9}$","example":"+91-8992664532"},"referenceNumber":{"description":"Receiver reference number.","type":"string","maxLength":19,"pattern":"^(?!\\s*$).+","example":"123456"},"accountNumber":{"description":"Receiver account number.","type":"string","maxLength":50,"pattern":"^(?!\\s*$).+","example":"135246"},"accountType":{"$ref":"#/components/schemas/AccountType"}},"example":{"name":"Abraham Receiver Lincoln","firstName":"John","middleName":"Doe","lastName":"Lincoln","streetAddress":"5565 Glenridge Connector","city":"Atlanta","stateCode":"GA","countryCode":"US","postalCode":"30342","phoneNumber":"4044040740","referenceNumber":"12345678","accountNumber":"135246","accountType":"EMAIL"}},"AccountType":{"description":"Indicates the Sender and Receiver Account Type","type":"string","enum":["BANK_ACCOUNT_NO_AND_BIC","CARD_ACCOUNT_NO","EMAIL","IBAN","OTHER","PHONE_NUMBER","ROUTING_TRANSIT_NO_AND_BANK_ACCOUNT_NO","SOCIAL_NETWORK_ID","WALLET_ID"],"example":"EMAIL"},"SenderReceiverInfo":{"description":"Sender and Receiver Information","required":["senderInfo","receiverInfo"],"properties":{"senderInfo":{"$ref":"#/components/schemas/SenderInfo"},"receiverInfo":{"$ref":"#/components/schemas/ReceiverInfo"}}},"PrimaryTransaction":{"required":["requestType","transactionAmount"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the primary transaction request.","type":"string","example":"PaymentCardSaleTransaction"},"transactionAmount":{"$ref":"#/components/schemas/Amount"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"},"userId":{"type":"string","description":"This is the store's userID (not store-id) from where the product was purchased.","maxLength":128,"example":"1001"},"merchantTransactionId":{"description":"The unique merchant transaction ID from the request header, if supplied.","type":"string","maxLength":40,"example":"30dd879c-ee2f-11db-8314-0800200c9a66"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"},"order":{"$ref":"#/components/schemas/Order"},"ipgTransactionId":{"description":"The IPG transactionId to reference a payerauth for example.","type":"integer","format":"int64","nullable":true,"example":8154886515},"allowPartialApproval":{"description":"Indicates if the particular transaction is a partial approval transaction, if supplied.","type":"boolean","example":true},"parentUri":{"type":"string","format":"uri","description":"To embed IPG hosted payment pages inside an iFrame this parameter is used (maximum length  2048 characters) to specify an URL of a page.","example":"https://www.acme.com"}},"example":{"requestType":"PaymentCardSaleTransaction","transactionAmount":{"total":12.04,"currency":"GBP"},"paymentMethod":{"paymentCard":{"number":"5424180279791732","securityCode":"977","expiryDate":{"month":"12","year":"24"}}},"parentUri":"https://www.acme.com"}},"AdditionalDetails":{"description":"Merchant supplied tracking numbers.","properties":{"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"},"comments":{"description":"Comments for the payment.","type":"string","maxLength":1024,"example":"This is a comment"},"invoiceNumber":{"description":"Invoice number.","type":"string","maxLength":48,"example":"551294633441"},"invoicePeriod":{"description":"Invoice period in format month/year (MM/yy).","type":"string","maxLength":5,"pattern":"(0[1-9]|1[0-2])[/][0-9][0-9]","example":"12/21"},"purchaseOrderNumber":{"description":"Purchase order number.","type":"string","maxLength":128,"example":"1223456"},"mrchntRefData":{"description":"Merchant Reference Data 2.","type":"string","maxLength":30,"example":"1223456"},"emiAccountInformation":{"$ref":"#/components/schemas/EmiAccountInformation"},"operatorId":{"description":"The operator ID.","type":"string","maxLength":35,"pattern":"^\\S$|^\\S.*\\S$"},"salesSystemId":{"description":"The sales system ID.","type":"string","maxLength":50,"pattern":"^\\S$|^\\S.*\\S$"},"ipgDeferredAuth":{"description":"Indicates if the particular transaction is a deferred authorization.","type":"boolean","example":true},"highRiskPurchaseIndicator":{"description":"this is highRiskPurchaseIndicator.","type":"boolean","example":true},"receipts":{"description":"Provides request information that is necessary to generate receipts.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/components/schemas/ReceiptRequestInfo"},"example":[{"type":"cardholder","locale":"de-DE"},{"type":"merchant","locale":"en","linewidth":32}]},"scaExemptionType":{"description":"Strong customer authentication exemption type indicator.","type":"string","enum":["Low Value Exemption","TRA Exemption","Trusted Merchant Exemption","SCP Exemption","Delegated Authentication","Authentication Outage Exception"],"example":"TRA Exemption"},"scaVisaMerchantID":{"description":"Eight-character Visa merchant identifier (VMID) assigned by Visa, required for trusted merchant and delegated authentication.","type":"string","maxLength":8,"example":"12312311"},"businessApplicationIdentifier":{"description":"Indicates the indended use of the Account Funding Transaction. For Visa Only.","type":"string","enum":["ACCOUNT_TO_ACCOUNT","BANK_INITIATED_TRANSFER","BUSINESS_TO_BUSINESS","CARD_BILL_PAYMENT","CASH_DEPOSIT","CUSTOMER_BILL_PAYMENT","FAST_REFUND","FUNDS_DISBURSEMENT","FUND_TRANSFER","GAMBLING_PAYOUT","GENERAL_FUNDS_DISBURSEMENT","GOVERNMENT_DISBURSEMENT","LIQUID_ASSETS","LOYALTY_PAYMENTS","MERCHANT_DISBURSEMENT","MERCHANT_PAYMENT","NON_CARD_BILL_PAYMENT","ONLINE_GAMBLING_PAYOUT","PAYROLL_OR_PENSION_DISBURSEMENT","PERSON_TO_PERSON","REQUEST_TO_PAY_SERVICE","TOPUP_FOR_ENHANCED_PREPAID_LOADS","WALLET_TRANSFER"],"example":"ACCOUNT_TO_ACCOUNT"},"transactionTypeIdentifier":{"description":"Indicates the indended use of the Account Funding Transaction. For Mastercard Only.","type":"string","enum":["AGENTS_CASH_OUT_MONEY_SEND","AGENTS_CASH_OUT_MONEY_TRANSFER","BUSINESS_DISBURSEMENT_MONEY_SEND","BUSINESS_DISBURSEMENT_MONEY_TRANSFER","BUSINESS_TO_BUSINESS_MONEY_SEND","BUSINESS_TO_BUSINESS_MONEY_TRANSFER","CARD_BILL_PAYMENT_MONEY_SEND","CARD_BILL_PAYMENT_MONEY_TRANSFER","CASH_IN_AT_ATM","CASH_IN_AT_PO","FAST_REFUND_TO_ORIGINAL_CARD","GOVERNMENT_DISBURSEMENT_NONPROFIT","OWN_ACCOUNT_MONEY_SEND","OWN_ACCOUNT_MONEY_TRANSFER","OWN_DEBIT_PREPAID_TRANSFER","OWN_WALLET_TRANSFER","OWN_WALLET_TRANSFER_MONEY_SEND","PERSON_TO_PERSON_CARD_ACCOUNT","PERSON_TO_PERSON_MONEY_SEND","PERSON_TO_PERSON_MONEY_TRANSFER","RAPID_MERCHANT_SETTLEMENT"],"example":"BUSINESS_DISBURSEMENT_MONEY_SEND"},"marketplaceForeignRetailerIndicator":{"description":"set it to F if the retailer is located in a different country outside of the market place.","type":"string","maxLength":1,"pattern":"(F|)","example":"F"},"deviceIntelligence":{"$ref":"#/components/schemas/DeviceIntelligenceDetail"},"deferredPayment":{"description":"Indicates if the particular transaction is a deferred payment.","type":"boolean","example":true},"taxRefundRequestData":{"$ref":"#/components/schemas/TaxRefundRequestData"},"acceptorGeoCoordinates":{"description":"Geo Location of the Merchant Acquirer.","$ref":"#/components/schemas/GeoLocation"}},"example":{"comments":"This is a comment","invoiceNumber":"551294633441","invoicePeriod":"12/19","purchaseOrderNumber":"1223456","operatorId":"OPERATOR_ID_123XXX","salesSystemId":"W-EU-H3866-FLS2","ipgDeferredAuth":true,"allowPartialApproval":true,"highRiskPurchaseIndicator":true,"receipts":[{"type":"cardholder","locale":"fr"}],"scaExemptionType":"Low Value Exemption","scaVisaMerchantID":"12312311","businessApplicationIdentifier":"ACCOUNT_TO_ACCOUNT","transactionTypeIdentifier":"BUSINESS_DISBURSEMENT_MONEY_SEND","marketplaceForeignRetailerIndicator":"F","acceptorGeoCoordinates":{"latitude":34.67676,"longitude":34.67778}}},"EmiAccountInformation":{"description":"Account information required for EMI transactions","properties":{"accountBin":{"description":"Account BIN information.","type":"string","example":"411111"},"accountLast4":{"description":"Last 4 digits of the account number","type":"string","maxLength":4,"example":"4111"}}},"MerchantParameters":{"description":"To remain compliant the custom fields are not to be used to submit credit card detail or sensitive card holder information, please use the designated fields defined by the Gateway for this purpose.","type":"string","additionalProperties":{"type":"string"}},"DeviceIntelligenceDetail":{"description":"Device detail to be captured for fraud mitigation","properties":{"vendor":{"description":"Vendor information of the device","type":"string","maxLength":100},"sessionID":{"description":"Session id of the request","type":"string","maxLength":100},"userAgent":{"description":"Device user agent","type":"string","maxLength":100},"id":{"description":"Device ID that has been used","type":"string","maxLength":100},"type":{"description":"Type of Device Used","type":"string","maxLength":100},"operatingSystem":{"description":"OS of Device Used","type":"string","maxLength":100},"model":{"description":"Model of Device Used","type":"string","maxLength":100},"manufacturer":{"description":"Manufacturer of Device used","type":"string","maxLength":100}}},"PostAuthTransaction":{"title":"PostAuthTransaction","description":"Request to perform post auth transaction.","allOf":[{"$ref":"#/components/schemas/SecondaryTransaction"},{"type":"object","required":["transactionAmount"],"properties":{"transactionAmount":{"$ref":"#/components/schemas/Amount"},"transactionOrigin":{"$ref":"#/components/schemas/TransactionOrigin"},"splitShipment":{"$ref":"#/components/schemas/SplitShipment"},"softDescriptor":{"$ref":"#/components/schemas/SoftDescriptor"},"parDataRequested":{"$ref":"#/components/schemas/PaymentAccountReferenceFlag"}}}],"example":{"requestType":"PostAuthTransaction","transactionAmount":{"total":12.04,"currency":"GBP"},"splitShipment":{"totalCount":1,"finalShipment":true}}},"ReturnTransaction":{"title":"ReturnTransaction","description":"Request to perform return transaction.","allOf":[{"$ref":"#/components/schemas/SecondaryTransaction"},{"type":"object","required":["transactionAmount"],"properties":{"transactionAmount":{"$ref":"#/components/schemas/Amount"},"softDescriptor":{"$ref":"#/components/schemas/SoftDescriptor"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"}}}],"example":{"requestType":"ReturnTransaction","transactionAmount":{"total":12.04,"currency":"GBP"}}},"VoidTransaction":{"title":"VoidTransaction","description":"Request to perform void transaction.","allOf":[{"$ref":"#/components/schemas/SecondaryTransaction"},{"type":"object","properties":{"transactionAmount":{"$ref":"#/components/schemas/Amount"},"reversalReason":{"$ref":"#/components/schemas/ReversalReason"}}}],"example":{"requestType":"VoidTransaction","comments":"This is a comment"}},"VoidPreAuthTransactions":{"title":"VoidPreAuthTransactions","description":"Request to perform a void of all authorizations associated with the current order. This request type is applicable for voiding preauth and incremental preauth transactions.","allOf":[{"$ref":"#/components/schemas/SecondaryTransaction"},{"type":"object","properties":{"reversalReason":{"$ref":"#/components/schemas/ReversalReason"}}}],"example":{"requestType":"VoidPreAuthTransactions","comments":"This is a comment"}},"RefreshTransaction":{"title":"RefreshTransaction","description":"Request to check/update an existing APM transaction state.","allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"integrationData":{"description":"Integration data to provide information from the application.","type":"array","items":{"$ref":"#/components/schemas/IntegrationData"}},"consumerData":{"description":"Integration data provided by the payer.","type":"array","items":{"$ref":"#/components/schemas/ConsumerData"}}}}],"example":{"requestType":"RefreshTransaction","integrationData":[{"item":"RETURN_URL","value":"https://clientdomain.com/orderDetails"},{"item":"PAYER_IP","value":"1.1.1.1"}],"consumerData":[{"item":"EMAIL_ADDRESS","value":"consumer@mail.com"}]}},"RefreshOrder":{"title":"RefreshOrder","description":"Request to check/update an existing APM order state.","allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"integrationData":{"description":"Integration data to provide information from the application.","type":"array","items":{"$ref":"#/components/schemas/IntegrationData"}},"consumerData":{"description":"Integration data provided by the payer.","type":"array","items":{"$ref":"#/components/schemas/ConsumerData"}}}}],"example":{"requestType":"RefreshOrder","integrationData":[{"item":"RETURN_URL","value":"https://clientdomain.com/orderDetails"},{"item":"PAYER_IP","value":"1.1.1.1"}],"consumerData":[{"item":"EMAIL_ADDRESS","value":"consumer@mail.com"}]}},"UpdateTransaction":{"title":"UpdateTransaction","description":"Request to update an existing transaction to provide additional information.","allOf":[{"$ref":"#/components/schemas/Action"},{"type":"object","properties":{"integrationData":{"description":"Integration data to provide information from the application.","type":"array","items":{"$ref":"#/components/schemas/IntegrationData"}},"consumerData":{"description":"Integration data provided by the payer.","type":"array","items":{"$ref":"#/components/schemas/ConsumerData"}},"merchantParameters":{"$ref":"#/components/schemas/MerchantParameters"}}}],"example":{"requestType":"UpdateTransaction","integrationData":[{"item":"RETURN_URL","value":"https://clientdomain.com/orderDetails"},{"item":"PAYER_IP","value":"1.1.1.1"}],"consumerData":[{"item":"EMAIL_ADDRESS","value":"consumer@mail.com"}],"merchantParameters":{"param1":"value1","param2":"value2"}}},"PreAuthSecondaryTransaction":{"title":"PreAuthSecondaryTransaction","description":"Request to perform pre-auth incremental secondary transaction without providing credit card information.","allOf":[{"$ref":"#/components/schemas/SecondaryTransaction"},{"type":"object","required":["transactionAmount"],"properties":{"transactionAmount":{"$ref":"#/components/schemas/Amount"},"decrementalFlag":{"$ref":"#/components/schemas/DecrementalPreAuthFlag"},"incrementalFlag":{"$ref":"#/components/schemas/IncrementalPreAuthFlag"}}}],"example":{"requestType":"PreAuthSecondaryTransaction","transactionAmount":{"total":"5.00","currency":"GBP"},"decrementalFlag":false,"incrementalFlag":false}},"SecondaryTransaction":{"description":"Model for secondary financial transactions. Abstract class, do not use this class directly, use one of its children.","required":["requestType"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the secondary transaction request.","type":"string","example":"PostAuthTransaction"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same developer app.","type":"string","maxLength":20,"example":"12345500000"},"userId":{"type":"string","description":"This is the store's userID (not store-id) from where the product was purchased.","maxLength":128,"example":"1001"},"merchantTransactionId":{"description":"The unique merchant transaction ID from the request, if supplied.","type":"string","maxLength":40,"example":"lsk23532djljff3"},"comments":{"description":"Comment for the secondary transaction.","type":"string","example":"This is a comment"},"order":{"$ref":"#/components/schemas/Order"},"terminalId":{"description":"Unique identifier for the payment terminal where the transaction takes place.","type":"string","minLength":6,"maxLength":32,"example":123456},"merchantId":{"description":"Unique identifier for the merchant conducting the transaction.","type":"string","minLength":6,"maxLength":32,"example":123456}},"example":{"requestType":"ReturnTransaction","transactionAmount":{"total":3,"currency":"GBP"}}},"Action":{"description":"Model for financial actions. Abstract class, do not use this class directly, use one of its children.","required":["requestType"],"discriminator":{"propertyName":"requestType","mapping":{"RefreshTransaction":"#/components/schemas/RefreshTransaction","UpdateTransaction":"#/components/schemas/UpdateTransaction","RefreshOrder":"#/components/schemas/RefreshOrder"}},"properties":{"requestType":{"description":"Object name of the action request.","type":"string","example":"UpdateTransaction"},"comments":{"description":"Comment for the action.","type":"string","example":"This is a comment"}},"example":{"requestType":"UpdateTransaction","comments":"This is a comment"}},"SplitShipment":{"description":"Split-shipment related information, in order to reuse the same authorization.","properties":{"totalCount":{"description":"Total count of the shipment, can be set at preauth or the first postauth.","type":"integer","format":"int32","example":5},"finalShipment":{"description":"Indicates whether the transaction is the final shipment.","type":"boolean","default":false}},"example":{"totalCount":1,"finalShipment":true}},"SubMerchantSplit":{"description":"Sub-merchant split object for SettlementSplit.","required":["merchantID","amount"],"properties":{"merchantID":{"description":"ID of merchant for tracking.","type":"string","maxLength":15,"pattern":"[0-9]{1,15}","example":"100000001"},"amount":{"description":"The amount each sub-merchant receives.","type":"number","example":25.06}},"example":{"merchantID":"100000001","amount":25.06}},"SettlementSplit":{"description":"Settle with multiple sub-merchants, sale and preAuth only.","type":"array","minItems":1,"maxItems":5,"items":{"$ref":"#/components/schemas/SubMerchantSplit"},"example":[{"merchantID":"100000001","amount":25.06},{"merchantID":"100000002","amount":15.07}]},"AdditionalTransactionDetails":{"description":"Additional transaction details for transaction response.","properties":{"comments":{"description":"Comment for the payment.","type":"string","maxLength":1024,"example":"This is a comment"},"invoiceNumber":{"description":"Invoice number.","type":"string","maxLength":48,"example":"551294633441"},"purchaseOrderNumber":{"description":"Purchase order number.","type":"string","maxLength":128,"example":"1223456"},"disbursementTransType":{"description":"The type of debit disbursement transaction.","type":"string","enum":["FUNDING","DISBURSEMENT"],"example":"FUNDING"},"walletProvider":{"description":"The wallet provider type.","type":"string","enum":["GOOGLE_PAY","APPLE_PAY","CLICK_TO_PAY"],"example":"APPLE_PAY"},"receipts":{"description":"Provides receipt response data, if it has been requested.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/components/schemas/Receipt"},"example":[{"type":"cardholder","data":[{"endOfLine":true,"text":"--------------------------------"},{"endOfLine":true,"text":"              SALE              "}]},{"type":"merchant","data":[{"endOfLine":true,"text":"        Example Merchant        "},{"endOfLine":true,"text":"--------------------------------"}]}]},"additionalResponseData":{"$ref":"#/components/schemas/AdditionalResponseData"}},"example":{"comments":"This is a comment","invoiceNumber":"551294633441","purchaseOrderNumber":"1223456"}},"AdditionalResponseData":{"description":"Additional Response Data.","properties":{"issuingBankName":{"description":"Issuing Bank Name.","type":"string","maxLength":18,"example":"USA Bank"},"countryOfIssuance":{"description":"Country of Issuance.","type":"string","maxLength":3,"example":"USA"},"cardProductID":{"description":"Card Product ID.","type":"string","maxLength":1,"example":"H"},"detailedProductID":{"description":"Detailed Product ID.","type":"string","maxLength":3,"example":"C"},"associationResponseCodeAdtl":{"description":"Association Response Code.","type":"string","maxLength":3,"example":"00"},"cardBrand":{"description":"Card Brand.","type":"string","maxLength":1,"example":"M"},"deferredAuthTransactionID":{"description":"Deferred Auth Transaction ID for re-authorized (Optimized) transaction","type":"string","maxLength":16,"example":"3561032059730219"}}},"TransactionType":{"description":"Type of transaction to perform. Primary transaction types in requests include 'SALE', 'PREAUTH', 'CREDIT' and 'FORCED_TICKET'.","type":"string","enum":["SALE","PREAUTH","VOID","RETURN","POSTAUTH","PAYER_AUTH"],"example":"SALE"},"TransactionOrigin":{"description":"The source of the transaction. The possible values are ECOM (if the order was received via email or Internet), MOTO (mail order, telephone order), MAIL, PHONE and RETAIL (face to face).","type":"string","enum":["ECOM","MOTO"],"example":"ECOM"},"DecrementalPreAuthFlag":{"description":"This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to either increase the preAuth amount (DecrementalPreAuthFlag = false) or decrease the preAuth amount (DecrementalPreAuthFlag = true).","type":"boolean","default":false,"example":false},"IncrementalPreAuthFlag":{"description":"This flag can only be used in a preAuth transaction that updates the amount of a previous preAuth transaction to increase the preAuth amount (IncrementalPreAuthFlag = true).","type":"boolean","default":false,"example":false},"PaymentAccountReferenceFlag":{"description":"Indicates if the merchant wants payment account reference number from the network token using endpoint(PaymentAccountReferenceFlag = true).","type":"boolean","default":false,"example":false},"Amount":{"description":"Amount of the transaction.","required":["total","currency"],"properties":{"total":{"description":"Sub component values must add up to total amount.","type":"number","minimum":0,"example":10.24},"currency":{"description":"ISO 4217 currency code. Note: Only 'GBP' is supported currently.","type":"string","pattern":"([A-Z]{3})|([0-9]{3})","example":"GBP"},"components":{"$ref":"#/components/schemas/AmountComponents"}},"example":{"total":10.24,"currency":"GBP","components":{"subtotal":8,"localTax":1,"shipping":1.24}}},"TransactionAmount":{"description":"Amount of the transaction.","properties":{"total":{"description":"Sub component values must add up to total amount.","type":"number","minimum":0,"example":10.24},"currency":{"description":"ISO 4217 currency code. Note: Only 'GBP' is supported currently.","type":"string","pattern":"([A-Z]{3})|([0-9]{3})","example":"GBP"},"components":{"$ref":"#/components/schemas/ResponseAmountComponents"}},"example":{"total":10.24,"currency":"GBP","components":{"subtotal":8,"localTax":1,"shipping":1.24}}},"AmountComponents":{"description":"Transaction amounts with multiple components.","properties":{"subtotal":{"description":"Subtotal amount.","type":"number","example":8},"vatAmount":{"description":"Value-added tax amount.","type":"number","example":0},"localTax":{"description":"Local tax amount.","type":"number","example":1},"shipping":{"description":"Shipping amount.","type":"number","example":1.24},"cashback":{"description":"Cashback amount.","type":"number","example":2},"tip":{"description":"Tip amount.","type":"number","example":6},"surcharge":{"description":"Surcharge amount.","type":"number","example":2.5},"nonTaxableAmount":{"description":"nontaxable amount.","type":"number","example":10}},"example":{"subtotal":8,"vatAmount":0,"localTax":1,"shipping":1.24,"cashback":2,"tip":6,"surcharge":2.5}},"ResponseAmountComponents":{"description":"Amount component details, used in responses.","allOf":[{"type":"object","properties":{"convenienceFee":{"description":"Amount added for proccessing or handling fees.","type":"number","example":2}}},{"$ref":"#/components/schemas/AmountComponents"}],"example":{"subtotal":8,"vatAmount":0,"localTax":1.3,"convenienceFee":2}},"ApmPaymentMethod":{"description":"Payment method containing APM specific information, which is intentionally weakly-typed to allow for reduced coupling of APM plugins.","allOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"object","required":["type"],"properties":{"type":{"description":"Type of payment method.","type":"string","enum":["NATWEST_PAYIT"]},"paymentToken":{"description":"Only applicable for types: BLIK, PAYPAL. Token/HostedDataId that has been created for the user account.","type":"string","pattern":"[A-Za-z0-9-]{1,128}"}}}]},"IntegrationData":{"x-hide-model":true,"description":"Provides integration data details from the application.","type":"object","required":["item"],"properties":{"item":{"description":"Application item key for integration data. Possible items keys: ALIAS_KEY, ALIAS_LABEL, ALIAS_TYPE, CANCEL_BY_USER, ENDPOINT_REFERENCE_NUMBER, FAILURE_RETURN_URL, PAYER_IP, RECURRING_EXPIRATION_DATE, RECURRING_FREQUENCY, RECURRING_LIMIT_AMOUNT, RECURRING_LIMIT_IS_FIXED, RECURRING_MANDATORY, RECURRING_NO_DELAY, RECURRING_REFUSE_NO_PAYID, RECURRING_TOTAL_LIMIT_AMOUNT, RETURN_URL, UPDATED_AMOUNT_CURRENCY, UPDATED_AMOUNT_VALUE, UPDATED_SHIPPING_AMOUNT, USER_AGENT, CANCEL_BY_USER","type":"string"}},"discriminator":{"propertyName":"item","mapping":{"CANCEL_BY_USER":"#/components/schemas/StringIntegrationData","ENDPOINT_REFERENCE_NUMBER":"#/components/schemas/StringIntegrationData","FAILURE_RETURN_URL":"#/components/schemas/StringIntegrationData","PAYER_IP":"#/components/schemas/StringIntegrationData","RECURRING_EXPIRATION_DATE":"#/components/schemas/DateTimeIntegrationData","RECURRING_FREQUENCY":"#/components/schemas/StringIntegrationData","RECURRING_LIMIT_AMOUNT":"#/components/schemas/NumberIntegrationData","RECURRING_LIMIT_IS_FIXED":"#/components/schemas/BooleanIntegrationData","RECURRING_MANDATORY":"#/components/schemas/BooleanIntegrationData","RECURRING_NO_DELAY":"#/components/schemas/BooleanIntegrationData","RECURRING_REFUSE_NO_PAYID":"#/components/schemas/BooleanIntegrationData","RECURRING_TOTAL_LIMIT_AMOUNT":"#/components/schemas/NumberIntegrationData","RETURN_URL":"#/components/schemas/StringIntegrationData","UPDATED_AMOUNT_CURRENCY":"#/components/schemas/StringIntegrationData","UPDATED_AMOUNT_VALUE":"#/components/schemas/StringIntegrationData","UPDATED_SHIPPING_AMOUNT":"#/components/schemas/StringIntegrationData","USER_AGENT":"#/components/schemas/StringIntegrationData"}}},"BooleanIntegrationData":{"description":"Boolean type integration data.","allOf":[{"$ref":"#/components/schemas/IntegrationData"},{"type":"object","properties":{"value":{"description":"Boolean value integration data.","type":"boolean","example":true}},"required":["value"]}],"example":{"item":"RECURRING_LIMIT_IS_FIXED","value":false}},"DateTimeIntegrationData":{"description":"Date and time type integration data.","allOf":[{"$ref":"#/components/schemas/IntegrationData"},{"type":"object","properties":{"value":{"description":"Date and time type for integration data.","type":"string","format":"date-time","example":"2024-01-30T08:30:50+01:00"}},"required":["value"]}],"example":{"item":"RECURRING_EXPIRATION_DATE","value":"2024-01-30T08:30:50+01:00"}},"NumberIntegrationData":{"description":"Number type integration data.","allOf":[{"$ref":"#/components/schemas/IntegrationData"},{"type":"object","properties":{"value":{"description":"Number type for integration data.","type":"number","example":1.23}},"required":["value"]}],"example":{"item":"RECURRING_LIMIT_AMOUNT","value":1.99}},"StringIntegrationData":{"description":"String type integration data.","allOf":[{"$ref":"#/components/schemas/IntegrationData"},{"type":"object","properties":{"value":{"description":"Text value of integration data.","type":"string","minLength":1,"maxLength":2048,"example":"DATA"}},"required":["value"]}],"example":{"item":"RETURN_URL","value":"https://clientdomain.com/orderDetails"}},"ConsumerData":{"description":"Consumer data details provided by the payer.","type":"object","required":["item","value"],"properties":{"item":{"$ref":"#/components/schemas/ConsumerDataItem"},"value":{"description":"Value of consumer data.","type":"string","minLength":1,"maxLength":2048,"example":"1234"}},"example":{"item":"BLIK_CODE","value":"123456"}},"ConsumerDataItem":{"description":"Type of consumer data item.","type":"string","enum":["ACCOUNT_IDENTIFIER","BLIK_CODE","EMAIL_ADDRESS","ETRANSFER_CHANNEL"],"example":"BLIK_CODE"},"RequiredActions":{"description":"Provides details which actions need to be performed to fulfill requirements of integration data.","properties":{"requiredConsumerData":{"description":"Consumer data details which need to be provided by the payer.","type":"array","items":{"$ref":"#/components/schemas/RequiredConsumerData"}},"requiredIntegrationData":{"description":"Provides details for data requested from the application.","type":"array","items":{"$ref":"#/components/schemas/RequiredIntegrationData"}},"requiredRedirectionData":{"$ref":"#/components/schemas/RequiredRedirectionData"}}},"RequiredConsumerData":{"description":"Provides details for data requested from the payer.","type":"object","properties":{"hint":{"description":"Description of required data that need to be provided.","type":"string","maxLength":2048},"validationExpression":{"description":"Regexp validation expression for requested data.","type":"string","maxLength":2048},"key":{"description":"Key for required data item.","type":"string","maxLength":2048},"options":{"description":"Provides for the consumer data possible options to select a value from.","type":"array","items":{"$ref":"#/components/schemas/ApmOption"}}},"example":{"hint":"Your 6-digit Code will be provided in your mobile application","validationExpression":"^\\\\d{6}$","key":"BLIK_CODE"}},"RequiredIntegrationData":{"description":"Provides details for data requested from the application.","type":"object","properties":{"hint":{"description":"Description of required integration data that need to be provided.","type":"string","maxLength":2048},"key":{"description":"Key for required data item.","type":"string","maxLength":2048}},"example":{"hint":"Payment requires the user agent information on the browser/device.","key":"USER_AGENT"}},"ApmOption":{"description":"Provide details for a consumer data option.","type":"object","properties":{"displayName":{"description":"Name of the option.","type":"string","pattern":"[A-Za-z0-9\\s]{1,50}","example":"First National Bank"},"iconUrl":{"description":"URL to the logo used for the option","type":"string","format":"uri","example":"https://www.ipg-online.com/connect/bankLogo.png"},"id":{"description":"Unique identifier to be sent back in the response, if this option has been chosen.","type":"string","pattern":"[A-Za-z0-9]{1,50}","example":"fnsTknBFirstNationalBank"},"groupName":{"description":"Options can be grouped via this name.","type":"string","pattern":"[A-Za-z0-9]{1,50}","example":"TokenBanking"}},"example":{"displayName":"First National Bank","iconUrl":"https://www.ipg-online.com/connect/bankLogo.png","value":"fnsTknBFirstNationalBank","groupName":"TokenBanking"}},"RequiredRedirectionData":{"description":"Redirection details provided to the payer e.g. an external URL to complete processing on the web page of the authorisation system.","type":"object","required":["target"],"properties":{"target":{"description":"Redirection URL or just \"SDK\".","type":"string","maxLength":2048},"parameters":{"description":"Redirection header parameters details.","$ref":"#/components/schemas/AdditionalParameters"},"method":{"description":"HTTP method type.","type":"string","enum":["GET","POST"],"example":"GET"}}},"AdditionalParameters":{"description":"Map representation for additional parameters.","type":"object","additionalProperties":{"type":"string","maxLength":2048}},"EncryptedApplePayWalletPaymentMethod":{"description":"Wallet payment method containing encrypted Apple Pay information.","allOf":[{"$ref":"#/components/schemas/WalletPaymentMethod"},{"type":"object","required":["encryptedApplePay"],"properties":{"encryptedApplePay":{"$ref":"#/components/schemas/EncryptedApplePay"}}}],"example":{"walletType":"EncryptedApplePayWalletPaymentMethod","encryptedApplePay":{"data":"NdCmVw5nMjQq746HYc/VbiZcQZ/zFzeEcM1wVMPruEG4/C/EFhobSkwB5JZJU+t6JuDVXUBiRYuOOC8FTYd+qIm6ckktid9aiGh0f2NDP0INSr59QXmr389RonyUfRYKnBmwsh5UqtI7Iz0AmMtl1PWMdxcCewtjuffs79ahTnFgXsRN+ynuhyDfbdRanlTnYKGoTeVh9eJfheJ1wquO+jiGj+npJ/Oh9bAdlw7iEHrYO2aUkgaMyXZ3foXRAJeimQVQS1y8lU1PPq62zpPrFzidbnnU5fK25pvGFjOdmLsBELZPk5thQEkSaA9p1LSKzWSesHhi0BxZaFPXSA6ANXvYIU2AT0lG+0O0w1URA5Sinyj3YDZVqjuir6rzNN9bB2U2nTQnKMbuGLMS20K8fUKZN/YLJh+AtE6J69+VVSU95mE1nOb8hyabz6E5RmnC5Ze2k6F/hQ75ig==","header":{"applicationDataHash":"94ee059335e587e501cc4bf90613e0814f00a7b08bc7c648fd865a2af6a22cc2","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiaU1SbkYTJy/j5L1t51vtGDh4KlNl5MFPWzo/C8r0WcrktWriz5pdRaDVUDvU++KlDu2iuQsd2xSNKJlFscbDQ==","publicKeyHash":"YmSWN7lj4+A6fVJVPicP8TgS7gI7ougD8rEWB5LXtMM=","transactionId":"31323334353637"},"signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIB0zCCAXkCAQEwCQYHKoZIzj0EATB2MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTkoxFDASBgNVBAcMC0plcnNleSBDaXR5MRMwEQYDVQQKDApGaXJzdCBEYXRhMRIwEAYDVQQLDAlGaXJzdCBBUEkxGzAZBgNVBAMMEmQxZHZ0bDEwMDAuMWRjLmNvbTAeFw0xNTA3MjMxNjQxMDNaFw0xOTA3MjIxNjQxMDNaMHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErnHhPM18HFbOomJMUiLiPL7nrJuWvfPy0Gg3xsX3m8q0oWhTs1QcQDTT+TR3yh4sDRPqXnsTUwcvbrCOzdUEeTAJBgcqhkjOPQQBA0kAMEYCIQDrC1z2JTx1jZPvllpnkxPEzBGk9BhTCkEB58j/Cv+sXQIhAKGongoz++3tJroo1GxnwvzK/Qmc4P1K2lHoh9biZeNhAAAxggFUMIIBUAIBATB7MHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tAgEBMA0GCWCGSAFlAwQCAQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTUwODEyMTczMTAwWjAvBgkqhkiG9w0BCQQxIgQgJyjKLiGQo3I1ZbfHSmF2XCZ8dNlcZyohziuXO48EKwgwCgYIKoZIzj0EAwIESDBGAiEAznKDYEz9MsC+r1g6e4LR1DTaQOl+X2rVNkWnKDpc1EQCIQCmK48ChHoz4HWnUnW5XqaGWOUXKHQvUgeqFr/jgBUzegAAAAAAAA==","applicationData":"VEVTVA==","merchantId":"order-1","version":"EC_v1"}}},"EncryptedGooglePayWalletPaymentMethod":{"description":"Wallet payment method containing encrypted Google Pay information.","allOf":[{"$ref":"#/components/schemas/WalletPaymentMethod"},{"type":"object","required":["encryptedGooglePay"],"properties":{"encryptedGooglePay":{"$ref":"#/components/schemas/EncryptedGooglePay"}},"example":{"walletType":"EncryptedGooglePayWalletPaymentMethod","encryptedGooglePay":{"data":{"encryptedMessage":"8nxjB9mr2tWZeDRQRcGN91UUnb7AioGp3oRo8kmQ6lyvJZiqD7PJlbRCYElNqUmr6Z8zK7b2gO9MKOjpnTCqH0qAe2vuIlwNXB60M2Lh7Qfl3bVgWzwF/FfFcenVW381hoItYi8AjWnWoydz1XMTEv2qhqUG03mEnRXdMyDyk6KKZXoW8Qc0p1F1thbxxu8weU8CZbZsWGGTjB42cilIqLVbribcOAG8Oas1AcgefFsu2hwp4gdSuOg7wmeSV7XKsGQzzVy85qtjuqET2XYzJE3K/Wh9QKkhu5P9Ms5s1+Smr2IjRyidqQa88SxQplrVoo9+PvT0bxFcMspBmO3pLkuaZSUBy++dL2fefcxNJvGCFfFhdxW9DojuuQxgpeu7RAQUsGLyFmr/4ZfBxt882xTmpX9MRx5CAudl9qUgBfKdwWwMX35qSbDTm1ju5XXzNh94VebjD3bB9Zj8qgbmUOr/+6OQLhoFJyBCXgx3EEH8hBwNVFrss/SLwQvFhZh62eO6lOtnmbOtP1yTDDVqGDBfai5SwAmM+KTcc9SGv/xDC+cWe8ck+aCBkG4HoRPapUVMZ3JIgV7yzTsVLJE\\\\u003d\\\\","ephemeralPublicKey":"BGH3fRFdoAobYrAlxnZOCYzkH84Cna92IZxtgsU36CMDaqSaDYb9/LsY8qw+vMtlBnwsUg/YVMOeeKp+qDkOWb4\\\\u003d\\\\","tag":"nvmOUNpnOTZULLhMxT/hWCHzH/4f7gGpfvQgwl3p8ng\\\\u003d\\\\"},"intermediateSigningKey":{"signedKey":{"keyValue":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/1+3HBVSbdv+j7NaArdgMyoSAM43yRydzqdg1TxodSzA96Dj4Mc1EiKroxxunavVIvdxGnJeFViTzFvzFRxyCw\\u003d\\u003d","keyExpiration":"123581321345589"},"signatures":"[\"MEYCIQDcXCoB4fYJF3EolxrE2zB+7THZCfKA7cWxSztKceXTCgIhAN/d5eBgx/1A6qKBdH0IS7/aQ7dO4MuEt26OrLCUxZnl\"]"},"signature":"MEUCIFWTRWUZAOM5nfJC79FtJm56olnbwG4H5uWWxAUWAquiAiEA24j/BcOroeISsdJzYsyoVi8wzu4tnmKw+jdsGfuvPko=","version":"ECv1"}}}]},"EncryptedClickToPayWalletPaymentMethod":{"description":"Wallet payment method containing encrypted Click To Pay information.","allOf":[{"$ref":"#/components/schemas/WalletPaymentMethod"},{"type":"object","required":["encryptedClickToPay"],"properties":{"encryptedClickToPay":{"$ref":"#/components/schemas/EncryptedClickToPay"}},"example":{"walletType":"EncryptedClickToPayWalletPaymentMethod","checkoutResponseEncrypted":"eyJpc3MiOiJodHRwczpcL1wvbWFzdGVyY2FyZC5jb20iLCJpYXQiOjE3MjU4OTc2OTAsImFsZyI6IlJTMjU2IiwianRpIjoiMmZhOWM1N2UtOTRlNS00MDY0LWExMmItN2ZkZGFkYmI1ZmJlIiwia2lkIjoiMjAyMzAyMDcxNjQ2MTMtc2FuZGJveC1wYXlsb2FkLXZlcmlmaWNhdGlvbi1zcmMtbWFzdGVyY2FyZC1pbnQifQ.eyJzcmNDb3JyZWxhdGlvbklkIjoiNGYzMzliZTcuZjA0N2QyZjYtZTk2MS00MGJlLTg1ZWQtMGVhZTNkZDNmNjY5Iiwic3JjaVRyYW5zYWN0aW9uSWQiOiJmMGQ3NWUzYy0yMmQ1LTQ0MmItYTc2My1jM2FkYjNlMGZhN2YiLCJtYXNrZWRDYXJkIjp7InNyY0RpZ2l0YWxDYXJkSWQiOiJJWjBwT1hKZVNVLXF0cGYzY2NKVkR3MDAwMDAwMDAwMDAwVVMiLCJwYW5CaW4iOiI1MTg2MDAiLCJwYW5MYXN0Rm91ciI6Ijg3ODUiLCJkaWdpdGFsQ2FyZERhdGEiOnsic3RhdHVzIjoiQUNUSVZFIiwiYXJ0VXJpIjoiaHR0cHM6Ly9zYnguYXNzZXRzLm1hc3RlcmNhcmQuY29tL2NhcmQtYXJ0L2NvbWJpbmVkLWltYWdlLWFzc2V0L0hJR0gtTUFTSy0zeC5wbmcifSwicGFuRXhwaXJhdGlvbk1vbnRoIjoiMDYiLCJwYW5FeHBpcmF0aW9uWWVhciI6IjIwMjciLCJwYXltZW50Q2FyZERlc2NyaXB0b3IiOiJtYXN0ZXJjYXJkIiwicGF5bWVudENhcmRUeXBlIjoiUFJFUEFJRCIsIm1hc2tlZEJpbGxpbmdBZGRyZXNzIjp7ImFkZHJlc3NJZCI6IjI0MjY1ZGM3LTVhNTktNGVkNC1hMTRmLWFkMDcxZWE2NjNhNSIsIm5hbWUiOiJCaCoqKioqKioqZSBQYSoqbCIsImxpbmUxIjoiRioqKioqKioqKioqKiouIDYiLCJjaXR5IjoiRnJhbmtmdXJ0IiwiY291bnRyeUNvZGUiOiJERSIsInppcCI6IjU2MzI1IiwiY3JlYXRlVGltZSI6IjIwMjQtMDgtMjZUMTI6MjM6MjIuOTc5WiJ9LCJzZXJ2aWNlSWQiOiJTUkMiLCJkYXRlT2ZDYXJkQ3JlYXRlZCI6IjIwMjQtMDgtMjZUMTI6MjM6MTEuMjk0WiIsImRhdGVPZkNhcmRMYXN0VXNlZCI6IjIwMjQtMDktMDVUMTA6MDY6MTUuNjQ4WiJ9LCJtYXNrZWRDb25zdW1lciI6eyJzcmNDb25zdW1lcklkIjoiMzExZjRiNjEtYTUyZi00OWY4LWE2MDItMDA4YjJkMjM5ZmM0IiwibWFza2VkQ29uc3VtZXJJZGVudGl0eSI6eyJpZGVudGl0eVByb3ZpZGVyIjoiU1JDIiwiaWRlbnRpdHlUeXBlIjoiRU1BSUxfQUREUkVTUyIsIm1hc2tlZElkZW50aXR5VmFsdWUiOiJkKioqKipjQGZpc2Vydi5jb20ifSwibWFza2VkRW1haWxBZGRyZXNzIjoiZCoqKioqY0BmaXNlcnYuY29tIiwibWFza2VkTW9iaWxlTnVtYmVyIjp7ImNvdW50cnlDb2RlIjoiNDkiLCJwaG9uZU51bWJlciI6IioqKioqKioqNjA3In0sImNvdW50cnlDb2RlIjoiVVMiLCJsYW5ndWFnZUNvZGUiOiJlbiIsInN0YXR1cyI6IkFDVElWRSIsIm1hc2tlZEZpcnN0TmFtZSI6Im0qKioqKiIsIm1hc2tlZExhc3ROYW1lIjoiZioqKioqIiwibWFza2VkRnVsbE5hbWUiOiJtKioqKiogZioqKioqIiwiZGF0ZUNvbnN1bWVyQWRkZWQiOiIyMDI0LTA0LTE5VDA3OjI0OjQ2LjY5N1oiLCJkYXRlQ29uc3VtZXJMYXN0VXNlZCI6IjIwMjQtMDktMDlUMTU6NTg6MzcuMzc3WiJ9LCJhc3N1cmFuY2VEYXRhIjp7ImNhcmRWZXJpZmljYXRpb25FbnRpdHkiOiIwMiIsImNhcmRWZXJpZmljYXRpb25NZXRob2QiOiIwMyIsImNhcmRWZXJpZmljYXRpb25SZXN1bHRzIjoiMDEifX0.PfFzFkENtj0MaSEKYt29VdNSn1q6aFanmBAIZ6S6WDXrJQ0QvzmP6zvJyjhNd0oFUzFHzz6l3uoEIuUyZ71vnXVx93lgbEI7yYqYoUuUsOoVzxq9zE3H5RbsQrvW-h494OS0U6spRSefJpXuhtF8x24D43ROwWnEBRt9V7A211RgPjfbS8VfbMf77BH7_Sc_G4LHyFW2iQq6kGBJeFZgcRtyOhVGfqGxuvb4tTWYH8F6NJsNBnI3NYBI0PNoJ091H-VUmaB_qJ0z09ulYGX2u_1WcCtJ5cB3gzYJ7-xEAXm-KdCZxZ8DsjyYX8kJjjuZjYfJuTqJLphKiko06enStg","merchantTransactionId":"0a4e0d3.34f4a04b.390515165b8f87a5a0694cd752752ff6717fce21","xSrcCxFlowId":"34F4A04B.B9EF8486-E8C1-44F3-88DC-D4F516A354DC.1587777300","organizationalId":"729abcf5-264c-4f95-a88d-6d5831727734","digitalPaymentApplicationId":"57a8abed-dc75-4bd6-b2a9-0bc09d7c237a"}}]},"DecryptedApplePayWalletPaymentMethod":{"description":"Wallet payment method containing decrypted Apple Pay information.","allOf":[{"$ref":"#/components/schemas/WalletPaymentMethod"},{"type":"object","required":["decryptedApplePay"],"properties":{"decryptedApplePay":{"$ref":"#/components/schemas/DecryptedApplePay"}},"example":{"walletType":"DecryptedApplePayWalletPaymentMethod","decryptedApplePay":{"accountNumber":"4111111111111111","expiration":"012040","cardholderName":"John Doe","brand":"VISA","cryptogram":"BB81SRsADvooHCUcDogjMAACAAA=","eciIndicator":"05"}}}]},"DecryptedGooglePayWalletPaymentMethod":{"description":"Wallet payment method containing decrypted Google Pay information.","allOf":[{"$ref":"#/components/schemas/WalletPaymentMethod"},{"type":"object","required":["decryptedGooglePay"],"properties":{"decryptedGooglePay":{"$ref":"#/components/schemas/DecryptedGooglePay"}},"example":{"walletType":"DecryptedGooglePayWalletPaymentMethod","decryptedGooglePay":{"accountNumber":"4111111111111111","expiration":"012040","cardholderName":"John Doe","brand":"VISA","cryptogram":"BB81SRsADvooHCUcDogjMAACAAA=","eciIndicator":"05"}}}]},"WalletPaymentMethod":{"description":"Various wallet payment methods the gateway supports. Abstract class, do not use this class directly, use one of its children: EncryptedApplePayWalletPaymentMethod, EncryptedGooglePayWalletPaymentMethod, DecryptedApplePayWalletPaymentMethod, DecryptedGooglePayWalletPaymentMethod","type":"object","discriminator":{"propertyName":"walletType","mapping":{"EncryptedApplePayWalletPaymentMethod":"#/components/schemas/EncryptedApplePayWalletPaymentMethod","DecryptedApplePayWalletPaymentMethod":"#/components/schemas/DecryptedApplePayWalletPaymentMethod","EncryptedClickToPayWalletPaymentMethod":"#/components/schemas/EncryptedClickToPayWalletPaymentMethod","EncryptedGooglePayWalletPaymentMethod":"#/components/schemas/EncryptedGooglePayWalletPaymentMethod","DecryptedGooglePayWalletPaymentMethod":"#/components/schemas/DecryptedGooglePayWalletPaymentMethod"}},"required":["walletType"],"properties":{"walletType":{"description":"Type of wallet.","type":"string","example":"EncryptedApplePayWalletPaymentMethod"}},"example":{"walletType":"EncryptedApplePayWalletPaymentMethod","encryptedApplePay":{"data":"NdCmVw5nMjQq746HYc/VbiZcQZ/zFzeEcM1wVMPruEG4/C/EFhobSkwB5JZJU+t6JuDVXUBiRYuOOC8FTYd+qIm6ckktid9aiGh0f2NDP0INSr59QXmr389RonyUfRYKnBmwsh5UqtI7Iz0AmMtl1PWMdxcCewtjuffs79ahTnFgXsRN+ynuhyDfbdRanlTnYKGoTeVh9eJfheJ1wquO+jiGj+npJ/Oh9bAdlw7iEHrYO2aUkgaMyXZ3foXRAJeimQVQS1y8lU1PPq62zpPrFzidbnnU5fK25pvGFjOdmLsBELZPk5thQEkSaA9p1LSKzWSesHhi0BxZaFPXSA6ANXvYIU2AT0lG+0O0w1URA5Sinyj3YDZVqjuir6rzNN9bB2U2nTQnKMbuGLMS20K8fUKZN/YLJh+AtE6J69+VVSU95mE1nOb8hyabz6E5RmnC5Ze2k6F/hQ75ig==","header":{"applicationDataHash":"94ee059335e587e501cc4bf90613e0814f00a7b08bc7c648fd865a2af6a22cc2","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiaU1SbkYTJy/j5L1t51vtGDh4KlNl5MFPWzo/C8r0WcrktWriz5pdRaDVUDvU++KlDu2iuQsd2xSNKJlFscbDQ==","publicKeyHash":"YmSWN7lj4+A6fVJVPicP8TgS7gI7ougD8rEWB5LXtMM=","transactionId":"31323334353637"},"signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIB0zCCAXkCAQEwCQYHKoZIzj0EATB2MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTkoxFDASBgNVBAcMC0plcnNleSBDaXR5MRMwEQYDVQQKDApGaXJzdCBEYXRhMRIwEAYDVQQLDAlGaXJzdCBBUEkxGzAZBgNVBAMMEmQxZHZ0bDEwMDAuMWRjLmNvbTAeFw0xNTA3MjMxNjQxMDNaFw0xOTA3MjIxNjQxMDNaMHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErnHhPM18HFbOomJMUiLiPL7nrJuWvfPy0Gg3xsX3m8q0oWhTs1QcQDTT+TR3yh4sDRPqXnsTUwcvbrCOzdUEeTAJBgcqhkjOPQQBA0kAMEYCIQDrC1z2JTx1jZPvllpnkxPEzBGk9BhTCkEB58j/Cv+sXQIhAKGongoz++3tJroo1GxnwvzK/Qmc4P1K2lHoh9biZeNhAAAxggFUMIIBUAIBATB7MHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tAgEBMA0GCWCGSAFlAwQCAQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTUwODEyMTczMTAwWjAvBgkqhkiG9w0BCQQxIgQgJyjKLiGQo3I1ZbfHSmF2XCZ8dNlcZyohziuXO48EKwgwCgYIKoZIzj0EAwIESDBGAiEAznKDYEz9MsC+r1g6e4LR1DTaQOl+X2rVNkWnKDpc1EQCIQCmK48ChHoz4HWnUnW5XqaGWOUXKHQvUgeqFr/jgBUzegAAAAAAAA==","applicationData":"VEVTVA==","merchantId":"order-1","version":"EC_v1"}}},"PaymentTokenPaymentMethod":{"description":"Payment method containing payment tokenization information.  SEPA Mandate details are used of for only DE DirectDebit ELV transactions.\n","allOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"object","required":["paymentToken"],"properties":{"paymentToken":{"$ref":"#/components/schemas/UsePaymentToken"},"paymentFacilitator":{"$ref":"#/components/schemas/PaymentFacilitator"}}}],"example":{"paymentToken":{"value":"1235325235236","function":"DEBIT","securityCode":"977"}}},"PaymentCardPaymentMethod":{"description":"Payment method containing payment card information. Only one payment card data is accepted for processing transaction either PaymantCard or PaymentCardEncrypted","allOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"object","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"},"paymentFacilitator":{"$ref":"#/components/schemas/PaymentFacilitator"}}}],"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"12","year":"25"},"securityCode":"977"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"},"paymentFacilitator":{"externalMerchantId":"12345","paymentFacilitatorId":"123123123","saleOrganizationId":"123124214","name":"First Reseller","subMerchantData":{"mcc":"1432","legalName":"First Merchant","timezone":"Europe/London","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"},"document":{"type":"NATIONAL_IDENTITY","number":"12345666544"},"merchantId":"12435325235","merchantVerificationValue":"001122"}}}},"PaymentSchedulesPaymentMethod":{"description":"Payment method containing payment card information.","allOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"object","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentSchedulesPaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentSchedulesPaymentCardEncrypted"},"paymentFacilitator":{"$ref":"#/components/schemas/PaymentFacilitator"}}}],"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"12","year":"25"},"securityCode":"977"},"paymentFacilitator":{"externalMerchantId":"12345","paymentFacilitatorId":"123123123","saleOrganizationId":"123124214","name":"First Reseller","subMerchantData":{"mcc":"1432","legalName":"First Merchant","timezone":"Europe/London","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"},"document":{"type":"NATIONAL_IDENTITY","number":"12345666544"},"merchantId":"12435325235","merchantVerificationValue":"001122"}}}},"AuthOptimization":{"description":"Object for sending Card Account Updater.","properties":{"authOptimizationOverride":{"description":"Indicates the Card Account Updater value. Valid value is 'Override'.","type":"string","enum":["Override"],"example":"Override"}},"example":{"authOptimizationOverride":"Override"}},"PaymentDevicePaymentMethod":{"description":"Payment method containing payment device information.","allOf":[{"$ref":"#/components/schemas/PaymentMethod"},{"type":"object","required":["paymentDevice"],"properties":{"paymentDevice":{"$ref":"#/components/schemas/PaymentDevice"},"paymentFacilitator":{"$ref":"#/components/schemas/PaymentFacilitator"}}}],"example":{"paymentDevice":{"deviceType":"SWIPE","data":"02A600C0170018008292;5424********1732=1810?*B73CD8C26233D4FFEC5500ED394439D97DDA5F530942D21D0000000000000000000000000000000000000000363434543035353734326299492410027300000260DC03","securityCode":"977","cardholderName":"First Cardholder","cardFunction":"CREDIT","brand":"VISA"},"paymentFacilitator":{"externalMerchantId":"12345","paymentFacilitatorId":"123123123","saleOrganizationId":"123124214","name":"First Reseller","subMerchantData":{"mcc":"1432","legalName":"First Merchant","timezone":"Europe/London","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"},"document":{"type":"NATIONAL_IDENTITY","number":"12345666544"},"merchantId":"12435325235","merchantVerificationValue":"001122"}}}},"PaymentMethod":{"description":"Various payment methods the Gateway supports. Abstract class, do not use this class directly, use one of its children.","type":"object"},"PaymentMethodDetails":{"description":"Provides details of the payment method used.","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"paymentMethodBrand":{"$ref":"#/components/schemas/PaymentMethodBrand"}},"example":{"paymentCard":{"number":"5424180279791732","expiryDate":{"month":"12","year":"25"},"securityCode":"977"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"},"paymentMethodType":"PAYMENT_CARD","paymentMethodBrand":"APPLEPAY"}},"PaymentMethodType":{"description":"Type of payment method.","type":"string","enum":["APM","NATWEST_PAYIT","PAYMENT_CARD","PAYMENT_TOKEN","WALLET","VISA_MOBILE"],"example":"PAYMENT_CARD"},"PaymentMethodBrand":{"description":"A list of all Payment Method Brands.","type":"string","enum":["AMEX","APPLEPAY","BANKTRANSFER","CARD","DINERSCLUB","GOOGLEPAY","MAESTRO","MASTERCARD","MOBILE_PAY","NATWEST_PAYIT","VISA"],"example":"GOOGLEPAY"},"PaymentCardEncrypted":{"description":"This object encapsulates sensitive card data in an encrypted format, ensuring that it's encrypted during transmission.\n","required":["encryptionType","encryptedData","keyId"],"properties":{"encryptionType":{"$ref":"#/components/schemas/EncryptionType"},"encryptedData":{"description":"Payment card is encrypted using public key with RSA encryption algorithm RSA-OAEP-256 with encryption method A128GCM.","type":"string","maxLength":1024,"example":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w"},"keyId":{"description":"Key id of public key which is used for encryption.","type":"string","maxLength":50,"example":"20240807-card-enc"}},"example":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"}},"PaymentCard":{"description":"Payment card model.","required":["number"],"properties":{"number":{"description":"Payment card number. It can also be an IBAN (e.g NL91ABNA0417164300) for Sepa Direct Debit transactions.","type":"string","minLength":13,"maxLength":34,"example":"5424180279791732"},"expiryDate":{"$ref":"#/components/schemas/Expiration"},"fundingCardNumber":{"$ref":"#/components/schemas/fundingCardNumber"},"securityCode":{"description":"Card verification value/number.","type":"string","minLength":3,"maxLength":4,"example":"977"},"cardFunction":{"$ref":"#/components/schemas/CardFunction"},"cardholderName":{"description":"Name of the cardholder. Note - Only supported with request payload.","type":"string","maxLength":96,"example":"John Doe"},"bin":{"description":"The payment card BIN.","type":"string","example":"403587"},"last4":{"description":"The last 4 numbers of a payment card.","type":"string","example":"4977"},"brand":{"type":"string","example":"VISA","description":"Required only if using dual branded card."}},"example":{"number":"5424180279791732","expiryDate":{"month":"12","year":"25"},"securityCode":"977"}},"PaymentSchedulesPaymentCard":{"description":"Payment card model.","required":["number"],"properties":{"number":{"description":"Payment card number.","type":"string","pattern":"[0-9]{13,19}","example":"5424180279791732"},"expiryDate":{"$ref":"#/components/schemas/Expiration"},"securityCode":{"description":"Card verification value/number.","type":"string","minLength":3,"maxLength":4,"example":"977"},"cardFunction":{"$ref":"#/components/schemas/CardFunction"},"cardholderName":{"description":"Name of the cardholder. Note - Only supported with request payload.","type":"string","maxLength":96,"example":"John Doe"},"bin":{"description":"The payment card BIN.","type":"string","example":"403587"},"last4":{"description":"The last 4 numbers of a payment card.","type":"string","example":"4977"},"brand":{"type":"string","example":"VISA","description":"Required only if using dual branded card."}},"example":{"number":"5424180279791732","expiryDate":{"month":"12","year":"25"},"securityCode":"977"}},"PaymentSchedulesPaymentCardEncrypted":{"description":"This object encapsulates sensitive card data in an encrypted format, ensuring that it's encrypted during transmission.\n","required":["encryptionType","encryptedData","keyId"],"properties":{"encryptionType":{"$ref":"#/components/schemas/EncryptionType"},"encryptedData":{"description":"Payment card is encrypted using public key with RSA encryption algorithm RSA-OAEP-256 with encryption method A128GCM.","type":"string","maxLength":1024,"example":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w"},"keyId":{"description":"Key id of public key which is used for encryption.","type":"string","maxLength":50,"example":"20240807-card-enc"}},"example":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc","fundingCardNumber":{"bin":"542418","last4":"1732"}}},"NetworkToken":{"description":"Network Token Model","required":["value","expiryMonth","expiryYear"],"properties":{"value":{"description":"Token value","type":"string","pattern":"[0-9]{13,19}","example":"2343446334644554"},"expiryMonth":{"description":"Month of the token expiration date in MM format.","type":"string","pattern":"^(0[1-9]|1[012])$","example":"03"},"expiryYear":{"description":"Year of the card expiration date in YY format.","type":"string","pattern":"^([0-9]{2})$","example":"24"},"cardLast4":{"description":"Last four digits of Card number.","maxLength":4,"type":"string","example":"1234"},"brand":{"description":"Card brand.","type":"string","enum":["AMEX","DINERS/DISCOVER","MAESTRO","MASTERCARD","VISA"],"example":"VISA"},"cryptogram":{"description":"Cryptogram value.","type":"string","example":"AgAAAAADo8FZTI0AmJbMgyUAAAA="},"authIndicator":{"description":"Authorization Indicator.","type":"string","enum":["P","T"],"example":"P"},"tokenEligible":{"description":"Token Assurance Method Value determines the confidence level of the payment token to PAN/cardholder binding and it will be provided by the token service provider.","type":"string","example":"AY"}}},"TokenAlias":{"description":"Token alias related information.","required":["expiryDate","paramAlias"],"properties":{"expiryDate":{"description":"Date and time of alias expiration.","type":"string","format":"date-time","example":"2025-01-30T08:30:50Z"},"paramAlias":{"description":"List of params related to the given alias.","type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/AliasParam"},"example":[{"key":"appLabel_1","value":"APP Label 095"},{"key":"tasAliasKey_1","value":"675495"}]}},"example":{"expiryDate":"2025-01-30T08:30:50Z","paramAlias":[{"key":"appLabel_1","value":"APP Label 095"},{"key":"tasAliasKey_1","value":"675495"}]}},"AliasParam":{"description":"Alias param information.","required":["key","value"],"properties":{"key":{"description":"Alias param key.","type":"string","maxLength":20,"example":"appLabel_1"},"value":{"description":"Alias param value.","type":"string","maxLength":50,"example":"APP Label 095"}},"example":{"key":"appLabel_1","value":"APP Label 095"}},"AuthenticationResult":{"description":"Submit the result of 3DS authentication managed outside of the gateway. An AuthenticationResult should not be submitted within the same request as an AuthenticationRequest. Abstract class, do not use this class directly, use one of its children.","required":["authenticationType"],"discriminator":{"propertyName":"authenticationType"},"properties":{"authenticationType":{"description":"Specifies the version of 3DS to be used where authentication was managed outside of the gateway.","type":"string","example":"Secure3DAuthenticationResult"}},"example":{"authenticationType":"Secure3DAuthenticationResult"}},"AccountOwner":{"description":"Used for PaymentCard or PaymentToken Account Verification.","properties":{"firstName":{"description":"Account Holder First Name.","type":"string","maxLength":35,"example":"John"},"middleName":{"description":"Account Holder Middle Name.","type":"string","maxLength":35,"example":"Doe"},"lastName":{"description":"Account Holder Last Name.","type":"string","maxLength":35,"example":"Doe"},"ownerType":{"description":"These values are used for account name inquiries. Primary Account Owner means the person that is considered to be the main owner of the account. Secondary Account Owner means the person with limited access to the account.","type":"string","enum":["PRIMARY","SECONDARY"],"example":"PRIMARY"}},"example":{"firstName":"Pete","middleName":"Maverick","lastName":"Mitchell"}},"Secure3D10AuthenticationResult":{"description":"Submit the result of the authentication managed outside of the gateway for a 3-D Secure 1.0 scheme. For more convenient usage without implementing 3-D Secure yourself see \"authenticationRequest\" section. DEPRECATED - use Secure3DAuthenticationResult instead","allOf":[{"$ref":"#/components/schemas/AuthenticationResult"},{"type":"object","properties":{"verificationResponse":{"description":"Card enrollment result from the Verification Response (VeRes).","type":"string","enum":["Y","N","U"],"example":"N"},"authenticationAttemptResult":{"description":"Result of authentication attempt from Payer Authentication Response (PaRes).","type":"string","enum":["Y","N","U","A"],"example":"Y"},"cavv":{"description":"The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase.","type":"string","minLength":20,"maxLength":32,"example":"AAABCZIhcQAAAABZlyFxAAAAAAA"},"xid":{"description":"The transaction identifier (XID) is a unique tracking number set by the merchant.","type":"string","minLength":20,"maxLength":32,"example":"MfhxI43NrkuWQYLCoRWitYRDMYo"}}}],"example":{"requestType":"Secure3D10AuthenticationResult","verificationResponse":"Y","authenticationAttemptResult":"Y","cavv":"AAABCZIhcQAAAABZlyFxAAAAAAA","xid":"MfhxI43NrkuWQYLCoRWitYRDMYo"},"deprecated":true},"Secure3D21AuthenticationResult":{"description":"Submit the result of the authentication managed outside of the gateway for a 3-D Secure 2.x scheme. For more convenient usage without implementing 3-D Secure yourself see \"authenticationRequest\" section. DEPRECATED - use Secure3DAuthenticationResult instead","allOf":[{"$ref":"#/components/schemas/AuthenticationResult"},{"type":"object","properties":{"cavv":{"description":"The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase.","type":"string","minLength":20,"maxLength":32,"example":"AAABCZIhcQAAAABZlyFxAAAAAAA"},"xid":{"description":"The transaction identifier (XID) is a unique tracking number set by the merchant.","type":"string","minLength":20,"maxLength":32,"example":"MfhxI43NrkuWQYLCoRWitYRDMYo"},"transactionId":{"description":"The response transaction UUID. Only applicable to MasterCard.","type":"string","example":"f38e6948-5388-41a6-bca4-b49723c19437"},"authenticationResponse":{"description":"The result of authentication attempt returned by the 3D Secure authentication process (PaRes).","type":"string","enum":["A","N","U","Y","C","R"],"default":"Y","example":"A"},"transactionStatus":{"description":"The transaction status as returned by the 3D Secure authentication process.","type":"string","enum":["A","N","U","Y","C","R"],"example":"A"},"secure3DProtocolVersion":{"$ref":"#/components/schemas/Secure3DProtocolVersion"}}}],"example":{"requestType":"Secure3D21AuthenticationResult","cavv":"AAABCZIhcQAAAABZlyFxAAAAAAA","xid":"MfhxI43NrkuWQYLCoRWitYRDMYo","transactionId":"f38e6948-5388-41a6-bca4-b49723c19437","authenticationResponse":"Y","transactionStatus":"Y","secure3DProtocolVersion":"2.2.0"},"deprecated":true},"Secure3DProtocolVersion":{"description":"Indicates the 3DSecure Authentication Version. If this is not passed then it will be mapped to Secure3DProtocolVersion.VERSION_2_1 by default.","type":"string","enum":["1.0.2","2.1.0","2.1","2.2.0","2.2","2.3","2.4","2.5","2.6","2.7","2.8","2.9"],"example":"2.2.0"},"Secure3DAuthenticationResult":{"description":"Submit the result of the authentication managed outside of the gateway for a 3-D Secure 2.x scheme. For more convenient usage without implementing 3-D Secure yourself see \"authenticationRequest\" section.","allOf":[{"$ref":"#/components/schemas/AuthenticationResult"},{"type":"object","properties":{"cavv":{"description":"The Cardholder Authentication Verification Value (CAVV) is a cryptographic value derived by the issuer during payment authentication that can provide evidence of the results of payment authentication during an online purchase.","type":"string","minLength":20,"maxLength":32,"example":"AAABCZIhcQAAAABZlyFxAAAAAAA"},"xid":{"description":"The transaction identifier (XID) is a unique tracking number set by the merchant.","type":"string","minLength":20,"maxLength":32,"example":"MfhxI43NrkuWQYLCoRWitYRDMYo"},"dsTransactionId":{"description":"The response transaction UUID from the DS (directory server)","type":"string","example":"f38e6948-5388-41a6-bca4-b49723c19437"},"authenticationResponse":{"description":"The result of authentication attempt returned by the 3D Secure authentication process (ARes).","type":"string","enum":["A","N","U","Y","C","R"],"example":"A"},"transactionStatus":{"description":"The transaction status as returned by the 3D Secure authentication process. (CRes)","type":"string","enum":["A","N","U","Y","C","R"],"example":"A"},"messageCategory":{"description":"Indicates the message category of 3d secure authentication version 2.X. 01 = Payment Authentication 02 = Non-Payment Authentication 80 = Mastercard Data Only\n","type":"string","enum":["01","02","80"],"example":"01"},"secure3DProtocolVersion":{"$ref":"#/components/schemas/Secure3DProtocolVersion"}}}],"example":{"requestType":"Secure3DAuthenticationResult","cavv":"AAABCZIhcQAAAABZlyFxAAAAAAA","xid":"MfhxI43NrkuWQYLCoRWitYRDMYo","dsTransactionId":"f38e6948-5388-41a6-bca4-b49723c19437","transactionStatus":"Y","messageCategory":"01","secure3DProtocolVersion":"2.2.0"}},"Secure3D10AuthenticationRequest":{"description":"Request authentication of the payment card using the 3DS 1.0 URL redirect scheme. DEPRECATED - use Secure3DAuthenticationRequest instead","allOf":[{"$ref":"#/components/schemas/AuthenticationRequest"},{"type":"object","properties":{"termURL":{"description":"The result of the authentication will be sent to this URL. If not provided, a term URL will be dynamically generated. Note this must be a valid URL (special characters should be URL-encoded).","type":"string","maxLength":2048,"example":"https://www.mywebshop.com/process3dSecure"}}}],"example":{"authenticationType":"Secure3D10AuthenticationRequest"},"deprecated":true},"Secure3D21AuthenticationRequest":{"description":"Request authentication of the payment card using the 3DS 2.x URL redirect scheme. DEPRECATED - use Secure3DAuthenticationRequest instead","allOf":[{"$ref":"#/components/schemas/AuthenticationRequest"},{"type":"object","properties":{"termURL":{"description":"The result of the authentication will be sent to this URL. If not provided, a term URL will be dynamically generated. Note this must be a valid URL (special characters should be URL-encoded).","type":"string","maxLength":2048,"example":"https://www.mywebshop.com/process3dSecure"},"methodNotificationURL":{"description":"The 3DS method iframe and transaction ID will be sent here. Note this must be a valid URL (special characters should be URL-encoded).","type":"string","maxLength":2048,"example":"https://www.mywebshop.com/process3dSecureMethodNotification?transactionReferenceNumber=ffffffff-ba0b-539f-8000-016b2343ad7e"},"challengeIndicator":{"description":"Indicates whether or not a challenge should be performed. 01 = No preference (You have no preference whether a challenge should be performed. This is the default value) 02 = No challenge requested (You prefer that no challenge should be performed) 03 = Challenge requested: 3DS Requestor Preference (You prefer that a challenge should be performed) 04 = Challenge requested: Mandate (There are local or regional mandates that mean that a challenge must be performed) The following are applicable only for 3DS 2.2 protocol. 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)\n","type":"string","enum":["01","02","03","04","05","06","07","08","09"],"default":"01","example":"01"},"challengeWindowSize":{"description":"Defines the size of the challenge window displayed to customers during authentication. 01 = 250 x 400 02 = 390 x 400 03 = 500 x 600 04 = 600 x 400 05 = Full screen\n","type":"string","enum":["01","02","03","04","05"],"example":"01"},"browserJavaScriptEnabled":{"description":"Indicates if the browser issuing the request is capable of performing JavaScript.","type":"boolean","nullable":true,"example":true},"browserJavaEnabled":{"type":"boolean","nullable":true,"example":false,"description":"Boolean that represents the ability of the cardholder browser to execute Java (required for 2.1, mandatory for 2.2 when browserjavaScriptEnabled=true)> ATTENTION - it is stronly recommended to be set (but optional at the moment for backward compatibility)"},"authenticationIndicator":{"description":"Provides additional information to the ACS to determine the best approach for handling an authentication request. 01 = Payment transaction 02 = Recurring transaction 03 = Installment transaction 04 = Add card 05 = Maintain card 06 = Card holder verification as part of EMV token ID and Value\n","type":"string","enum":["01","02","03","04","05","06"],"default":"01","example":"01"},"secure3DDeviceChannel":{"description":"02 = BRW 03 = 3RI\n","type":"string","enum":["02","03"],"nullable":true,"example":"02"},"secure3DThreeRIIndicator":{"description":"01 = Recurring transaction 02 = Instalment transaction 03 = Add card 04 = Maintain card information 05 = Account verification 06 = Split/delayed shipment 07 = Top-up 08 = Mail Order 09 = Telephone Order 10 = Whitelist status check 11 = Other payment\n","type":"string","enum":["01","02","03","04","05","06","07","08","09","10","11"],"nullable":true,"example":"01"},"recurringExpiry":{"description":"Date after which no further authorisations shall be performed.","pattern":"^([0-9]{4})(1[0-2]|0[1-9])(3[01]|0[1-9]|[12][0-9])$","type":"string","nullable":true,"example":"20210819"},"recurringFrequency":{"description":"Indicates the minimum number of days between authorisations.","type":"integer","format":"int32","minimum":1,"maximum":9999,"nullable":true,"example":30},"cardHolderBrowserParams":{"$ref":"#/components/schemas/CardholderBrowserParameters","description":"The browser parameters of the cardholder","nullable":true},"decoupledAuthenticationParams":{"$ref":"#/components/schemas/DecoupledAuthenticationParameters","description":"Parameters needed for Decoupled Authentication","nullable":true}}}],"example":{"authenticationType":"Secure3D21AuthenticationRequest","termURL":"https://www.mywebshop.com/process3dSecure","methodNotificationURL":"https://www.mywebshop.com/process3dSecureMethodNotification?transactionReferenceNumber=ffffffff-ba0b-539f-8000-016b2343ad7e","challengeIndicator":"01","challengeWindowSize":"01","browserJavaScriptEnabled":"true","browserJavaEnabled":"false","secure3DDeviceChannel":"02","secure3DThreeRIIndicator":"01","authenticationIndicator":"01","recurringExpiry":"20210804","recurringFrequency":30,"cardHolderBrowserParams":{"browserAcceptHeaders":"Accept: text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8","browserIP":"127.0.0.1","browserLanguage":"es-419","browserUserAgent":"Lynx/2.8.4rel.1 libwww-FM/2.14 SSL-MM/1.4.1 OpenSSL/0.9.6c"},"decoupledAuthenticationParams":{"decMaxTime":10,"decReqInd":"Y"}},"deprecated":true},"Secure3DAuthenticationRequest":{"description":"Request authentication of the payment card using the 3DS 2.x URL redirect scheme.","allOf":[{"$ref":"#/components/schemas/AuthenticationRequest"},{"type":"object","required":["termURL","methodNotificationURL"],"properties":{"termURL":{"description":"The result of the authentication will be sent to this URL. If not provided, a term URL will be dynamically generated. Note this must be a valid URL (special characters should be URL-encoded).","type":"string","maxLength":2048,"example":"https://www.mywebshop.com/process3dSecure"},"methodNotificationURL":{"description":"The 3DS method iframe and transaction ID will be sent here. Note this must be a valid URL (special characters should be URL-encoded).","type":"string","maxLength":2048,"example":"https://www.mywebshop.com/process3dSecureMethodNotification?transactionReferenceNumber=ffffffff-ba0b-539f-8000-016b2343ad7e"},"challengeIndicator":{"description":"Indicates whether or not a challenge should be performed. 01 = No preference (You have no preference whether a challenge should be performed. This is the default value) 02 = No challenge requested (You prefer that no challenge should be performed) 03 = Challenge requested: 3DS Requestor Preference (You prefer that a challenge should be performed) 04 = Challenge requested: Mandate (There are local or regional mandates that mean that a challenge must be performed) The following are applicable only for 3DS 2.2 protocol. 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)\n","type":"string","enum":["01","02","03","04","05","06","07","08","09"],"default":"01","example":"01"},"messageCategory":{"description":"Indicates the message category of 3d secure authentication version 2.X. 01 = Payment Authentication 02 = Non-Payment Authentication 80 = Mastercard Data Only\n","type":"string","enum":["01","02","80"],"example":"01"},"challengeWindowSize":{"description":"Defines the size of the challenge window displayed to customers during authentication. 01 = 250 x 400 02 = 390 x 400 03 = 500 x 600 04 = 600 x 400 05 = Full screen\n","type":"string","enum":["01","02","03","04","05"],"example":"01"},"browserJavaScriptEnabled":{"description":"Indicates if the browser issuing the request is capable of performing JavaScript.","type":"boolean","nullable":true,"example":true},"browserJavaEnabled":{"type":"boolean","nullable":true,"example":false,"description":"Boolean that represents the ability of the cardholder browser to execute Java (required for 2.1, mandatory for 2.2 when browserjavaScriptEnabled=true)> ATTENTION - it is stronly recommended to be set (but optional at the moment for backward compatibility)"},"secure3DDeviceChannel":{"description":"02 = BRW 03 = 3RI\n","type":"string","enum":["02","03"],"nullable":true,"example":"02"},"secure3DThreeRIIndicator":{"description":"01 = Recurring transaction 02 = Instalment transaction 03 = Add card 04 = Maintain card information 05 = Account verification 06 = Split/delayed shipment 07 = Top-up 08 = Mail Order 09 = Telephone Order 10 = Whitelist status check 11 = Other payment\n","type":"string","enum":["01","02","03","04","05","06","07","08","09","10","11"],"nullable":true,"example":"01"},"authenticationIndicator":{"description":"Provides additional information to the ACS to determine the best approach for handling an authentication request. 01 = Payment transaction 02 = Recurring transaction 03 = Installment transaction 04 = Add card 05 = Maintain card 06 = Card holder verification as part of EMV token ID and Value\n","type":"string","enum":["01","02","03","04","05","06"],"default":"01","example":"01"},"recurringExpiry":{"description":"Date after which no further authorisations shall be performed.","pattern":"^([0-9]{4})(1[0-2]|0[1-9])(3[01]|0[1-9]|[12][0-9])$","type":"string","nullable":true,"example":"20210819"},"recurringFrequency":{"description":"Indicates the minimum number of days between authorisations.","type":"integer","format":"int32","minimum":1,"maximum":9999,"nullable":true,"example":30},"cardHolderBrowserParams":{"description":"The browser parameters of the cardholder","nullable":true,"$ref":"#/components/schemas/CardholderBrowserParameters"},"decoupledAuthenticationParams":{"description":"Parameters needed for Decoupled Authentication","nullable":true,"$ref":"#/components/schemas/DecoupledAuthenticationParameters"},"skipTRA":{"$ref":"#/components/schemas/SkipTRA"}}}],"example":{"authenticationType":"Secure3DAuthenticationRequest","termURL":"https://www.mywebshop.com/process3dSecure","methodNotificationURL":"https://www.mywebshop.com/process3dSecureMethodNotification?transactionReferenceNumber=ffffffff-ba0b-539f-8000-016b2343ad7e","challengeIndicator":"01","challengeWindowSize":"01","browserJavaScriptEnabled":"true","browserJavaEnabled":"false","secure3DDeviceChannel":"02","secure3DThreeRIIndicator":"01","authenticationIndicator":"01","recurringExpiry":"20210804","recurringFrequency":30,"cardHolderBrowserParams":{"browserAcceptHeaders":"Accept: text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8","browserIP":"127.0.0.1","browserLanguage":"es-419","browserUserAgent":"Lynx/2.8.4rel.1 libwww-FM/2.14 SSL-MM/1.4.1 OpenSSL/0.9.6c"},"decoupledAuthenticationParams":{"decMaxTime":10,"decReqInd":"Y"}}},"AuthenticationRequest":{"description":"Request authentication of the payment card to verify the cardholder and be eligible for liability shift. An AuthenticationRequest should not be submitted with in the same request as an AuthenticationResult. Abstract class, do not use this class directly, use one of its children.","required":["authenticationType"],"discriminator":{"propertyName":"authenticationType"},"properties":{"authenticationType":{"description":"Indicates what kind of authentication scheme the merchant wants to use on the card.","type":"string","example":"UnionPayAuthenticationRequest"}},"example":{"authenticationType":"UnionPayAuthenticationRequest"}},"Secure3DAuthenticationResponse":{"description":"Encapsulates 3DS authentication details in transaction responses.","properties":{"type":{"description":"The type of authentication.","type":"string","enum":["3D_SECURE"],"example":"3D_SECURE"},"version":{"description":"The version of 3DS used to authenticate.","type":"string","enum":["1.0","2.1","2.2"],"example":"2.1"},"otpVerificationResponse":{"$ref":"#/components/schemas/OtpVerificationResponse"},"params":{"description":"Additional parameters for authentication redirect.","type":"object","properties":{"payerAuthenticationRequest":{"description":"Message sent from merchant server to authenticate the cardholder.","type":"string","example":"c7fb83b8ag...73t4a827t4af8738a"},"termURL":{"description":"Terminal URL for processing request.","type":"string","maxLength":2048,"example":"https://api.example.com/redirectToAcs"},"merchantData":{"description":"Formatted string encoding transaction time, order ID, and return URL data.","type":"string","example":"MD123...sdfk"},"acsURL":{"description":"The URL for the authentication redirect for the merchant.","type":"string","example":"https://3ds-acs.test.modirum.com/mdpayacs/pareq"},"cReq":{"description":"The CReq message initiates cardholder interaction in a 3DS 2.x challenge flow and carries authentication data from the cardholder.","type":"string","example":"ewogICAiYWNzVHJhbnNJRCIgOiAiMDAwMDAwMDAtMDAwNS01YTVhLTgwMDAtMDE2ZmE1NTYzODMyIiwKICAgImNoYWxsZW5nZVdpbmRvd1NpemUiIDogIjAzIiwKICAgIm1lc3NhZ2VUeXBlIiA6ICJDUmVxIiwKICAgIm1lc3NhZ2VWZXJzaW9uIiA6ICIyLjEuMCIsCiAgICJ0aHJlZURTU2VydmVyVHJhbnNJRCIgOiAiZGVmOWZiZDgtZjkzNS01YzcyLTgwMDAtMDAwMDAwMDgyOWVkIgp9"},"sessionData":{"description":"Customer web browser session data.","type":"string","example":"50F2156E03083CA665BCB4.."}}},"secure3dMethod":{"description":"Encapsulates the 3DS method form and unique transaction identifier.","type":"object","properties":{"methodForm":{"description":"An iframe to be hidden in the browser used to collect browser data for the issuers. This information adds to the overall consumer profile and helps in identifying potentially fraudulent transactions.","type":"string","example":"&lt;!DOCTYPE iframe SYSTEM \"about:legacy-compat\"&gt; &lt;iframe id=\"tdsMmethodTgtFrame\" name=\"tdsMmethodTgtFrame\"\n         style=\"width: 1px; height: 1px; display: none;\" src=\"javascript:false;\" xmlns=\"http://www.w3.org/1999/xhtml\"&gt;\n&lt;!--.--&gt; &lt;/iframe&gt;&lt;form id=\"tdsMmethodForm\" name=\"tdsMmethodForm\"\n         action=\"https://localhost.modirum.com:8543/dstests/ACSEmu2\" method=\"post\"\n         target=\"tdsMmethodTgtFrame\" xmlns=\"http://www.w3.org/1999/xhtml\"&gt; &lt;input type=\"hidden\" name=\"3DSMethodData\"\n         value=\"eyAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogIjAwMDAwMDAwLTU2NzYtNTY2My04MDAwLTAwMDAw\n&amp;#10;MDAwNDFhOSIsICJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIiA6ICJodHRwczovL2xvY\n         2Fs&amp;#10;aG9zdC5tb2RpcnVtLmNvbTo4NTQzL21kcGF5bXBpL01lcmNoYW50U2VydmVyP21uPVkmdHhpZD0x\n&amp;#10;NjgwOSZkaWdlc3Q9aSUyQnhhUEF5NWFOcVJRbllqNmozbWFDZlFJbTdFdjJYTmkwNn\n         h6YmZNJTJG&amp;#10;R3MlM0QiIH0\"/&gt; &lt;input type=\"hidden\" name=\"threeDSMethodData\"\n         value=\"eyAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogIjAwMDAwMDAwLTU2NzYtNTY2My04MDAwLTAwMDA\n         w&amp;#10;MDAwNDFhOSIsICJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIiA6ICJodHRwczovL2xvY\n         2Fs&amp;#10;aG9zdC5tb2RpcnVtLmNvbTo4NTQzL21kcGF5bXBpL01lcmNoYW50U2VydmVyP21uPVkmd\n         HhpZD0x&amp;#10;NjgwOSZkaWdlc3Q9aSUyQnhhUEF5NWFOcVJRbllqNmozbWFDZlFJbTdFdjJYTmkwNn\n         h6YmZNJTJG&amp;#10;R3MlM0QiIH0\"/&gt;\n&lt;/form&gt;&lt;script type=\"text/javascript\" xmlns=\"http://www.w3.org/1999/xhtml\"&gt;\n         document.getElementById(\"tdsMmethodForm\").submit(); &lt;/script&gt;"},"secure3dTransId":{"description":"A unique transaction identifier supplied by the ACS.","type":"string","example":"3ac7caa7-aa42-2663-791b-2ac05a542c4a"}}}},"example":{"type":"3D_SECURE","version":"2.1","redirectURL":"http://pay.issuer-bank.com/sessionID=123&sharedKey=456","secure3dMethod":{"methodForm":"&lt;!DOCTYPE iframe SYSTEM \"about:legacy-compat\"&gt; &lt;iframe id=\"tdsMmethodTgtFrame\" name=\"tdsMmethodTgtFrame\"\n                         style=\"width: 1px; height: 1px; display: none;\" src=\"javascript:false;\" xmlns=\"http://www.w3.org/1999/xhtml\"&gt;\n                &lt;!--.--&gt; &lt;/iframe&gt;&lt;form id=\"tdsMmethodForm\" name=\"tdsMmethodForm\"\n                         action=\"https://localhost.modirum.com:8543/dstests/ACSEmu2\" method=\"post\"\n                         target=\"tdsMmethodTgtFrame\" xmlns=\"http://www.w3.org/1999/xhtml\"&gt; &lt;input type=\"hidden\" name=\"3DSMethodData\"\n                         value=\"eyAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogIjAwMDAwMDAwLTU2NzYtNTY2My04MDAwLTAwMDAw\n                &amp;#10;MDAwNDFhOSIsICJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIiA6ICJodHRwczovL2xvY\n                         2Fs&amp;#10;aG9zdC5tb2RpcnVtLmNvbTo4NTQzL21kcGF5bXBpL01lcmNoYW50U2VydmVyP21uPVkmdHhpZD0x\n                &amp;#10;NjgwOSZkaWdlc3Q9aSUyQnhhUEF5NWFOcVJRbllqNmozbWFDZlFJbTdFdjJYTmkwNn\n                         h6YmZNJTJG&amp;#10;R3MlM0QiIH0\"/&gt; &lt;input type=\"hidden\" name=\"threeDSMethodData\"\n                         value=\"eyAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogIjAwMDAwMDAwLTU2NzYtNTY2My04MDAwLTAwMDA\n                         w&amp;#10;MDAwNDFhOSIsICJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIiA6ICJodHRwczovL2xvY\n                         2Fs&amp;#10;aG9zdC5tb2RpcnVtLmNvbTo4NTQzL21kcGF5bXBpL01lcmNoYW50U2VydmVyP21uPVkmd\n                         HhpZD0x&amp;#10;NjgwOSZkaWdlc3Q9aSUyQnhhUEF5NWFOcVJRbllqNmozbWFDZlFJbTdFdjJYTmkwNn\n                         h6YmZNJTJG&amp;#10;R3MlM0QiIH0\"/&gt;\n                &lt;/form&gt;&lt;script type=\"text/javascript\" xmlns=\"http://www.w3.org/1999/xhtml\"&gt;\n                         document.getElementById(\"tdsMmethodForm\").submit(); &lt;/script&gt;"},"secure3dTransId":"3ac7caa7-aa42-2663-791b-2ac05a542c4a"}},"Expiration":{"description":"Required for normal transactions except for payment with 'RECURRING' flags.","required":["month","year"],"properties":{"month":{"description":"Month of the card expiration date in MM format.","type":"string","pattern":"^(0[1-9]|1[012])$","example":"03"},"year":{"description":"Year of the card expiration date in YY format.","type":"string","pattern":"^([0-9]{2})$","example":"21"}},"example":{"month":"03","year":"22"}},"fundingCardNumber":{"description":"Required for tokenied pan transactions.","required":["bin","last4"],"properties":{"bin":{"description":"Bin of the card number.","type":"string","pattern":"^([0-9]{6})$","example":"543987","maxLength":8},"last4":{"description":"Last 4 digit of Card number.","type":"string","pattern":"^([0-9]{4})$","example":"2451"}},"example":{"bin":"543987","last4":"2451"}},"AVSResponse":{"description":"The processor address validation response for compliance.","properties":{"streetMatch":{"description":"Response if street matches that on file.","type":"string","enum":["Y","N","NO_INPUT_DATA","NOT_CHECKED"],"example":"Y"},"postalCodeMatch":{"description":"Response if postal code matches that on file.","type":"string","enum":["Y","N","NO_INPUT_DATA","NOT_CHECKED"],"example":"N"},"associationAvsResponse":{"description":"The raw address verification response code returned by issuer. Please refer to response codes section in developer portal for more info.","type":"string","example":"Y"}},"example":{"streetMatch":"Y","postalCodeMatch":"N","associationAvsResponse":"Y"}},"TaxRefundData":{"description":"Local tax refund related information.","properties":{"indicator":{"description":"It is the tax refund indicator.","type":"string","example":"NOT_APPLIED"},"amount":{"description":"It is the tax refund amount.","type":"number","example":0.21},"lawNumber":{"description":"It is the tax refund law number.","type":"string","example":"019540"},"cardOriginType":{"description":"It is the tax refund card origin type.","type":"string","example":"NATIONAL"}},"example":{"indicator":"NOT_APPLIED","amount":0.21,"lawNumber":"019540","cardOriginType":"NATIONAL"}},"TaxRefundRequestData":{"description":"Local tax refund related information.","properties":{"legalFramework":{"description":"It is used to send law information in request.","type":"string","example":"URY_RETURNS_IVA_LAW_19210"}},"example":{"legalFramework":"URY_RETURNS_IVA_LAW_19210"}},"AccountVerificationResponse":{"description":"Account Verification Response.","properties":{"firstNameMatch":{"$ref":"#/components/schemas/AccountNameMatch"},"middleNameMatch":{"$ref":"#/components/schemas/AccountNameMatch"},"lastNameMatch":{"$ref":"#/components/schemas/AccountNameMatch"},"fullNameMatch":{"$ref":"#/components/schemas/AccountNameMatch"},"nameMatchIndicator":{"description":"Name Matching Indicator.","type":"string","enum":["PERFORMED","NOT_SUPPORTED","NOT_PERFORMED"],"example":"NOT_SUPPORTED"}}},"AccountNameMatch":{"type":"string","description":"Reason set by the terminal to cancel the referenced transaction.","enum":["MATCH","PARTIAL_MATCH","NO_MATCH"],"example":"MATCH"},"CardholderInfoResponse":{"description":"The processor Cardholder Info Response.","properties":{"postalCodeOrZipMatch":{"description":"Response if card holder postal code matches that on file.","type":"string","example":"Y"},"addressMatch":{"description":"Response if card holder address matches that on file.","type":"string","example":"RETRY"},"nameMatch":{"description":"Response if card holder name matches that on file.","type":"string","example":"SERVICE_NOT_ALLOWED"},"telephoneMatch":{"description":"Response if card holder telephone matches that on file.","type":"string","example":"NOT_CHECKED"},"emailMatch":{"description":"Response if card holder email matches that on file.","type":"string","example":"N"},"associationCardholderInfoResponse":{"description":"Raw cardholder info response from AMEX with no mapping.","type":"string","example":"YNUSR"}}},"DecoupledAuthenticationParameters":{"description":"Contains the decoupled authentication parameters","required":["decMaxTime","decReqInd"],"example":{"decMaxTime":10,"decReqInd":"Y"},"properties":{"decMaxTime":{"description":"Indicates the maximum amount of time that the 3DS Requestor will wait for an ACS to provide the results of a Decoupled Authentication transaction (in minutes).","type":"integer","format":"int32","minimum":1,"maximum":10080,"example":10},"decReqInd":{"description":"Indicates whether the 3DS Requestor requests the ACS to utilise Decoupled Authentication and agrees to utilise Decoupled Authentication if the ACS confirms its use. 'Y' = Decoupled Authentication is supported and preferred if challenge is necessary. 'N' = Do not use Decoupled Authentication.\n","type":"string","enum":["Y","N"],"example":"Y"}}},"CardholderBrowserParameters":{"description":"Contains the cardholders browser parameters","example":{"browserAcceptHeaders":"Accept: text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8","browserIP":"85.117.56.12","browserLanguage":"es-419","browserColorDepth":"32","browserScreenHeight":"1080","browserScreenWidth":"1920","browserTimeZone":"-300","browserUserAgent":"Lynx/2.8.4rel.1 libwww-FM/2.14 SSL-MM/1.4.1 OpenSSL/0.9.6c"},"properties":{"browserAcceptHeaders":{"description":"Browser accept headers","type":"string","maxLength":2048,"example":"Accept: text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8"},"browserIP":{"description":"Browser IP address (IPv4 or IPv6)","type":"string","maxLength":45,"example":"192.168.2.1"},"browserLanguage":{"description":"Value representing the browser language as defined in IETF BCP47","type":"string","maxLength":8,"example":"es-419"},"browserColorDepth":{"description":"Value representing the bit depth of the colour palette for displaying images, in bits per pixel.","type":"string","enum":["1","4","8","15","16","24","32","48"],"example":"24"},"browserScreenHeight":{"description":"Total height of the Cardholder’s screen in pixels","type":"string","maxLength":6,"pattern":"^([1-9][0-9]{0,5})$","example":"1080"},"browserScreenWidth":{"description":"Total width of the cardholder’s screen in pixels.","type":"string","maxLength":6,"pattern":"^([1-9][0-9]{0,5})$","example":"1920"},"browserTimeZone":{"description":"Browser time zone (zone offset value in minutes).","type":"string","maxLength":5,"example":"-300"},"browserUserAgent":{"description":"The browsers user agent string","type":"string","maxLength":2048,"example":"Lynx/2.8.4rel.1 libwww-FM/2.14 SSL-MM/1.4.1 OpenSSL/0.9.6c"}}},"EncryptedApplePay":{"description":"Encrypted Apple Pay payload.","required":["data","header","signature","merchantId"],"properties":{"data":{"description":"The encrypted wallet payload.","type":"string","pattern":"^(?!\\s*$).+","example":"NdCmVw5nMjQq746HYc/VbiZcQZ/zFzeEcM1wVMPruEG4/C/EFhobSkwB5JZJU+t6JuDVXUBiRYuOOC8FTYd+qIm6ckktid9aiGh0f2NDP0INSr59QXmr389RonyUfRYKnBmwsh5UqtI7Iz0AmMtl1PWMdxcCewtjuffs79ahTnFgXsRN+ynuhyDfbdRanlTnYKGoTeVh9eJfheJ1wquO+jiGj+npJ/Oh9bAdlw7iEHrYO2aUkgaMyXZ3foXRAJeimQVQS1y8lU1PPq62zpPrFzidbnnU5fK25pvGFjOdmLsBELZPk5thQEkSaA9p1LSKzWSesHhi0BxZaFPXSA6ANXvYIU2AT0lG+0O0w1URA5Sinyj3YDZVqjuir6rzNN9bB2U2nTQnKMbuGLMS20K8fUKZN/YLJh+AtE6J69+VVSU95mE1nOb8hyabz6E5RmnC5Ze2k6F/hQ75ig=="},"header":{"description":"Additional version-dependent information used to decrypt and verify the payment.","type":"object","required":["ephemeralPublicKey","publicKeyHash","transactionId"],"example":{"ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiaU1SbkYTJy/j5L1t51vtGDh4KlNl5MFPWzo/C8r0WcrktWriz5pdRaDVUDvU++KlDu2iuQsd2xSNKJlFscbDQ==","publicKeyHash":"YmSWN7lj4+A6fVJVPicP8TgS7gI7ougD8rEWB5LXtMM=","transactionId":"31323334353637"},"properties":{"applicationDataHash":{"description":"Merchant supplied information about the payment request. Contains Base64-encoded SHA256 hash of the applicationData property of the original PKPaymentRequest. Note - applicationData from PaymentData of PKPaymentToken Refer to Apple Pay documentation.","type":"string","example":"94ee059335e587e501cc4bf90613e0814f00a7b08bc7c648fd865a2af6a22cc2"},"ephemeralPublicKey":{"description":"Temporary key for generating shared secret from a device.","type":"string","pattern":"^(?!\\s*$).+","example":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiaU1SbkYTJy/j5L1t51vtGDh4KlNl5MFPWzo/C8r0WcrktWriz5pdRaDVUDvU++KlDu2iuQsd2xSNKJlFscbDQ=="},"publicKeyHash":{"description":"Hash of the X.509 encoded public key bytes of the merchant’s certificate.","type":"string","pattern":"^(?!\\s*$).+","example":"YmSWN7lj4+A6fVJVPicP8TgS7gI7ougD8rEWB5LXtMM="},"transactionId":{"description":"Transaction identifier, generated on the device.","type":"string","pattern":"^(?!\\s*$).+","example":"31323334353637"}}},"signature":{"description":"Signature of the payment and header data.","type":"string","pattern":"^(?!\\s*$).+","example":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIB0zCCAXkCAQEwCQYHKoZIzj0EATB2MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTkoxFDASBgNVBAcMC0plcnNleSBDaXR5MRMwEQYDVQQKDApGaXJzdCBEYXRhMRIwEAYDVQQLDAlGaXJzdCBBUEkxGzAZBgNVBAMMEmQxZHZ0bDEwMDAuMWRjLmNvbTAeFw0xNTA3MjMxNjQxMDNaFw0xOTA3MjIxNjQxMDNaMHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErnHhPM18HFbOomJMUiLiPL7nrJuWvfPy0Gg3xsX3m8q0oWhTs1QcQDTT+TR3yh4sDRPqXnsTUwcvbrCOzdUEeTAJBgcqhkjOPQQBA0kAMEYCIQDrC1z2JTx1jZPvllpnkxPEzBGk9BhTCkEB58j/Cv+sXQIhAKGongoz++3tJroo1GxnwvzK/Qmc4P1K2lHoh9biZeNhAAAxggFUMIIBUAIBATB7MHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tAgEBMA0GCWCGSAFlAwQCAQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTUwODEyMTczMTAwWjAvBgkqhkiG9w0BCQQxIgQgJyjKLiGQo3I1ZbfHSmF2XCZ8dNlcZyohziuXO48EKwgwCgYIKoZIzj0EAwIESDBGAiEAznKDYEz9MsC+r1g6e4LR1DTaQOl+X2rVNkWnKDpc1EQCIQCmK48ChHoz4HWnUnW5XqaGWOUXKHQvUgeqFr/jgBUzegAAAAAAAA=="},"version":{"description":"Version information about the payment token.","type":"string","enum":["EC_v1"],"example":"EC_v1"},"applicationData":{"description":"Base64-encoded value of PKPaymentRequest. Required only if applicationDataHash is present.","type":"string","example":"VEVTVA=="},"merchantId":{"description":"The merchant ID assigned by the wallet provider.","type":"string","pattern":"^(?!\\s*$).+","example":"order-1"}},"example":{"data":"NdCmVw5nMjQq746HYc/VbiZcQZ/zFzeEcM1wVMPruEG4/C/EFhobSkwB5JZJU+t6JuDVXUBiRYuOOC8FTYd+qIm6ckktid9aiGh0f2NDP0INSr59QXmr389RonyUfRYKnBmwsh5UqtI7Iz0AmMtl1PWMdxcCewtjuffs79ahTnFgXsRN+ynuhyDfbdRanlTnYKGoTeVh9eJfheJ1wquO+jiGj+npJ/Oh9bAdlw7iEHrYO2aUkgaMyXZ3foXRAJeimQVQS1y8lU1PPq62zpPrFzidbnnU5fK25pvGFjOdmLsBELZPk5thQEkSaA9p1LSKzWSesHhi0BxZaFPXSA6ANXvYIU2AT0lG+0O0w1URA5Sinyj3YDZVqjuir6rzNN9bB2U2nTQnKMbuGLMS20K8fUKZN/YLJh+AtE6J69+VVSU95mE1nOb8hyabz6E5RmnC5Ze2k6F/hQ75ig==","header":{"applicationDataHash":"94ee059335e587e501cc4bf90613e0814f00a7b08bc7c648fd865a2af6a22cc2","ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiaU1SbkYTJy/j5L1t51vtGDh4KlNl5MFPWzo/C8r0WcrktWriz5pdRaDVUDvU++KlDu2iuQsd2xSNKJlFscbDQ==","publicKeyHash":"YmSWN7lj4+A6fVJVPicP8TgS7gI7ougD8rEWB5LXtMM=","transactionId":"31323334353637"},"signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIIB0zCCAXkCAQEwCQYHKoZIzj0EATB2MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTkoxFDASBgNVBAcMC0plcnNleSBDaXR5MRMwEQYDVQQKDApGaXJzdCBEYXRhMRIwEAYDVQQLDAlGaXJzdCBBUEkxGzAZBgNVBAMMEmQxZHZ0bDEwMDAuMWRjLmNvbTAeFw0xNTA3MjMxNjQxMDNaFw0xOTA3MjIxNjQxMDNaMHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErnHhPM18HFbOomJMUiLiPL7nrJuWvfPy0Gg3xsX3m8q0oWhTs1QcQDTT+TR3yh4sDRPqXnsTUwcvbrCOzdUEeTAJBgcqhkjOPQQBA0kAMEYCIQDrC1z2JTx1jZPvllpnkxPEzBGk9BhTCkEB58j/Cv+sXQIhAKGongoz++3tJroo1GxnwvzK/Qmc4P1K2lHoh9biZeNhAAAxggFUMIIBUAIBATB7MHYxCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJOSjEUMBIGA1UEBwwLSmVyc2V5IENpdHkxEzARBgNVBAoMCkZpcnN0IERhdGExEjAQBgNVBAsMCUZpcnN0IEFQSTEbMBkGA1UEAwwSZDFkdnRsMTAwMC4xZGMuY29tAgEBMA0GCWCGSAFlAwQCAQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTUwODEyMTczMTAwWjAvBgkqhkiG9w0BCQQxIgQgJyjKLiGQo3I1ZbfHSmF2XCZ8dNlcZyohziuXO48EKwgwCgYIKoZIzj0EAwIESDBGAiEAznKDYEz9MsC+r1g6e4LR1DTaQOl+X2rVNkWnKDpc1EQCIQCmK48ChHoz4HWnUnW5XqaGWOUXKHQvUgeqFr/jgBUzegAAAAAAAA==","applicationData":"VEVTVA==","merchantId":"order-1","version":"EC_v1"}},"EncryptedGooglePay":{"description":"Encrypted Google Pay payload.","required":["data","signature","version"],"properties":{"data":{"description":"The encrypted wallet payload.","type":"object","required":["encryptedMessage","ephemeralPublicKey","tag"],"example":{"encryptedMessage":"8nxjB9mr2tWZeDRQRcGN91UUnb7AioGp3oRo8kmQ6lyvJZiqD7PJlbRCYElNqUmr6Z8zK7b2gO9MKOjpnTCqH0qAe2vuIlwNXB60M2Lh7Qfl3bVgWzwF/FfFcenVW381hoItYi8AjWnWoydz1XMTEv2qhqUG03mEnRXdMyDyk6KKZXoW8Qc0p1F1thbxxu8weU8CZbZsWGGTjB42cilIqLVbribcOAG8Oas1AcgefFsu2hwp4gdSuOg7wmeSV7XKsGQzzVy85qtjuqET2XYzJE3K/Wh9QKkhu5P9Ms5s1+Smr2IjRyidqQa88SxQplrVoo9+PvT0bxFcMspBmO3pLkuaZSUBy++dL2fefcxNJvGCFfFhdxW9DojuuQxgpeu7RAQUsGLyFmr/4ZfBxt882xTmpX9MRx5CAudl9qUgBfKdwWwMX35qSbDTm1ju5XXzNh94VebjD3bB9Zj8qgbmUOr/+6OQLhoFJyBCXgx3EEH8hBwNVFrss/SLwQvFhZh62eO6lOtnmbOtP1yTDDVqGDBfai5SwAmM+KTcc9SGv/xDC+cWe8ck+aCBkG4HoRPapUVMZ3JIgV7yzTsVLJE\\\\u003d\\\\","ephemeralPublicKey":"BGH3fRFdoAobYrAlxnZOCYzkH84Cna92IZxtgsU36CMDaqSaDYb9/LsY8qw+vMtlBnwsUg/YVMOeeKp+qDkOWb4\\\\u003d\\\\","tag":"nvmOUNpnOTZULLhMxT/hWCHzH/4f7gGpfvQgwl3p8ng\\\\u003d\\\\"},"properties":{"encryptedMessage":{"description":"The encrypted message containing the actual payment information as well as additional security fields.","type":"string","pattern":"^(?!\\s*$).+","example":"8nxjB9mr2tWZeDRQRcGN91UUnb7AioGp3oRo8kmQ6lyvJZiqD7PJlbRCYElNqUmr6Z8zK7b2gO9MKOjpnTCqH0qAe2vuIlwNXB60M2Lh7Qfl3bVgWzwF/FfFcenVW381hoItYi8AjWnWoydz1XMTEv2qhqUG03mEnRXdMyDyk6KKZXoW8Qc0p1F1thbxxu8weU8CZbZsWGGTjB42cilIqLVbribcOAG8Oas1AcgefFsu2hwp4gdSuOg7wmeSV7XKsGQzzVy85qtjuqET2XYzJE3K/Wh9QKkhu5P9Ms5s1+Smr2IjRyidqQa88SxQplrVoo9+PvT0bxFcMspBmO3pLkuaZSUBy++dL2fefcxNJvGCFfFhdxW9DojuuQxgpeu7RAQUsGLyFmr/4ZfBxt882xTmpX9MRx5CAudl9qUgBfKdwWwMX35qSbDTm1ju5XXzNh94VebjD3bB9Zj8qgbmUOr/+6OQLhoFJyBCXgx3EEH8hBwNVFrss/SLwQvFhZh62eO6lOtnmbOtP1yTDDVqGDBfai5SwAmM+KTcc9SGv/xDC+cWe8ck+aCBkG4HoRPapUVMZ3JIgV7yzTsVLJE\\\\u003d\\\\"},"ephemeralPublicKey":{"description":"The ephemeral public key associated with the private key to encrypt the message in uncompressed point format.","type":"string","pattern":"^(?!\\s*$).+","example":"BGH3fRFdoAobYrAlxnZOCYzkH84Cna92IZxtgsU36CMDaqSaDYb9/LsY8qw+vMtlBnwsUg/YVMOeeKp+qDkOWb4\\\\u003d\\\\"},"tag":{"description":"MAC of the encryptedMessage.","type":"string","pattern":"^(?!\\s*$).+","example":"nvmOUNpnOTZULLhMxT/hWCHzH/4f7gGpfvQgwl3p8ng\\\\u003d\\\\"}}},"intermediateSigningKey":{"description":"The intermediateSigningKey is a UTF-8 encoded, serialized JSON object that contains the signedKey and signatures.","type":"object","required":["signedKey","signatures"],"example":{"signedKey":{"keyValue":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/1+3HBVSbdv+j7NaArdgMyoSAM43yRydzqdg1TxodSzA96Dj4Mc1EiKroxxunavVIvdxGnJeFViTzFvzFRxyCw\\u003d\\u003d","keyExpiration":"123581321345589"},"signatures":"[\"MEYCIQDcXCoB4fYJF3EolxrE2zB+7THZCfKA7cWxSztKceXTCgIhAN/d5eBgx/1A6qKBdH0IS7/aQ7dO4MuEt26OrLCUxZnl\"]"},"properties":{"signedKey":{"description":"A base64-encoded message that contains the payment description of the key.","type":"object","required":["keyValue","keyExpiration"],"example":{"keyValue":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/1+3HBVSbdv+j7NaArdgMyoSAM43yRydzqdg1TxodSzA96Dj4Mc1EiKroxxunavVIvdxGnJeFViTzFvzFRxyCw\\u003d\\u003d","keyExpiration":"123581321345589"},"properties":{"keyValue":{"description":"A base64 version of the key encoded in ASN.1 type. The definition of SubjectPublicKeyInfo is in the X.509 standard.","type":"string","maxLength":200,"pattern":"^(?!\\s*$).+","example":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/1+3HBVSbdv+j7NaArdgMyoSAM43yRydzqdg1TxodSzA96Dj4Mc1EiKroxxunavVIvdxGnJeFViTzFvzFRxyCw\\u003d\\u003d"},"keyExpiration":{"description":"Date and time when the intermediate key expires as UTC milliseconds since epoch. Integrators reject any expired keys.","type":"string","maxLength":20,"pattern":"^(?!\\s*$).+","example":"123581321345589"}}},"signatures":{"description":"Verifies that the intermediate signing key came from Google. It's base64-encoded, and is put together with ECDSA.","type":"array","maxItems":1,"items":{"description":"Array contains the signature string","type":"string","maxLength":150,"pattern":"^(?!\\s*$).+","example":"MEYCIQDcXCoB4fYJF3EolxrE2zB+7THZCfKA7cWxSztKceXTCgIhAN/d5eBgx/1A6qKBdH0IS7/aQ7dO4MuEt26OrLCUxZnl"}}}},"signature":{"description":"Signature for verifying that the message comes from Google. The signature is created using ECDSA.","type":"string","pattern":"^(?!\\s*$).+","example":"MEUCIFWTRWUZAOM5nfJC79FtJm56olnbwG4H5uWWxAUWAquiAiEA24j/BcOroeISsdJzYsyoVi8wzu4tnmKw+jdsGfuvPko="},"version":{"description":"Identifies under which encryption/signing scheme this message has been created. In this way, the protocol can evolve over time if needed. For Google Payments transactions, this should be set to ECv1.","type":"string","pattern":"^(?!\\s*$).+","example":"ECv1"}},"example":{"data":{"encryptedMessage":"8nxjB9mr2tWZeDRQRcGN91UUnb7AioGp3oRo8kmQ6lyvJZiqD7PJlbRCYElNqUmr6Z8zK7b2gO9MKOjpnTCqH0qAe2vuIlwNXB60M2Lh7Qfl3bVgWzwF/FfFcenVW381hoItYi8AjWnWoydz1XMTEv2qhqUG03mEnRXdMyDyk6KKZXoW8Qc0p1F1thbxxu8weU8CZbZsWGGTjB42cilIqLVbribcOAG8Oas1AcgefFsu2hwp4gdSuOg7wmeSV7XKsGQzzVy85qtjuqET2XYzJE3K/Wh9QKkhu5P9Ms5s1+Smr2IjRyidqQa88SxQplrVoo9+PvT0bxFcMspBmO3pLkuaZSUBy++dL2fefcxNJvGCFfFhdxW9DojuuQxgpeu7RAQUsGLyFmr/4ZfBxt882xTmpX9MRx5CAudl9qUgBfKdwWwMX35qSbDTm1ju5XXzNh94VebjD3bB9Zj8qgbmUOr/+6OQLhoFJyBCXgx3EEH8hBwNVFrss/SLwQvFhZh62eO6lOtnmbOtP1yTDDVqGDBfai5SwAmM+KTcc9SGv/xDC+cWe8ck+aCBkG4HoRPapUVMZ3JIgV7yzTsVLJE\\\\u003d\\\\","ephemeralPublicKey":"BGH3fRFdoAobYrAlxnZOCYzkH84Cna92IZxtgsU36CMDaqSaDYb9/LsY8qw+vMtlBnwsUg/YVMOeeKp+qDkOWb4\\\\u003d\\\\","tag":"nvmOUNpnOTZULLhMxT/hWCHzH/4f7gGpfvQgwl3p8ng\\\\u003d\\\\"},"intermediateSigningKey":{"signedKey":{"keyValue":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE/1+3HBVSbdv+j7NaArdgMyoSAM43yRydzqdg1TxodSzA96Dj4Mc1EiKroxxunavVIvdxGnJeFViTzFvzFRxyCw\\u003d\\u003d","keyExpiration":"123581321345589"},"signatures":"[\"MEYCIQDcXCoB4fYJF3EolxrE2zB+7THZCfKA7cWxSztKceXTCgIhAN/d5eBgx/1A6qKBdH0IS7/aQ7dO4MuEt26OrLCUxZnl\"]"},"signature":"MEUCIFWTRWUZAOM5nfJC79FtJm56olnbwG4H5uWWxAUWAquiAiEA24j/BcOroeISsdJzYsyoVi8wzu4tnmKw+jdsGfuvPko=","version":"ECv1"}},"EncryptedClickToPay":{"description":"Encrypted ClickToPay payload.","required":["checkoutResponseEncrypted","merchantTransactionId","xSrcCxFlowId"],"properties":{"checkoutResponseEncrypted":{"type":"string","description":"Checkout Payload Response is a complex JSON Web Token wrapper object containing following set of attributes."},"merchantTransactionId":{"type":"string","description":"Merchant Checkout Transaction Identifier which is returned in the checkoutResponse to either checkoutWithCard or checkoutWithNewCard JavaScript methods and links the client-side JavaScript calls and server-side API calls for a specific transaction. Optional for Subsequent Payment or Subsequent Split Shipment."},"xSrcCxFlowId":{"description":"The X-Src-Cx-Flow-Id helps in routing and session affinity. Usage of X-Src-Cx-Flow-Id in requests ensures requests by the same client are directed to the same server. When you make your initial API call, use the X-Src-Cx-Flow-Id, returned in one of the client-side calls checkoutWithNewCard() or checkoutWitCard(). If you do not send X-Src-Cx-Flow-Id in your request or if the field is empty, the Click to Pay system generates one and responds with the X-Src-Cx-Flow-Id in the header. The X-Src-Cx-Flow-Id returned in the response can be used in the subsequent calls to ensure these calls are directed to the same server that returned the initial response.","type":"string"},"organizationalId":{"type":"string","description":"Open API key to make the server to server call to Mastercard SRCI. This ID is provided to the client during the onboarding process to make OAuth1.0 based signed requests. The value MUST match the SRC Client ID present in the request body."},"digitalPaymentApplicationId":{"description":"Client ID. This is the DPA ID of the merchant.","type":"string"}},"example":{"checkoutResponseEncrypted":"eyJpc3MiOiJodHRwczpcL1wvbWFzdGVyY2FyZC5jb20iLCJpYXQiOjE3MjU4OTc2OTAsImFsZyI6IlJTMjU2IiwianRpIjoiMmZhOWM1N2UtOTRlNS00MDY0LWExMmItN2ZkZGFkYmI1ZmJlIiwia2lkIjoiMjAyMzAyMDcxNjQ2MTMtc2FuZGJveC1wYXlsb2FkLXZlcmlmaWNhdGlvbi1zcmMtbWFzdGVyY2FyZC1pbnQifQ.eyJzcmNDb3JyZWxhdGlvbklkIjoiNGYzMzliZTcuZjA0N2QyZjYtZTk2MS00MGJlLTg1ZWQtMGVhZTNkZDNmNjY5Iiwic3JjaVRyYW5zYWN0aW9uSWQiOiJmMGQ3NWUzYy0yMmQ1LTQ0MmItYTc2My1jM2FkYjNlMGZhN2YiLCJtYXNrZWRDYXJkIjp7InNyY0RpZ2l0YWxDYXJkSWQiOiJJWjBwT1hKZVNVLXF0cGYzY2NKVkR3MDAwMDAwMDAwMDAwVVMiLCJwYW5CaW4iOiI1MTg2MDAiLCJwYW5MYXN0Rm91ciI6Ijg3ODUiLCJkaWdpdGFsQ2FyZERhdGEiOnsic3RhdHVzIjoiQUNUSVZFIiwiYXJ0VXJpIjoiaHR0cHM6Ly9zYnguYXNzZXRzLm1hc3RlcmNhcmQuY29tL2NhcmQtYXJ0L2NvbWJpbmVkLWltYWdlLWFzc2V0L0hJR0gtTUFTSy0zeC5wbmcifSwicGFuRXhwaXJhdGlvbk1vbnRoIjoiMDYiLCJwYW5FeHBpcmF0aW9uWWVhciI6IjIwMjciLCJwYXltZW50Q2FyZERlc2NyaXB0b3IiOiJtYXN0ZXJjYXJkIiwicGF5bWVudENhcmRUeXBlIjoiUFJFUEFJRCIsIm1hc2tlZEJpbGxpbmdBZGRyZXNzIjp7ImFkZHJlc3NJZCI6IjI0MjY1ZGM3LTVhNTktNGVkNC1hMTRmLWFkMDcxZWE2NjNhNSIsIm5hbWUiOiJCaCoqKioqKioqZSBQYSoqbCIsImxpbmUxIjoiRioqKioqKioqKioqKiouIDYiLCJjaXR5IjoiRnJhbmtmdXJ0IiwiY291bnRyeUNvZGUiOiJERSIsInppcCI6IjU2MzI1IiwiY3JlYXRlVGltZSI6IjIwMjQtMDgtMjZUMTI6MjM6MjIuOTc5WiJ9LCJzZXJ2aWNlSWQiOiJTUkMiLCJkYXRlT2ZDYXJkQ3JlYXRlZCI6IjIwMjQtMDgtMjZUMTI6MjM6MTEuMjk0WiIsImRhdGVPZkNhcmRMYXN0VXNlZCI6IjIwMjQtMDktMDVUMTA6MDY6MTUuNjQ4WiJ9LCJtYXNrZWRDb25zdW1lciI6eyJzcmNDb25zdW1lcklkIjoiMzExZjRiNjEtYTUyZi00OWY4LWE2MDItMDA4YjJkMjM5ZmM0IiwibWFza2VkQ29uc3VtZXJJZGVudGl0eSI6eyJpZGVudGl0eVByb3ZpZGVyIjoiU1JDIiwiaWRlbnRpdHlUeXBlIjoiRU1BSUxfQUREUkVTUyIsIm1hc2tlZElkZW50aXR5VmFsdWUiOiJkKioqKipjQGZpc2Vydi5jb20ifSwibWFza2VkRW1haWxBZGRyZXNzIjoiZCoqKioqY0BmaXNlcnYuY29tIiwibWFza2VkTW9iaWxlTnVtYmVyIjp7ImNvdW50cnlDb2RlIjoiNDkiLCJwaG9uZU51bWJlciI6IioqKioqKioqNjA3In0sImNvdW50cnlDb2RlIjoiVVMiLCJsYW5ndWFnZUNvZGUiOiJlbiIsInN0YXR1cyI6IkFDVElWRSIsIm1hc2tlZEZpcnN0TmFtZSI6Im0qKioqKiIsIm1hc2tlZExhc3ROYW1lIjoiZioqKioqIiwibWFza2VkRnVsbE5hbWUiOiJtKioqKiogZioqKioqIiwiZGF0ZUNvbnN1bWVyQWRkZWQiOiIyMDI0LTA0LTE5VDA3OjI0OjQ2LjY5N1oiLCJkYXRlQ29uc3VtZXJMYXN0VXNlZCI6IjIwMjQtMDktMDlUMTU6NTg6MzcuMzc3WiJ9LCJhc3N1cmFuY2VEYXRhIjp7ImNhcmRWZXJpZmljYXRpb25FbnRpdHkiOiIwMiIsImNhcmRWZXJpZmljYXRpb25NZXRob2QiOiIwMyIsImNhcmRWZXJpZmljYXRpb25SZXN1bHRzIjoiMDEifX0.PfFzFkENtj0MaSEKYt29VdNSn1q6aFanmBAIZ6S6WDXrJQ0QvzmP6zvJyjhNd0oFUzFHzz6l3uoEIuUyZ71vnXVx93lgbEI7yYqYoUuUsOoVzxq9zE3H5RbsQrvW-h494OS0U6spRSefJpXuhtF8x24D43ROwWnEBRt9V7A211RgPjfbS8VfbMf77BH7_Sc_G4LHyFW2iQq6kGBJeFZgcRtyOhVGfqGxuvb4tTWYH8F6NJsNBnI3NYBI0PNoJ091H-VUmaB_qJ0z09ulYGX2u_1WcCtJ5cB3gzYJ7-xEAXm-KdCZxZ8DsjyYX8kJjjuZjYfJuTqJLphKiko06enStg","merchantTransactionId":"0a4e0d3.34f4a04b.390515165b8f87a5a0694cd752752ff6717fce21","xSrcCxFlowId":"34F4A04B.B9EF8486-E8C1-44F3-88DC-D4F516A354DC.1587777300","organizationalId":"729abcf5-264c-4f95-a88d-6d5831727734","digitalPaymentApplicationId":"57a8abed-dc75-4bd6-b2a9-0bc09d7c237a"}},"DecryptedApplePay":{"description":"Decrypted Apple Pay payload.","required":["accountNumber","expiration","cryptogram"],"properties":{"accountNumber":{"description":"Payment card number.","type":"string","pattern":"[0-9]{13,19}","example":"4111111111111111"},"expiration":{"description":"Card expiration date in MMYYYY format.","type":"string","pattern":"[0-9]{6}","example":"012040"},"cardholderName":{"description":"Name of the cardholder.","type":"string","maxLength":96,"pattern":"^(?!\\s*$).+","example":"John Doe"},"brand":{"description":"Card brand.","type":"string","pattern":"^(?!\\s*$).+","example":"VISA"},"cryptogram":{"description":"The wallet cryptogram from the decrypted data.","type":"string","pattern":"^(?!\\s*$).+","example":"BB81SRsADvooHCUcDogjMAACAAA="},"eciIndicator":{"description":"The ECI indicator from the decrypted data.","type":"string","pattern":"[0-9]{2}","example":"05"}},"example":{"accountNumber":"4111111111111111","expiration":"221201","cardholderName":"John Doe","brand":"VISA","cryptogram":"BB81SRsADvooHCUcDogjMAACAAA=","eciIndicator":"05"}},"DecryptedGooglePay":{"description":"Decrypted Google Pay payload.","required":["accountNumber","expiration"],"properties":{"accountNumber":{"description":"Payment card number.","type":"string","pattern":"[0-9]{13,19}","example":"4111111111111111"},"expiration":{"description":"Card expiration date in MMYYYY format.","type":"string","pattern":"[0-9]{6}","example":"012040"},"cardholderName":{"description":"Name of the cardholder.","type":"string","maxLength":96,"pattern":"^(?!\\s*$).+","example":"John Doe"},"brand":{"description":"Card brand.","type":"string","pattern":"^(?!\\s*$).+","example":"VISA"},"cryptogram":{"description":"The wallet cryptogram from the decrypted data.","type":"string","pattern":"^(?!\\s*$).+","example":"BB81SRsADvooHCUcDogjMAACAAA="},"eciIndicator":{"description":"The ECI indicator from the decrypted data.","type":"string","pattern":"[0-9]{2}","example":"05"},"storedCredentials":{"$ref":"#/components/schemas/StoredCredential"}},"example":{"accountNumber":"4111111111111111","expiration":"221201","cardholderName":"John Doe","brand":"VISA","cryptogram":"BB81SRsADvooHCUcDogjMAACAAA=","eciIndicator":"05","storedCredentials":{"sequence":"FIRST","scheduled":false,"referencedSchemeTransactionId":"019087868716215","initiator":"CARDHOLDER"}}},"Order":{"description":"Use this model to provide order related details.","properties":{"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","maxLength":100,"example":"ABC12345"},"purposeOfPaymentCode":{"description":"Merchants accepting cards issued in India, Bangladesh, Argentina and/or Egypt require it for VISA Original Credit Transfer Transactions.","type":"string","maxLength":12,"example":"ABC12345"},"billing":{"$ref":"#/components/schemas/Billing"},"shipping":{"$ref":"#/components/schemas/Shipping"},"serviceLocation":{"$ref":"#/components/schemas/ServiceLocation"},"industrySpecificExtensions":{"$ref":"#/components/schemas/IndustrySpecificExtensions"},"purchaseCard":{"$ref":"#/components/schemas/PurchaseCards"},"ip":{"$ref":"#/components/schemas/IPAddress"},"installmentOptions":{"$ref":"#/components/schemas/InstallmentOptions"},"revolvingOptions":{"$ref":"#/components/schemas/RevolvingOptions"},"standInDetails":{"$ref":"#/components/schemas/StandInDetails"},"tokenCryptogram":{"$ref":"#/components/schemas/TokenCryptogram"},"softDescriptor":{"$ref":"#/components/schemas/SoftDescriptor"},"additionalDetails":{"$ref":"#/components/schemas/AdditionalDetails"},"clientLocale":{"$ref":"#/components/schemas/ClientLocale"},"basket":{"$ref":"#/components/schemas/Basket"},"recurringPaymentDetails":{"$ref":"#/components/schemas/RecurringPaymentDetails"},"accountOwner":{"$ref":"#/components/schemas/AccountOwner"},"deliveryDetails":{"$ref":"#/components/schemas/DeliveryDetails"},"selectedInstallmentPlan":{"$ref":"#/components/schemas/InstallmentPlan"},"tokenRequestorID":{"description":"ID of the agent that requested Token on behalf of merchant. This will be passed to merchant by the agent at the time of Cryptogram request.","type":"string","maxLength":11,"example":12345678912},"tokenECI":{"description":"Electronic Commerce Type Indicator.","type":"string","maxLength":2,"example":5}},"example":{"orderId":"ABC12345","billing":{"name":"John Doe","customerId":"1234567890"},"shipping":{"name":"John Doe","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"}}}},"DeliveryDetails":{"description":"Merchant service location details.","properties":{"provider":{"description":"Delivery service provider.","type":"string","maxLength":50,"example":"NatWest"},"method":{"description":"Delivery service method.","type":"string","maxLength":50,"example":"Delivery"},"providerId":{"description":"Delivery service provider identifier.","type":"string","maxLength":50,"example":"IPG_FD"}},"example":{"provider":"NatWest","method":"Delivery","providerId":"IPG_FD"}},"Billing":{"description":"Customer billing information.","properties":{"name":{"description":"Billing name.","type":"string","maxLength":96,"example":"John Doe"},"firstName":{"description":"Billing first name. Note - Only supported for AMEX.","type":"string","maxLength":48,"example":"John"},"lastName":{"description":"Billing last name. Note - Only supported for AMEX.","type":"string","maxLength":48,"example":"Doe"},"customerId":{"description":"Customer ID for billing purpose.","type":"string","maxLength":32,"example":"1234567890"},"birthDate":{"description":"Customer birth date.","type":"string","format":"date","example":"1980-01-31"},"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"}},"example":{"name":"John Doe","firstName":"John","lastName":"Doe","customerId":"1234567890","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"}}},"Contact":{"description":"Customer contact information.","properties":{"phone":{"description":"Primary phone number.","type":"string","maxLength":32,"example":"5555555555"},"mobilePhone":{"description":"Mobile phone number.","type":"string","maxLength":32,"example":"5555555555"},"fax":{"description":"Fax number.","type":"string","maxLength":32,"example":"5555555555"},"email":{"description":"Email address.","type":"string","maxLength":254,"example":"john@test.com"}},"example":{"phone":"5555555555","mobilePhone":"5555555555","fax":"5555555555","email":"john@test.com"}},"Shipping":{"description":"Shipping information.","properties":{"name":{"description":"Name of customer for shipping.","type":"string","example":"John Doe","maxLength":96},"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"}},"example":{"name":"John Doe","contact":{"phone":"5555555555","mobilePhone":"5555555555","email":"john@test.com"},"address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"}}},"ServiceLocation":{"description":"Merchant service location details.","properties":{"city":{"description":"City or locality.","type":"string","maxLength":50,"example":"Sandy Springs"},"state":{"description":"2 or 3 chars ISO state code, like NA is ISO Code for New Hampshire state in USA. For UK sub country code with value ENG, NIR, SCT or WLS is expected.","type":"string","maxLength":3,"example":"NH"},"zip":{"description":"ZIP code or postal code.","type":"string","maxLength":12,"example":"30303"},"country":{"description":"ISO-3166-1  ALPHA-2, ALPHA-3, numeric or full country name.","type":"string","maxLength":32,"example":"USA"},"serviceLocationGeoCoordinates":{"description":"Geo Location.","$ref":"#/components/schemas/GeoLocation"}},"example":{"city":"Sandy Springs","state":"NH","zip":"30303","country":"USA","serviceLocationGeoCoordinates":{"latitude":-90.12345,"longitude":-180.12345}}},"GeoLocation":{"description":"Real-World geographical location of an entity identified via a set of geographic coordinates (latitude and longitude) through GPS.","required":["latitude","longitude"],"properties":{"latitude":{"$ref":"#/components/schemas/LatitudeValue"},"longitude":{"$ref":"#/components/schemas/LongitudeValue"}},"example":{"latitude":-90.12345,"longitude":-180.12345}},"LatitudeValue":{"description":"Latitude from equator. -90 (South) to +90 (North).","type":"number","minimum":-90,"maximum":90,"x-extra-annotation":"@javax.validation.constraints.Digits(integer = 2, fraction = 5)"},"LongitudeValue":{"description":"Longitude from Greenwich Meridian. -180 (West) to +180 (East).","type":"number","minimum":-180,"maximum":180,"x-extra-annotation":"@javax.validation.constraints.Digits(integer = 3, fraction = 5)"},"Address":{"description":"Address information that is passed to the issuer (it may appear on the cardholder’s statement) or if merchant wants to pass information that differs from the information stored on our master file.","properties":{"company":{"description":"Company name associated with the address.","type":"string","maxLength":96,"example":"Test Company"},"address1":{"description":"First line of the street address.","type":"string","maxLength":96,"example":"123 Main St."},"address2":{"description":"Second line of the street address.","type":"string","maxLength":96,"example":"Suite 123"},"city":{"description":"City or locality.","type":"string","maxLength":96,"example":"Sandy Springs"},"region":{"description":"State or province.","type":"string","maxLength":96,"example":"Georgia"},"postalCode":{"description":"ZIP code or postal code.","type":"string","maxLength":24,"example":"30303"},"country":{"description":"ISO-3166-1  ALPHA-2, ALPHA-3, numeric or full country name. In the case of PaySecure endpoints, pass the country code in an ISO format.\nNOTE: Country required for following listed SEPA transactions:\n - SEPA DD transaction done with Local Payments (aka PPRO).\n - SEPA DD transaction done via POSEIDON and the IBAN belongs to the 'SE' country group.","type":"string","maxLength":32,"example":"USA"}},"example":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"}},"ReceiptRequestInfo":{"description":"Defines receipt related parameters that are necessary to generate a receipt.","type":"object","required":["type"],"properties":{"type":{"description":"Defines the consumer of the receipt (e.g. cardholder, merchant).","type":"string","enum":["cardholder","merchant"],"example":"merchant"},"locale":{"description":"The locale of the receipt. The format has to be a well-formed BCP 47 language tag.","type":"string","example":"en-GB"},"linewidth":{"description":"The line width of the receipt. Default will be 32 characters.","type":"integer","example":32}},"example":{"type":"merchant","locale":"de"}},"Receipt":{"description":"Provides POS receipt data.","type":"object","required":["type","data"],"properties":{"type":{"description":"Defines the consumer of the receipt (e.g. cardholder, merchant).","type":"string","enum":["cardholder","merchant"],"example":"merchant"},"data":{"description":"Array of formatted lines that represents the actual receipt data, that can be printed out.","type":"array","items":{"$ref":"#/components/schemas/ReceiptLine"},"example":[{"endOfLine":true,"text":"          MerchantName          "},{"endOfLine":true,"text":"--------------------------------"}]}},"example":{"type":"cardholder","data":[{"endOfLine":true,"text":"        Example Merchant        "},{"endOfLine":true,"text":"--------------------------------"},{"endOfLine":true,"text":"       Amount: 45.00 EURO       "}]}},"ReceiptLine":{"description":"Represents a line in the receipt response.","type":"object","required":["text"],"properties":{"endOfLine":{"description":"Flag to indicate if the text ends at the end of this receipt line.","type":"boolean","default":true,"example":true},"text":{"description":"Text that represents a line of the actual receipt data, that can be printed out.","type":"string","example":"          MerchantName          "}},"example":{"endOfLine":true,"text":"--------------------------------"}},"IndustrySpecificExtensions":{"description":"Industry-specific information.","properties":{"airline":{"$ref":"#/components/schemas/Airline"},"lodging":{"$ref":"#/components/schemas/Lodging"},"carRental":{"$ref":"#/components/schemas/CarRental"},"mcc6012":{"$ref":"#/components/schemas/Mcc6012"}},"example":{"airline":{"passengerName":"John Doe","ticketNumber":"PCLAN123","carrierName":"Quatar Airline","reservationSystem":"START","travelRoute":[{"departureDate":"2018-10-15","origin":"ATL","destination":"DOH"}]},"lodging":{"arrivalDate":"2010-05-15","departureDate":"2018-01-28","folioNumber":"12200054891","extraCharges":[{"chargeItem":"MINI_BAR"},{"chargeItem":"OTHER"}],"noShowIndicator":false},"carRental":{"agreementNumber":"AGR 123","renterName":"John Doe","returnCity":"ATL","returnDare":"2018-10-25","pickupDate":"2018-10-15"},"mcc6012":{"dateOfBirth":"20200505","accountFirst6":"411111","accountLast4":"2343","accountNum":"546789900034567","postCode":"30101","surname":"Walker"}}},"StoredCredential":{"description":"Object for sending stored credentials.","required":["sequence","scheduled"],"properties":{"sequence":{"description":"Indicates if the transaction is first or subsequent. Valid values are First and 'SUBSEQUENT'.","type":"string","enum":["FIRST","SUBSEQUENT"],"example":"FIRST"},"scheduled":{"description":"Indicates if the transaction is scheduled or part of an installment.","type":"boolean","example":true},"referencedSchemeTransactionId":{"description":"The transaction ID received from schemes for the initial transaction. May be required if sequence is 'SUBSEQUENT'.","type":"string","maxLength":50,"example":"019087868716215"},"initiator":{"description":"Indicates whether it is a merchant-initiated or explicitly consented to by card holder. Valid values are 'MERCHANT' and 'CARDHOLDER'.","type":"string","enum":["MERCHANT","CARDHOLDER"],"example":"MERCHANT"},"indicatorSubcategory":{"description":"For initiator as CARDHOLDER- CREDENTIAL_ON_FILE_FIRST, CREDENTIAL_ON_FILE_SUBSEQUENT, STANDING_ORDER, SUBSCRIPTION, INSTALLMENT are the valid values of indicatorSubcatogory. |For initiator as MERCHANT- UNSCHEDULED_CREDENTIAL_ON_FILE, STANDING_ORDER, SUBSCRIPTION, INSTALLMENT, PARTIAL_SHIPMENT, DELAYED_CHARGE, NO_SHOW_CHARGE, RESUBMISSION are the valid values as indicatorSubcategory. |Not valid values will be ignored.","type":"string","enum":["CREDENTIAL_ON_FILE_FIRST","CREDENTIAL_ON_FILE_SUBSEQUENT","UNSCHEDULED_CREDENTIAL_ON_FILE","STANDING_ORDER","SUBSCRIPTION","INSTALLMENT","PARTIAL_SHIPMENT","DELAYED_CHARGE","NO_SHOW_CHARGE","RESUBMISSION"],"example":"CREDENTIAL_ON_FILE_FIRST"}},"example":{"sequence":"SUBSEQUENT","scheduled":false,"referencedSchemeTransactionId":"019087868716215","initiator":"CARDHOLDER"}},"Airline":{"description":"Additional data specific to the airline industry.","properties":{"passengerName":{"description":"The passenger name associated with the transaction.","type":"string","maxLength":30,"example":"Jeff Yabuki"},"ticketNumber":{"description":"The airline ticket number associated with the transaction.","type":"string","maxLength":20,"example":"52300448"},"issuingCarrier":{"description":"The carrier that issued the ticket.","type":"string","maxLength":20,"example":"Frontier Airlines"},"carrierName":{"description":"The carrier associated with the transaction.","type":"string","maxLength":20,"example":"Delta Air Lines"},"travelAgencyIataCode":{"description":"The IATA code associated with the travel agency.","type":"string","maxLength":20,"example":"10584410"},"travelAgencyName":{"description":"The business name of the travel agency.","type":"string","maxLength":30,"example":"A Travis Gent LLC"},"airlinePlanNumber":{"description":"The airline plan number associated with the transaction.","type":"string","maxLength":2,"example":"11"},"airlineInvoiceNumber":{"description":"The invoice number used by the airline.","type":"string","maxLength":6,"example":"664422"},"reservationSystem":{"description":"The reservation system used to create the ticket.","type":"string","enum":["START","TWA","DELTA","SABRE","COVIA_APOLLO","DR_BLANK","DER","TUI"],"example":"DELTA"},"restricted":{"description":"If the transaction is associated with a restricted class fare.","type":"boolean","example":true},"travelRoute":{"description":"Array containing up to 4 items that describe the route associated with the transaction.","type":"array","maxItems":4,"items":{"$ref":"#/components/schemas/AirlineTravelRoute"}},"relatedTicketNumber":{"description":"The number of any other tickets associated with the transaction ticket.","type":"string","maxLength":20,"example":"11223344556"},"ancillaryServiceCategory":{"description":"Identify the purchase of ancillary goods or services with a false value. If this element is not provided, the transaction is assumed to be a purchase of an airline ticket.","type":"array","items":{"$ref":"#/components/schemas/AirlineAncillaryServiceCategory"}},"ticketPurchase":{"description":"Identifies if the transaction is a ticket purchase.","type":"boolean","example":true}},"example":{"passengerName":"Jeff Yabuki","ticketNumber":"52300448","issuingCarrier":"Frontier Airlines","carrierName":"Delta Air Lines","travelAgencyIataCode":"10584410","travelAgencyName":"A Travis Gent LLC","airlinePlanNumber":"11","airlineInvoiceNumber":"664422","reservationSystem":"DELTA","restricted":true,"travelRoute":[{"departureDate":"2018-01-28","origin":"MIA","destination":"ATL","carrierCode":"DL","serviceClass":"J","stopoverType":"DIRECT","fareBasisCode":"F","departureTax":75,"flightNumber":"765599"}],"relatedTicketNumber":"11223344556","ancillaryServiceCategory":[{"serviceCategory":"BAGGAGE_FEE"},{"serviceCategory":"CARBON_OFFSET"}],"ticketPurchase":true}},"AirlineAncillaryServiceCategory":{"description":"Identify the purchase of ancillary goods or services with a false value. If this element is not provided, the transaction is assumed to be a purchase of an airline ticket.","type":"object","required":["serviceCategory"],"properties":{"serviceCategory":{"description":"Identifies the service purchased in the transaction if not a base ticket","type":"string","enum":["BUNDLED_SERVICE","BAGGAGE_FEE","CHANGE_FEE","CARGO","CARBON_OFFSET","FREQUENT_FLYER","GIFT_CARD","GROUND_TRANSPORT","IN_FLIGHT_ENTERTAINMENT","LOUNGE","MEDICAL","MEAL_BEVERAGE","OTHER","PASSENGER_ASSIST_FEE","PETS","SEAT_FEES","STANDBY","SERVICE_FEE","STORE","TRAVEL_SERVICE","UNACCOMPANIED_TRAVEL","UPGRADES","WI_FI"],"example":"BAGGAGE_FEE"}},"example":[{"serviceCategory":"BAGGAGE_FEE"},{"serviceCategory":"CARBON_OFFSET"}]},"AirlineTravelRoute":{"description":"Additional information about the route.","type":"object","properties":{"departureDate":{"type":"string","format":"date","description":"Date of departure.","example":"2018-01-28"},"origin":{"description":"The IATA code for the departure airport.","type":"string","maxLength":3,"example":"MIA"},"destination":{"description":"The IATA code for the destination. airport.","type":"string","maxLength":3,"example":"ATL"},"carrierCode":{"description":"The IATA code for the carrier.","type":"string","maxLength":2,"example":"DL"},"serviceClass":{"description":"The airline code for the service class of the ticket.","type":"string","maxLength":2,"example":"J"},"stopoverType":{"description":"Indicates whether the route is direct.","type":"string","enum":["DIRECT","STOPOVER"],"example":"DIRECT"},"fareBasisCode":{"description":"The airline fare basis code.","type":"string","maxLength":15,"example":"F"},"departureTax":{"description":"Fee charged by a country when a person leaves the country.","type":"number","maximum":999999999999,"example":75},"flightNumber":{"description":"The airline flight number associated with the ticket.","type":"string","maxLength":10,"example":"765599"}},"example":[{"departureDate":"2018-01-28","origin":"MIA","destination":"ATL","carrierCode":"DL","serviceClass":"J","stopoverType":"DIRECT","fareBasisCode":"F","departureTax":75,"flightNumber":"765599"}]},"Lodging":{"description":"Additional data specific to the lodging/hotel industry.","properties":{"arrivalDate":{"description":"Date of arrival.","type":"string","format":"date","example":"2010-05-15"},"departureDate":{"description":"Date of departure.","type":"string","format":"date","example":"2018-01-28"},"folioNumber":{"description":"Portfolio number.","type":"string","maxLength":20,"example":"12200054891"},"extraCharges":{"description":"Information about charges other than base lodging.","type":"array","items":{"$ref":"#/components/schemas/LodgingExtraCharges"},"example":[{"chargeItem":"MINI_BAR"},{"chargeItem":"OTHER"}]},"noShowIndicator":{"description":"Indicates if the transaction is associated with a delayed or no-show penalty.","type":"boolean","example":false}},"example":{"arrivalDate":"2010-05-15","departureDate":"2018-01-28","folioNumber":"12200054891","extraCharges":[{"chargeItem":"MINI_BAR"},{"chargeItem":"OTHER"}],"noShowIndicator":false}},"LodgingExtraCharges":{"description":"Information about charges other than base lodging.","type":"object","properties":{"chargeItem":{"type":"string","enum":["GIFT_SHOP","LAUNDRY","MINI_BAR","RESTAURANT","TELEPHONE","OTHER"],"example":"LAUNDRY"}}},"CarRental":{"description":"Additional data specific to the car rental industry.","properties":{"agreementNumber":{"description":"The car rental agreement number.","type":"string","maxLength":20,"example":"100001145699"},"renterName":{"description":"The name of the person renting the car.","type":"string","maxLength":20,"example":"Frank Bisignano"},"returnCity":{"description":"The city where the rental ends and the car is returned.","type":"string","maxLength":20,"example":"Atlanta"},"returnDate":{"description":"The date the car rental ends and the car is returned.","type":"string","format":"date","example":"2020-10-25"},"pickupDate":{"description":"The date the car rental begins.","type":"string","format":"date","example":"2020-10-15"},"rentalClassId":{"description":"The classification of the rental car.","type":"string","maxLength":6,"example":"ABCDEF"},"extraCharges":{"description":"Array containing information about charges other than the rental rate.","type":"array","items":{"$ref":"#/components/schemas/CarRentalExtraCharges"},"example":[{"chargeItem":"GAS"},{"chargeItem":"EXTRA_MILEAGE"}]},"noShowIndicator":{"description":"Indicates if the transaction is related to a no-show charge.","type":"boolean","example":false}},"example":{"agreementNumber":"100001145699","renterName":"Frank Bisignano","returnCity":"Atlanta","returnDate":"2020-10-25","pickupDate":"2020-10-15","rentalClassId":"ABCDEF","extraCharges":[{"chargeItem":"GAS"},{"chargeItem":"EXTRA_MILEAGE"}],"noShowIndicator":false}},"CarRentalExtraCharges":{"description":"Array containing information about charges other than the rental rate.","type":"object","properties":{"chargeItem":{"description":"Additional charge item.","type":"string","enum":["EXTRA_MILEAGE","GAS","LATE_RETURN","ONE_WAY_SERVICE_FEE","PARKING_VIOLATION"],"example":"GAS"}},"example":[{"chargeItem":"GAS"},{"chargeItem":"EXTRA_MILEAGE"}]},"Mcc6012":{"description":"The group MCC (Merchant Category Code) 6012","properties":{"dateOfBirth":{"description":"The date of birth of the cardholder (YYYYMMDD).","type":"string","maxLength":8,"example":"20200505"},"accountFirst6":{"description":"The first six digits of the primary account number.","type":"string","maxLength":6,"example":"411111"},"accountLast4":{"description":"The last four digits of the primary account number.","maxLength":4,"type":"string","example":"2343"},"accountNum":{"description":"The account number where the primary account number is not a card.","type":"string","maxLength":50,"example":"146789900034567"},"postCode":{"description":"The postal code of the cardholder.","type":"string","maxLength":50,"example":"30101"},"surname":{"description":"Surname or last name of the card holder.","type":"string","maxLength":100,"example":"Walker"}},"example":{"dateOfBirth":"20200505","accountFirst6":"411111","accountLast4":"2343","accountNum":"546789900034567","postCode":"30101","surname":"Walker"}},"InstallmentOptions":{"description":"Indicates that the total sum payable is divided for payment at successive fixed times.","properties":{"numberOfInstallments":{"description":"Number of instalments for a sale transaction if the customer pays the total amount in multiple transactions.","type":"integer","format":"int32","minimum":1,"maximum":99,"example":5},"installmentsInterest":{"description":"Indicates whether the installment interest amount has been applied.","type":"boolean","example":true},"installmentDelayMonths":{"description":"The number of months the first installment payment will be delayed.","type":"integer","format":"int32","minimum":1,"maximum":99,"example":5},"recurringType":{"description":"The type of recurring payment.","type":"string","enum":["FIRST","REPEAT","STANDING_INSTRUCTION"],"example":"FIRST"},"merchantAdviceCodeSupported":{"description":"Indicates if the merchant supports merchant advice code (MAC) in order to receive table 55 code for a declined recurring transaction.","type":"boolean","example":true}},"example":{"numberOfInstallments":5,"installmentsInterest":true,"installmentDelayMonths":5,"recurringType":"FIRST","merchantAdviceCodeSupported":true}},"RevolvingOptions":{"description":"Indicates the options for revolving payment.","properties":{"revolvingPayment":{"description":"Indicates whether the payment has been chosen as revolving type.","type":"boolean","example":true}}},"RecurringDetails":{"description":"Indicates the options for revolving payment.","properties":{"startDate":{"description":"PLACEHOLDER","type":"string","format":"date","example":"2022-08-25T00:00:00.000Z"},"frequency":{"$ref":"#/components/schemas/Frequency"},"numberOfPayments":{"description":"Indicates the amount of recurring payments left in the cycle.","type":"number","example":100},"maximumFailures":{"description":"Indicates how many times the payment can fail.","type":"number","example":1}}},"StandInDetails":{"description":"Indicates standin transaction.","required":["standInType","numberOfDebits","siValidated","maximumTransactionAmount","siHubId","frequency"],"properties":{"standInType":{"description":"Indicates standin instruction type.","type":"string","enum":["FIXED_AMOUNT","MAXIMUM_AMOUNT"],"example":"FIXED_AMOUNT"},"numberOfDebits":{"description":"Indicates number of standin instruction debits.Possible values can be two digit number or UN (Until it is cancelled) or ND (Not defined).","type":"string","pattern":"(UN)|(ND)|([0-9]{2})","example":"12"},"siValidated":{"description":"Indicates standin instruction validation flag, it can be true or false. \"false\" - Not validated, \"true\" - Validated.","type":"boolean","example":true},"maximumTransactionAmount":{"description":"Maximum debit amount per standin instruction transaction.","type":"number","example":1800},"siHubId":{"description":"Unique identifier for standin instruction.","type":"string","maxLength":10,"example":"Y3PCO6QGHT"},"frequency":{"description":"Indicates frequency of the standin instruction debit.","type":"string","enum":["DAILY","TWICEWEEKLY","WEEKLY","TENDAYS","FORTNIGHTLY","MONTHLY","EVERYTWOMONTHS","TRIMESTER","QUARTERLY","HALFYEARLY","YEARLY","UNSCHEDULED"],"example":"MONTHLY"}},"example":{"standInType":"FIXED_AMOUNT","numberOfDebits":"12","siValidated":true,"maximumTransactionAmount":1800,"siHubId":"Y3PCO6QGHT","frequency":"MONTHLY"}},"TokenCryptogram":{"description":"Network token cryptogram value.","type":"string","minLength":20,"maxLength":256,"example":"gfgF92JHDJFjxcJHCQ23IbI12D"},"PurchaseCards":{"description":"Purchase card details.","properties":{"Level2":{"description":"Level 2 data for monitoring and controlling corporate expenditures.","type":"object","properties":{"customerReferenceID":{"type":"string","description":"Customer code/customer reference ID. The max length supported for Visa is 12 and MasterCard is 17.","maxLength":17,"example":"abcdef123xyz"},"supplierInvoiceNumber":{"type":"string","description":"Purchase identifier/merchant-related data.","maxLength":30,"example":"0000000065348"},"supplierVATRegistrationNumber":{"description":"Merchant VAT registration/single business reference number/merchant tax ID or corporation VAT number.","type":"string","maxLength":30,"example":"10001174242"},"vatDocumentationIndicator":{"description":"VAT documentation indicator.","type":"string","enum":["1","2"],"example":"1"},"totalDiscountAmountAndRate":{"$ref":"#/components/schemas/AdditionalAmountRate"},"vatShippingAmountAndRate":{"$ref":"#/components/schemas/AdditionalAmountRate"},"dutyAmountAndRate":{"$ref":"#/components/schemas/AdditionalAmountRate"}},"example":{"customerReferenceID":"abcdef123xyz","supplierInvoiceNumber":"0000000065348","supplierVATRegistrationNumber":"10001174242","vatDocumentationIndicator":"1","totalDiscountAmountAndRate":{"amount":5.145,"rate":1.175},"vatShippingAmountAndRate":{"amount":6.03,"rate":1.175},"dutyAmountAndRate":{"amount":7.03,"rate":1.175}}},"Level3":{"description":"Level 3 data for monitoring and controlling corporate expenditures.","type":"object","required":["lineItems"],"properties":{"lineItems":{"description":"Line items of monitoring and controlling corporate expenditures data.","maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/PurchaseCardsLevel3LineItems"}}},"example":{"lineItems":[{"commodityCode":"ab12","productCode":"0001212120888","description":"Dinner and movie","quantity":5,"unitMeasure":"25","unitPrice":30.075,"vatAmountAndRate":{"amount":5.145,"rate":1.175},"discountAmountAndRate":{"amount":6.03,"rate":1.175},"lineItemTotal":39.075}]}}},"example":{"Level2":{"customerReferenceID":"abcdef123xyz","supplierInvoiceNumber":"0000000065348","supplierVATRegistrationNumber":"10001174242","vatDocumentationIndicator":"2","totalDiscountAmountAndRate":{"amount":5.145,"rate":1.175},"vatShippingAmountAndRate":{"amount":6.03,"rate":1.175},"dutyAmountAndRate":{"amount":7.03,"rate":1.175}},"Level3":{"lineItems":[{"commodityCode":"ab12","productCode":"0001212120888","description":"Dinner and movie","quantity":5,"unitMeasure":"25","unitPrice":30.075,"vatAmountAndRate":{"amount":5.145,"rate":1.175},"discountAmountAndRate":{"amount":6.03,"rate":1.175},"lineItemTotal":39.075}]}}},"PurchaseCardsLevel3LineItems":{"description":"Line items of monitoring and controlling corporate expenditures data.","type":"object","properties":{"commodityCode":{"description":"The commodity code used to classify the item purchased.","type":"string","maxLength":4,"example":"ab12"},"productCode":{"description":"Merchant product identifier/the Universal Product Code (UPC) of the item purchased.","type":"string","maxLength":20,"example":"0001212120888"},"description":{"description":"The description.","type":"string","maxLength":30,"example":"Dinner and movie"},"quantity":{"description":"The quantity.","type":"integer","minimum":1,"example":5},"unitMeasure":{"description":"The unit of measure.","type":"string","maxLength":3,"example":"25"},"unitPrice":{"description":"Rate amount in 3 decimal 12 bytes total digit.","type":"number","example":30.075},"vatAmountAndRate":{"$ref":"#/components/schemas/AdditionalAmountRate"},"discountAmountAndRate":{"$ref":"#/components/schemas/AdditionalAmountRate"},"lineItemTotal":{"description":"Rate amount in 3 decimal 12 bytes total digit.","type":"number","example":39.075}},"example":{"commodityCode":"ab12","productCode":"0001212120888","description":"Dinner and movie","quantity":5,"unitMeasure":"25","unitPrice":30.075,"vatAmountAndRate":{"amount":5.145,"rate":1.175},"discountAmountAndRate":{"amount":6.03,"rate":1.175},"lineItemTotal":39.075}},"AdditionalAmountRate":{"description":"Rate and corresponding amount being applied to purchase cards, for instance in the form of taxes, discounts, or duty.","required":["amount","rate"],"properties":{"amount":{"description":"Amount in 3 decimal 12 bytes total digit.","type":"number","example":5.145},"rate":{"description":"Rate in 3 decimal 12 bytes total digit.","type":"number","example":1.175}},"example":{"amount":5.145,"rate":1.175}},"Basket":{"description":"Indicates basket of items.","properties":{"productStock":{"description":"Product stock.","type":"string","enum":["check"],"example":"check"},"items":{"description":"The list of items included in the order.","type":"array","items":{"$ref":"#/components/schemas/BasketItem"}}}},"BasketItem":{"description":"Item details.","properties":{"id":{"description":"A unique ID associated with the product.","type":"string"},"description":{"description":"A name or short description of the product.","type":"string","example":"The Art of Computer Programming"},"subTotal":{"description":"Subtotal amount.","type":"number","example":8},"valueAddedTax":{"description":"Value added tax amount.","type":"number","example":0},"localTax":{"description":"Local tax amount.","type":"number","example":1},"deliveryAmount":{"description":"Delivery amount.","type":"number","example":1},"chargeTotal":{"description":"Charge Total amount.","type":"number","example":1},"currency":{"description":"The currency of the original transaction. Note: Only 'GBP' is supported.","type":"string","pattern":"([A-Z]{3})|([0-9]{3})","example":"GBP"},"quantity":{"description":"The unit in which the product is sold (e.g. litre, kilogram, etc). Leave empty if the product is sold as a complete unit.","type":"number","example":1},"unitPrice":{"description":"The unit price is number with  3 decimal precision.","type":"number","example":1.719},"category":{"description":"Category of the product.","type":"string"},"detailedCategory":{"description":"Detailed Category of the product.","type":"string"},"options":{"description":"Option details","type":"array","items":{"$ref":"#/components/schemas/Option"}}}},"Option":{"description":"Basket option.","properties":{"name":{"description":"name","type":"string"},"choice":{"description":"choice","type":"string"}}},"PaymentFacilitator":{"description":"Payment facilitator details provided by the merchant.","properties":{"externalMerchantId":{"type":"string","description":"External merchant ID of the payment facilitator.","pattern":"^(?!\\s*$).+","example":"151623999"},"paymentFacilitatorId":{"type":"string","description":"Payment facilitator ID supplied during boarding.","pattern":"[a-zA-Z0-9]{1,11}","example":"\"1234567890\"1"},"saleOrganizationId":{"type":"string","description":"Independent sales organization (ISO) ID provided by Mastercard.","pattern":"\\d{1,11}","example":"13579246801"},"name":{"type":"string","description":"Payment facilitator name.","maxLength":50,"pattern":"^(?!\\s*$).+","example":"First Reseller"},"subMerchantData":{"$ref":"#/components/schemas/SubMerchantData"}},"example":{"externalMerchantId":"12345","paymentFacilitatorId":"123123123","saleOrganizationId":"123124214","name":"First Reseller","subMerchantData":{"mcc":"1432","legalName":"First Merchant","timezone":"Europe/London","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"},"document":{"type":"NATIONAL_IDENTITY","number":"12345666544"},"merchantId":"12435325235","merchantVerificationValue":"001122"}}},"SubMerchantData":{"description":"Once sub-merchant element is given, the transaction is considered to be a sub-merchant transaction.","required":["mcc"],"properties":{"mcc":{"type":"string","description":"Merchant category code.","pattern":"[0-9]{4}","example":"7311"},"legalName":{"type":"string","description":"Store legal name.","maxLength":100,"example":"Walmart Inc."},"email":{"type":"string","description":"Sub-merchant email.","maxLength":254,"example":"abcd.1234@natwest.com"},"timezone":{"type":"string","description":"Timezone.","maxLength":500,"example":"Europe/London"},"address":{"$ref":"#/components/schemas/Address"},"document":{"$ref":"#/components/schemas/Document"},"merchantId":{"type":"string","description":"Sub-merchant ID.","maxLength":50,"example":"987654321"},"merchantVerificationValue":{"type":"string","description":"Visa Merchant Verification Value or MasterCard Assigned ID","maxLength":10,"example":"001122"}},"example":{"mcc":"7311","legalName":"Walmart Inc.","email":"abcd.1234@natwest.com","timezone":"Europe/London","address":{"address1":"123 Main St.","city":"Sandy Springs","region":"Georgia","postalCode":"30303","country":"USA"},"document":{"type":"NATIONAL_IDENTITY","number":"12345666544"},"merchantId":"987654321","merchantVerificationValue":"001122"}},"Document":{"description":"Document information.","required":["type","number"],"properties":{"type":{"type":"string","description":"Document type.","enum":["NATIONAL_IDENTITY","SINGLE_TAX_IDENTIFICATION","SINGLE_CODE_OF_LABOR_IDENTIFICATION","BOOK_ENLISTMENT","CIVIC_NOTEBOOK","PASSPORT"],"example":"NATIONAL_IDENTITY"},"number":{"type":"string","description":"Document number.","maxLength":30,"pattern":"^(?!\\s*$).+","example":"12345666544"}},"example":{"type":"NATIONAL_IDENTITY","number":"12345666544"}},"SoftDescriptor":{"description":"Identifying information about a merchant which appears on buyer's credit/debit card statements.","required":["dynamicMerchantName"],"properties":{"dynamicMerchantName":{"type":"string","description":"Store \"doing-business-as\" name.","pattern":"^(?!\\s*$).+","example":"Merchant XYZ"},"customerServiceNumber":{"type":"string","description":"Customer service phone number information that is passed to the issuer (it may appear on the cardholder’s statement) or if merchant wants to pass information that differs from the information stored on our master File.","maxLength":10,"pattern":"^[0-9]+$","example":"9973322990"},"mcc":{"description":"The 4-digit merchant category code (MCC). The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction.","type":"string","maxLength":4,"example":"7311"},"dynamicAddress":{"$ref":"#/components/schemas/Address"}},"example":{"dynamicMerchantName":"Merchant XYZ","customerServiceNumber":"8045018787","mcc":"7311","dynamicAddress":{"company":"XYZ Company","address1":"5565 Glenridge Conn","address2":"Dundwoody Area","city":"Atlanta","region":"Georgia","postalCode":"30342","country":"USA"}}},"Secure3DInitiateRequest":{"title":"Secure3DInitiateRequest","description":"The request to initiate 3DSecure for existing transaction.","required":["authenticationRequest"],"allOf":[{"$ref":"#/components/schemas/AuthenticationUpdateRequest"},{"type":"object","properties":{"authenticationRequest":{"$ref":"#/components/schemas/AuthenticationRequest"}}}],"example":{"authenticationType":"Secure3DInitiateRequest","authenticationRequest":{"authenticationType":"Secure3DAuthenticationRequest","termURL":"https://termurl-host/secure3d/return","methodNotificationURL":"https://notification-host/notify","challengeIndicator":"03"}}},"Secure3D10AuthenticationUpdateRequest":{"title":"Secure3D10AuthenticationUpdateRequest","description":"Authentication update request specific to 3DSecure 1.0 transactions. DEPRECATED - use Secure3DAuthenticationUpdateRequest instead","allOf":[{"$ref":"#/components/schemas/AuthenticationUpdateRequest"},{"type":"object","required":["payerAuthenticationResponse"],"properties":{"payerAuthenticationResponse":{"description":"A formatted message providing results of the issuer’s cardholder authentication.","type":"string","example":"eJzVWFm....9f/AhjgEcE="},"merchantData":{"description":"Formatted string encoding transaction time, order ID, and return URL data.","type":"string","example":"MD__________30002019....85bcd02599"},"securityCode":{"description":"Card security code if required by merchant.","type":"string","example":"123"},"tokenCryptogram":{"$ref":"#/components/schemas/TokenCryptogram"}}}],"example":{"authenticationType":"Secure3D10AuthenticationUpdateRequest","billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"},"payerAuthenticationResponse":"eJzVWFm....9f/AhjgEcE=","merchantData":"MD__________30002019....85bcd02599","securityCode":"123"},"deprecated":true},"Secure3D21AuthenticationUpdateRequest":{"title":"Secure3D21AuthenticationUpdateRequest","description":"Authentication update request specific to 3DSecure 2.x transactions. DEPRECATED - use Secure3DAuthenticationUpdateRequest instead","allOf":[{"$ref":"#/components/schemas/AuthenticationUpdateRequest"},{"type":"object","properties":{"methodNotificationStatus":{"description":"Indicates how the merchant received the 3DS method.","type":"string","enum":["RECEIVED","EXPECTED_BUT_NOT_RECEIVED","NOT_EXPECTED"],"example":"RECEIVED"},"acsResponse":{"$ref":"#/components/schemas/ACSResponse"},"securityCode":{"description":"Card security code if required by merchant.","type":"string","example":"123"},"tokenCryptogram":{"$ref":"#/components/schemas/TokenCryptogram"},"additionalStep":{"description":"Indicates any additional step that may be needed to complete 3ds authentication.","type":"string","enum":["COMPLETE_DECOUPLED_AUTHENTICATION"],"example":"COMPLETE_DECOUPLED_AUTHENTICATION"}}}],"example":{"authenticationType":"Secure3D21AuthenticationUpdateRequest","methodNotificationStatus":"RECEIVED"},"deprecated":true},"Secure3DAuthenticationUpdateRequest":{"title":"Secure3DAuthenticationUpdateRequest","description":"Authentication update request specific to 3DSecure 2.x transactions.","allOf":[{"$ref":"#/components/schemas/AuthenticationUpdateRequest"},{"type":"object","properties":{"methodNotificationStatus":{"description":"Indicates how the merchant received the 3DS method.","type":"string","enum":["RECEIVED","EXPECTED_BUT_NOT_RECEIVED","NOT_EXPECTED"],"example":"RECEIVED"},"acsResponse":{"$ref":"#/components/schemas/ACSResponse"},"securityCode":{"description":"Card security code if required by merchant.","type":"string","example":"123"},"tokenCryptogram":{"$ref":"#/components/schemas/TokenCryptogram"},"additionalStep":{"description":"Indicates any additional step that may be needed to complete 3ds authentication.","type":"string","enum":["COMPLETE_DECOUPLED_AUTHENTICATION"],"example":"COMPLETE_DECOUPLED_AUTHENTICATION"}}}],"example":{"authenticationType":"Secure3DAuthenticationUpdateRequest","methodNotificationStatus":"RECEIVED"}},"ACSResponse":{"description":"Encapsulates response data from the ACS.","type":"object","properties":{"cRes":{"description":"The ACS response to the CReq message. It can indicate the result of cardholder authentication or, in the case of an app-based model, also signal that further cardholder interaction is required to complete the authentication.","type":"string","example":"ewogICAiYWNzUmVmZXJlbmNlTnVtYmVyIiA6ICJBQ1NFbXUyIiwKICAgImFjc1RyYW5zSUQiIDogIjAwMDAwMDAwLTAwMDUtNWE1YS04MDAwLTAxNmZhNTU2MzgzMiIsCiAgICJtZXNzYWdlVHlwZSIgOiAiQ1JlcyIsCiAgICJtZXNzYWdlVmVyc2lvbiIgOiAiMi4xLjAiLAogICAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogImRlZjlmYmQ4LWY5MzUtNWM3Mi04MDAwLTAwMDAwMDA4MjllZCIsCiAgICJ0cmFuc1N0YXR1cyIgOiAiWSIKfQ","x-extra-annotation":"@com.fasterxml.jackson.annotation.JsonAlias({\"cres\"})"}},"example":{"cRes":"ewogICAiYWNzUmVmZXJlbmNlTnVtYmVyIiA6ICJBQ1NFbXUyIiwKICAgImFjc1RyYW5zSUQiIDogIjAwMDAwMDAwLTAwMDUtNWE1YS04MDAwLTAxNmZhNTU2MzgzMiIsCiAgICJtZXNzYWdlVHlwZSIgOiAiQ1JlcyIsCiAgICJtZXNzYWdlVmVyc2lvbiIgOiAiMi4xLjAiLAogICAidGhyZWVEU1NlcnZlclRyYW5zSUQiIDogImRlZjlmYmQ4LWY5MzUtNWM3Mi04MDAwLTAwMDAwMDA4MjllZCIsCiAgICJ0cmFuc1N0YXR1cyIgOiAiWSIKfQ"}},"AuthenticationUpdateRequest":{"description":"Provides shared fields for all AuthenticationUpdateRequest types. Abstract class, do not use this class directly, use one of its children.","required":["authenticationType"],"discriminator":{"propertyName":"authenticationType"},"properties":{"storeId":{"description":"An optional Outlet ID for clients that support multiple stores in the same developer app.","type":"string","maxLength":20,"example":"12345500000"},"authenticationType":{"description":"Object name of the authentication update request.","type":"string","example":"Secure3DAuthenticationUpdateRequest"},"billingAddress":{"$ref":"#/components/schemas/Address"}},"example":{"authenticationType":"Secure3DAuthenticationUpdateRequest","billingAddress":{"address1":"5565 Glenridge Conn","city":"Atlanta","postalCode":"30342","country":"USA"},"securityCode":123,"merchantData":"MD123...sdfk","payerAuthenticationResponse":"c7fb83b8a...73t4a827t4af8738a"}},"Secure3dResponse":{"description":"Contains 3DSecure response code.","properties":{"responseCode3dSecure":{"description":"Code received after successful payer-auth verification.","type":"string","example":"3"},"authenticationValue":{"description":"Secure 3D Authentication Value.","type":"string","example":"AAAAAAAAAAAAAAAAAAAAAAAAAAA="},"cardholderInfo":{"description":"The cardholder's information supplied by the ACS.","type":"string","example":"molestie nunc non blandit massa","maxLength":128},"otpVerificationResponse":{"$ref":"#/components/schemas/OtpVerificationResponse"}},"example":{"responseCode3dSecure":"3"}},"StandinResponseDetails":{"description":"Contains Standin response details.","properties":{"secure3DEnrolmentStatus":{"description":"Secure 3D Enrolment Status.","type":"string","example":"Y"},"secure3DECI":{"description":"Secure 3D ECI.","type":"string","example":"05"},"secure3DAuthenticationResponse":{"description":"Secure 3D Authentication Response.","type":"string","example":"Y"},"authenticationValue":{"description":"Secure 3D Authentication Value.","type":"string","example":"AAABBgFWUQAAAAEzZ1ZRAAAAAAA="},"xid":{"description":"Secure 3D XID.","type":"string","example":"cb8QZ9mmkTUqreE89RjjjAtpJpg"},"authenticationAlgorithm":{"description":"Secure 3D Authentication Algorithm.","type":"string","example":"2"}},"example":{"secure3DEnrolmentStatus":"Y","secure3DECI":"05","secure3DAuthenticationResponse":"Y","authenticationValue":"AAABBgFWUQAAAAEzZ1ZRAAAAAAA=","xID":"cb8QZ9mmkTUqreE89RjjjAtpJpg","authenticationAlgorithm":"2"}},"CardInfoLookupRequest":{"description":"Request to look up card-related information such as issuer country, card function and card brand. Only one payment card data is accepted for processing transaction either PaymantCard or PaymentCardEncrypted","properties":{"storeId":{"description":"An optional outlet id for clients that support multiple stores in the same developer app.","type":"string","maxLength":20,"example":"12345500000"},"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"}},"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"paymentCard":{"number":"4149011500000147"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"}}},"AccountInfoLookupRequest":{"description":"Request to look up card-related information such as issuer country, card function and card brand associated with a payment card or payment token. Abstract class, do not use this class directly, use one of its children.","type":"object","required":["requestType"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the account verification request.","type":"string","example":"PaymentCardInfoLookupRequest"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"}},"example":{"requestType":"PaymentCardInfoLookupRequest","paymentCard":{"number":"4149011500000147"}}},"PaymentCardInfoLookupRequest":{"title":"PaymentCardInfoLookupRequest","description":"Used to request information associated with a payment card. Only one payment card data is accepted for processing transaction either PaymantCard or PaymentCardEncrypted","allOf":[{"$ref":"#/components/schemas/AccountInfoLookupRequest"},{"type":"object","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"}}}],"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"requestType":"PaymentCardInfoLookupRequest","paymentCard":{"number":"4149011500000147"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"}}},"PaymentTokenInfoLookupRequest":{"title":"PaymentTokenInfoLookupRequest","description":"Used to request card information associated with a payment token.","allOf":[{"$ref":"#/components/schemas/AccountInfoLookupRequest"},{"type":"object","required":["paymentToken"],"properties":{"paymentToken":{"$ref":"#/components/schemas/UsePaymentToken"}},"example":{"requestType":"PaymentTokenInfoLookupRequest","paymentToken":{"value":"4149011500000147"}}}]},"CardInfoLookupResponse":{"description":"Response from card info lookup request.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"cardDetails":{"description":"One or more card information retrieved based on BIN.","type":"array","items":{"$ref":"#/components/schemas/CardInfo"},"example":[{"brand":"VISA","brandProductId":"VISA BUSINESS","cardFunction":"CREDIT","commercialCard":"CORPORATE","issuerCountry":"DE","issuerName":"First National Bank of Omaha"}]},"requestStatus":{"type":"string","enum":["SUCCESS","LIST_EMPTY"],"description":"Request status.","example":"SUCCESS"}}}],"example":{"cardDetails":[{"brand":"VISA","brandProductId":"VISA BUSINESS","cardFunction":"CREDIT","commercialCard":"CORPORATE","issuerCountry":"DE","issuerName":"First National Bank of Omaha"}],"requestStatus":"SUCCESS"}},"CardInfo":{"description":"Card information.","properties":{"brand":{"type":"string","description":"The card brand.","example":"VISA"},"brandProductId":{"type":"string","description":"The product ID of the brand.","example":"VISA BUSINESS"},"cardFunction":{"$ref":"#/components/schemas/CardFunction"},"commercialCard":{"type":"string","enum":["CORPORATE","NON_CORPORATE"],"description":"Indicates whether it is a corporate or non-corporate card.","example":"CORPORATE"},"issuerCountry":{"type":"string","description":"The country of the issuer.","example":"DE"},"issuerName":{"type":"string","description":"The name of the issuer.","example":"First National Bank of Omaha"}},"example":{"brand":"VISA","brandProductId":"VISA BUSINESS","cardFunction":"CREDIT","commercialCard":"CORPORATE","issuerCountry":"DE","issuerName":"First National Bank of Omaha"}},"PaymentDevice":{"description":"Information from the payment device including the blob data and its mode of entry.","required":["deviceType","data"],"properties":{"deviceType":{"type":"string","description":"The data format.","enum":["SWIPE"],"example":"SWIPE"},"data":{"type":"string","description":"Data from device containing, at a minimum, a transaction-unique key serial number (KSN) and track 2 card data.","pattern":"^(?!\\s*$).+","example":"02A600C0170018008292;5424********1732=1810?*B73CD8C26233D4FFEC5500ED394439D97DDA5F530942D21D0000000000000000000000000000000000000000363434543035353734326299492410027300000260DC03"},"securityCode":{"description":"Card verification value/number.","type":"string","minLength":3,"maxLength":4,"example":"977"},"cardholderName":{"type":"string","description":"Name of cardholder."},"cardFunction":{"$ref":"#/components/schemas/CardFunction"},"brand":{"type":"string","description":"The card brand.","example":"VISA"}},"example":{"deviceType":"SWIPE","data":"02A600C0170018008292;5424********1732=1810?*B73CD8C26233D4FFEC5500ED394439D97DDA5F530942D21D0000000000000000000000000000000000000000363434543035353734326299492410027300000260DC03","securityCode":"977"}},"IdInfo":{"description":"Identification information.","properties":{"idType":{"description":"Identification type.","type":"string","maxLength":2,"example":"DL"},"idData":{"description":"Identification data.","type":"string","minLength":1,"maxLength":35,"example":"12345678"}},"example":{"idType":"DL","idData":"12345678"}},"PaymentBrandResponse":{"description":"List of available brands of a store.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"brands":{"type":"array","items":{"description":"This field contains the brand ID.","type":"string"}}}}],"example":{"clientRequestId":"30dd879c-ee2f-11db-8314-0800200c9a66","apiTraceId":"rrt-0bd552c12342d3448-b-ea-1142-12938318-7","brands":["MASTERCARD","VISA","MAESTRO"]}},"AvailableCurrenciesResponse":{"description":"List of available currencies for a store.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/StoreCurrency"}}}}],"example":{"clientRequestId":"30dd879c-ee2f-11db-8314-0800200c9a66","apiTraceId":"rrt-0bd552c12342d3448-b-ea-1142-12938318-7","currencies":[{"literalCurrencyCode":"GBP","numericCurrencyCode":840,"decimalPlaces":2,"defaultCurrency":true},{"literalCurrencyCode":"GBP","numericCurrencyCode":978,"decimalPlaces":2,"defaultCurrency":false}]}},"AvailableIsoCountriesResponse":{"description":"Full list of available ISO countries.","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"defaultCountry":{"$ref":"#/components/schemas/StoreCountry"},"countries":{"type":"array","items":{"$ref":"#/components/schemas/StoreCountry"}}}}],"example":{"clientRequestId":"30dd879c-ee2f-11db-8314-0800200c9a66","apiTraceId":"rrt-0bd552c12342d3448-b-ea-1142-12938318-7","defaultStoreCountry":{"iso31661Alpha2":"US","iso31661Alpha3":"USA","iso31661Numeric":"840","defaultCountry":true},"countries":[{"iso31661Alpha2":"US","iso31661Alpha3":"USA","iso31661Numeric":"840","defaultCountry":true},{"iso31661Alpha2":"DM","iso31661Alpha3":"DMA","iso31661Numeric":"212","defaultCountry":false}]}},"ManagedRedirectTransactionType":{"description":"Type of transaction to perform with ManagedRedirectPrimaryRequest. Primary transaction types in requests include 'SALE', 'PREAUTH', 'PAYER_AUTH'.","type":"string","enum":["SALE","PREAUTH","PAYER_AUTH"],"example":"SALE"},"RedirectAttributes":{"description":"Attributes for controlling transactions with additional parameters like dccFlow, '3ds' flows.","type":"object","properties":{"challengeIndicator":{"description":"Indicates whether or not a challenge should be performed. 01 = No preference (You have no preference whether a challenge should be performed. This is the default value) 02 = No challenge requested (You prefer that no challenge should be performed) 03 = Challenge requested: 3DS Requestor Preference (You prefer that a challenge should be performed) 04 = Challenge requested: Mandate (There are local or regional mandates that mean that a challenge must be performed)\n","type":"string","enum":["01","02","03","04"],"default":"01","example":"01"},"authenticateTransaction":{"description":"If 3D secure should be applied.","type":"boolean","example":true},"threeDSEmvCoMessageCategory":{"description":"EmvCo Messag Category","type":"string","enum":["01","02","80"],"example":"01"},"browserJavaScriptEnabled":{"description":"Browser Java Script Enabled flag","type":"boolean","default":false},"browserJavaEnabled":{"type":"boolean","default":false,"description":"Boolean that represents the ability of the cardholder browser to execute Java (required for 2.1, mandatory for 2.2 when browserjavaScriptEnabled=true)> ATTENTION - it is stronly recommended to be set (but optional at the moment for backward compatibility)"},"override3dsCountryExclusion":{"description":"Override 3ds Country Exclusion flag","type":"boolean","default":false},"threeDSTransactionType":{"description":"Secure 3D Transaction Type","type":"string","enum":["01","03","10","11","28"],"example":"01"},"skipTRA":{"$ref":"#/components/schemas/SkipTRA"},"fullBypass":{"description":"Full by pass flag","type":"boolean","default":false},"mobileMode":{"description":"Mobile mode flag","type":"boolean","default":false},"paymentMode":{"description":"Payment Mode","type":"string","enum":["FULLPAY","PAYONLY","PAYPLUS"],"example":"FULLPAY"},"language":{"description":"Language used by client.","type":"string","pattern":"^(?!\\s*$).+","example":"en"}}},"SkipTRA":{"description":"skip TRA exemption for the transaction","type":"boolean","default":false},"ManagedRedirectPrimaryRequest":{"description":"Request to generate an embedded payment link for Managed redirect.","type":"object","required":["requestType","transactionAmount"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the primary transaction request.","type":"string","example":"PaymentCardManagedRedirectRequest"},"transactionAmount":{"$ref":"#/components/schemas/Amount"},"storeId":{"description":"An optional Outlet ID for clients that support multiple stores in the same developer app.","type":"string","maxLength":20,"example":"12345500000"},"merchantTransactionId":{"description":"The unique merchant transaction ID from the request, if supplied.","type":"string","maxLength":40,"example":"lsk23532djljff3"},"transactionType":{"$ref":"#/components/schemas/ManagedRedirectTransactionType"},"order":{"$ref":"#/components/schemas/Order"},"redirectAttributes":{"$ref":"#/components/schemas/RedirectAttributes"},"parentUri":{"type":"string","format":"uri","description":"To embed IPG hosted payment pages inside an iFrame this parameter is used (maximum length  2048 characters) to specify an URL of a page.","example":"https://www.acme.com"}}},"PaymentCardManagedRedirectRequest":{"description":"Request to create Managed Redirect sale transaction using payment card.","allOf":[{"$ref":"#/components/schemas/ManagedRedirectPrimaryRequest"},{"type":"object","properties":{"paymentMethod":{"$ref":"#/components/schemas/PaymentCardPaymentMethod"}}}]},"GenericManagedRedirectRequest":{"description":"Request to create Managed Redirect sale transaction using payment card.","allOf":[{"$ref":"#/components/schemas/ManagedRedirectPrimaryRequest"},{"type":"object","properties":{"paymentMethod":{}}}]},"ManagedRedirectResponse":{"description":"Response for Managed redirect transaction request","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"requestStatus":{"description":"The status of the request.","type":"string","enum":["SUCCESS","VALIDATION_FAILED","PROCESSING_FAILED","FAILURE"],"example":"SUCCESS"},"orderId":{"description":"Note - Client Order ID if supplied by client. If not supplied by client, the gateway will generate. The first 12 alphanumeric digits are passed down to the reporting tool, Clientline and Data File Manager (DFM).","type":"string","example":"123456"},"redirectURL":{"description":"URL for embedded payment link.","type":"string","example":"https://api.firstdata.com/connect/gateway/processing?storename=123456789&oid=R-96cdbaa4-c22e-4598-a2f1-c2b5fed79ef1&redirectRequestId=d3eb74fe-cf63-47e1-b89f-52ba0cc7965c"},"transactionId":{"type":"string","description":"ID code from the transaction.","example":"123978432"}}}]},"OtpVerificationResponse":{"description":"Contains Rupay OTP verification response.","properties":{"otpValidityInMinutes":{"description":"OTP Validity in minutes.","type":"integer","example":"5"},"responseCode":{"description":"Code received from Rupay after OTP verification","type":"string","example":"ACU00"},"responseDescription":{"description":"Description of the error code.","type":"string","example":"Authenticated"}}},"GetEligibleInstallmentPaymentRequest":{"description":"Used to get Eligible Installment Plans.","type":"object","required":["storeId","amount","requestType"],"discriminator":{"propertyName":"requestType"},"properties":{"requestType":{"description":"Object name of the PaymentCard Request.","type":"string","maxLength":50,"example":"PaymentCardRequest"},"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"},"amount":{"$ref":"#/components/schemas/Amount"}}},"GetEligibleInstallmentPaymentRequestGroup":{"x-hide-model":true,"type":"object","oneOf":[{"$ref":"#/components/schemas/PaymentCardInstallmentEligibilityRequest"},{"$ref":"#/components/schemas/PaymentTokenInstallmentEligibilityRequest"},{"$ref":"#/components/schemas/PaymentCardProtectedInstallmentEligibilityRequest"}],"discriminator":{"propertyName":"requestType","mapping":{"PaymentCardInstallmentEligibilityRequest":"#/components/schemas/PaymentCardInstallmentEligibilityRequest","PaymentTokenInstallmentEligibilityRequest":"#/components/schemas/PaymentTokenInstallmentEligibilityRequest","PaymentCardProtectedInstallmentEligibilityRequest":"#/components/schemas/PaymentCardProtectedInstallmentEligibilityRequest"}}},"PaymentCardInstallmentEligibilityRequest":{"title":"PaymentCardInstallmentEligibilityRequest","description":"Used to request a payment card.","allOf":[{"$ref":"#/components/schemas/GetEligibleInstallmentPaymentRequest"},{"type":"object","properties":{"paymentCard":{"$ref":"#/components/schemas/PaymentCard"},"paymentCardEncrypted":{"$ref":"#/components/schemas/PaymentCardEncrypted"}}}],"x-constraints":{"paymentCardValidation":"@PaymentData"},"example":{"requestType":"PaymentCardInstallmentEligibilityRequest","paymentCard":{"number":"4035874000424977"},"paymentCardEncrypted":{"encryptionType":"JWE","encryptedData":"eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.WlOGAYWRcmpPsaKRQI5IEsWpLT4C1jCa59QfJhJsXw7wvlIXCMAFBa5IWwqsUzKBO85uTGZGcMCoKV6CMnqBTcfoceDaoBWDotmWBIl4nLiky97kc0gnM2FMbLlDzI6r9CVLlsINBz7ziTuyiDX-4B64Ux9z7fE_kvcN0iJ3alwDQKfa1fotX8b-HHjovclDMC53EZHDUtynQNQboqyUnUpy1VDXzyksBxAD9M8ubPdNCBXQR0TMchg2700X8zRmw7uz0Rlo16z56R7khCpL3j8pbo87rMKzAB6poWLyCBiC0it8Rkx8o3eJRJl3S_6l6mEtF0rwX9jNh21EpJk28w","keyId":"20240807-card-enc"}}},"PaymentTokenInstallmentEligibilityRequest":{"title":"PaymentTokenInstallmentEligibilityRequest","description":"Used to request a payment token.","allOf":[{"$ref":"#/components/schemas/GetEligibleInstallmentPaymentRequest"},{"type":"object","required":["paymentToken"],"properties":{"paymentToken":{"$ref":"#/components/schemas/UsePaymentToken"}},"example":{"requestType":"PaymentTokenInstallmentEligibilityRequest","paymentToken":{"value":"1235325235236"}}}]},"PaymentCardProtectedInstallmentEligibilityRequest":{"description":"This object encapsulates sensitive card data in an encrypted format, ensuring that it's protected during transmission and storage.\n","allOf":[{"$ref":"#/components/schemas/GetEligibleInstallmentPaymentRequest"},{"type":"object","properties":{"encryptedData":{"type":"string","description":"This field holds the encrypted information from the card, such as track1/2/3, card number, expiry date, card code, and/or the name of the cardholder. The data is encrypted and then transformed into a Base64-encoded string. Specifically, the plaintext card data is converted into a UTF-8 JSON block, padded according to the Padded80 standard, and then encrypted. The resultant encrypted data is encoded using Base64. The formula for this transformation is: base64(encrypt(Padded80(UTF-8(json-block.plainCardData)))).\n"}}}]},"GetEligibleInstallmentPlansResponse":{"description":"Response for Get Eligible Installment Plans Request","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"installmentPlans":{"type":"array","items":{"$ref":"#/components/schemas/InstallmentPlan"}}}}]},"InstallmentPlan":{"description":"Installment Plan Model","properties":{"installmentPlanId":{"description":"Installment Plan Id","type":"string","maxLength":36,"example":"1200001"},"installmentPlanInquiryId":{"description":"Installment Plan Inquiry Id","type":"integer","format":"int64","example":1200002},"islamicPlan":{"description":"Indicates if the plan is Islamic","type":"boolean","example":true},"installmentPlanIdReference":{"description":"Installment Plan Id Reference","type":"string","maxLength":36,"example":"1200003"},"provider":{"description":"Provider","type":"string","maxLength":60,"example":"VIS"},"tenure":{"description":"Tenure","type":"integer","format":"int32","minimum":1,"example":5},"installmentFrequency":{"description":"Installment Frequency","type":"string","maxLength":9,"example":"MONTHLY"},"interestRate":{"description":"InterestRate","type":"number","example":1.175},"currency":{"description":"ISO 4217 currency code.","type":"string","pattern":"([A-Z]{3})|([0-9]{3})","example":"GBP"},"interestAmount":{"description":"Interest Amount","type":"number","minimum":0,"example":10.24},"installmentFee":{"description":"Installment Fee","type":"number","minimum":0,"example":10.24},"totalFee":{"description":"Total Fee","type":"number","minimum":0,"example":10.24},"amountPerInstallment":{"description":"Amount Per Installment","type":"number","minimum":0,"example":10.24},"totalAmount":{"description":"Total Amount","type":"number","minimum":0,"example":10.24},"termsAndConditionText":{"description":"Terms And Condition Text","type":"string","maxLength":2048,"example":"I Agree"},"termsAndConditionVersion":{"description":"Terms And Condition Version","type":"string","maxLength":20,"example":"2"},"additionalTermsAndConditionsURL":{"description":"Additional Terms And Condition url","type":"string","maxLength":1024,"example":"https://visa.com"},"productCode":{"description":"Product Code","type":"string","maxLength":20,"example":"PROD1"},"programCode":{"description":"Program Code","type":"string","maxLength":20,"example":"PROG1"},"languageCode":{"description":"Language Code","type":"string","maxLength":20,"example":"ES"},"bankName":{"description":"Bank Name","type":"string","maxLength":50,"example":"SCB Bank"},"bankCode":{"description":"Bank Code","type":"string","maxLength":20,"example":"SCB01"},"installmentMerchantId":{"description":"MID for Installment tenure","type":"string","maxLength":15,"example":"4558458845656"},"installmentTerminalId":{"description":"TID for Installment tenure","type":"string","maxLength":16,"example":"48895212541"}}},"GetGuestCheckoutTokenCryptogramRequest":{"description":"Used to generate Guest checkout tokens. Abstract class, do not use this class directly, use one of its children.","required":["storeId","paymentMethod","transactionAmount"],"properties":{"storeId":{"description":"An optional outlet ID for clients that support multiple stores in the same app.","type":"string","maxLength":20,"example":"12345500000"},"paymentMethod":{"$ref":"#/components/schemas/PaymentCardPaymentMethod"},"transactionAmount":{"$ref":"#/components/schemas/Amount"}},"example":{"storeId":"12345500000","paymentCard":{"number":"4012000033330026","expiryDate":{"month":"12","year":"24"}},"transactionAmount":{"total":12.04,"currency":"GBP"}}},"GetGuestCheckoutTokenCryptogramResponse":{"description":"Response for Guest Checkout Token Cryptogram Request","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"requestStatus":{"description":"The status of the request.","type":"string","enum":["FAILED","SUCCESS"],"example":"SUCCESS"},"requestTime":{"description":"Time of the request.","type":"integer","format":"int64","example":1554308829345},"guestCheckoutToken":{"$ref":"#/components/schemas/GuestCheckoutToken"}}}]},"GuestCheckoutToken":{"description":"Guest Checkout Token Model","required":["value","expiryMonth","expiryYear"],"properties":{"value":{"description":"Token value","type":"string","pattern":"[0-9]{13,19}","example":"2343446334644554"},"expiryMonth":{"description":"Month of the token expiration date in MM format.","type":"string","pattern":"^(0[1-9]|1[012])$","example":"03"},"expiryYear":{"description":"Year of the card expiration date in YY format.","type":"string","pattern":"^([0-9]{2})$","example":"24"},"cardLast4":{"description":"Last four digits of Card number.","maxLength":4,"type":"string","example":"1234"},"brand":{"description":"Card brand.","type":"string","enum":["AMEX","MAESTRO","MASTERCARD","VISA"],"example":"VISA"},"guestCheckoutcryptogram":{"description":"Cryptogram value.","maxLength":256,"type":"string","example":"AgAAAAADo8FZTI0AmJbMgyUAAAA="}}},"GetNetworkTokenCryptogramRequest":{"description":"Get Cryptogram with token id.","type":"object","required":["storeId"],"properties":{"storeId":{"description":"An Outlet ID for clients.","type":"string","maxLength":20,"example":"12345500000"}}},"GetNetworkTokenCryptogramResponse":{"description":"Response for Get Network Token Cryptogram Request","allOf":[{"$ref":"#/components/schemas/BasicResponse"},{"properties":{"requestStatus":{"description":"The status of the request.","type":"string","enum":["FAILED","SUCCESS"],"example":"SUCCESS"},"requestTime":{"description":"Time of the request.","type":"integer","format":"int64","example":1554308829345},"networkToken":{"$ref":"#/components/schemas/NetworkToken"}}}]},"StoreCurrency":{"description":"Currency details associated with a store.","type":"object","properties":{"literalCurrencyCode":{"description":"This field contains the ISO alpha currency code.","type":"string","example":"GBP"},"numericCurrencyCode":{"description":"This field contains the ISO numeric currecy code.","type":"string","example":"840"},"decimalPlaces":{"description":"This field indicates the number of decimal places required for this currency.","type":"integer","format":"int32","example":2},"defaultCurrency":{"description":"This field indicates if this currency is the default currency for queried store.","type":"boolean","example":true}},"example":{"literalCurrencyCode":"GBP","numericCurrencyCode":"840","decimalPlaces":2,"defaultCurrency":true}},"StoreCountry":{"description":"Country details associated with a store.","type":"object","properties":{"iso31661Alpha2":{"$ref":"#/components/schemas/iso31661Alpha2Codes"},"iso31661Alpha3":{"$ref":"#/components/schemas/iso31661Alpha3Codes"},"iso31661Numeric":{"$ref":"#/components/schemas/iso31661NumericCodes"},"defaultCountry":{"description":"This field indicates if this country is the default country for queried store.","type":"boolean","example":true}},"example":{"iso31661Alpha2":"US","iso31661Alpha3":"USA","iso31661Numeric":"840","defaultCountry":true}},"iso31661Alpha2Codes":{"description":"This field contains the two letter ISO alpha country code.","type":"string","enum":["AX","BQ","CW","GH","GI","GN","GP","GM","GW","GQ","GR","GD","GL","GT","GG","GF","GU","GY","HK","HM","HN","HR","HT","HU","ID","IN","IO","IE","IR","IQ","IS","IM","IL","IT","JM","JE","JO","JP","KZ","KE","KG","KH","KI","KN","KR","KW","LA","LB","LR","LY","LC","LI","LK","LS","LT","LU","LV","MO","MA","MC","MD","MG","MV","MX","MH","MK","ML","MT","MM","ME","MN","MP","MZ","MR","MS","MQ","MU","MW","MY","YT","NA","NC","NE","NF","NG","NI","NU","NL","NO","NP","NR","NZ","OM","PK","PA","PN","PE","PH","PW","PG","PL","PR","KP","PT","PY","PS","PF","QA","RE","RU","RW","BL","MF","SA","SD","SN","SG","GS","SH","SJ","SB","SL","SV","SM","SO","PM","RS","ST","SR","SK","SI","SE","SZ","SC","SY","TC","TD","TG","TH","TJ","TK","TM","TL","TO","TT","TN","TR","TV","TW","TZ","UG","UA","UM","UY","US","UZ","VA","VC","VE","VG","AW","AF","AO","AI","AL","AD","AN","AE","AR","AM","AS","AQ","AG","AU","AT","AZ","BI","BE","BJ","BF","BD","BG","BH","BS","BA","BY","BZ","BM","BO","BR","BB","BN","BT","BV","BW","CF","CA","CC","CH","CL","CN","CI","CM","CG","CK","CO","KM","CV","CR","CU","CX","KY","CY","CZ","DE","DJ","DM","DK","DO","DZ","EC","EG","ER","ES","EE","ET","FI","FJ","FK","FR","FX","FO","FM","GA","GB","GE","VI","VN","VU","WF","WS","YE","ZA","CD","ZM","ZW","RO","CS","SS","EH","FQ","SX","QZ","XK"],"example":"US"},"iso31661Alpha3Codes":{"description":"This field contains the three letter ISO alpha country code.","type":"string","enum":["ALA","BES","CUW","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GGY","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IND","IOT","IRL","IRN","IRQ","ISL","IMN","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MOZ","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","RUS","RWA","BLM","MAF","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","STP","SUR","SVK","SVN","SWE","SWZ","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","URY","USA","UZB","VAT","VCT","VEN","VGB","ABW","AFG","AGO","AIA","ALB","AND","ANT","ARE","ARG","ARM","ASM","ATA","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BFA","BGD","BGR","BHR","BHS","BIH","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COG","COK","COL","COM","CPV","CRI","CUB","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESP","EST","ETH","FIN","FJI","FLK","FRA","FXX","FRO","FSM","GAB","GBR","GEO","VIR","VNM","VUT","WLF","WSM","YEM","ZAF","COD","ZMB","ZWE","ROU","SCG","SSD","ESH","ATF","SXM","QZZ","XKX"],"example":"USA"},"iso31661NumericCodes":{"description":"This field contains the three letter ISO numeric country code.","type":"string","enum":["248","535","531","288","292","324","312","270","624","226","300","308","304","320","831","254","316","328","344","334","340","191","332","348","360","356","086","372","364","368","352","833","376","380","388","832","400","392","398","404","417","116","296","659","410","414","418","422","430","434","662","438","144","426","440","442","428","446","504","492","498","450","462","484","584","807","466","470","104","499","496","580","508","478","500","474","480","454","458","175","516","540","562","574","566","558","570","528","578","524","520","554","512","586","591","612","604","608","585","598","616","630","408","620","600","275","258","634","638","643","646","652","663","682","736","686","702","239","654","744","090","694","222","674","706","666","688","678","740","703","705","752","748","690","760","796","148","768","764","762","772","795","626","776","780","788","792","798","158","834","800","804","581","858","840","860","336","670","862","092","533","004","024","660","008","020","530","784","032","051","016","010","028","036","040","031","108","056","204","854","050","100","048","044","070","112","084","060","068","076","052","096","064","074","072","140","124","166","756","152","156","384","120","178","184","170","174","132","188","192","162","136","196","203","276","262","212","208","214","012","218","818","232","724","233","231","246","242","238","250","249","234","583","266","826","268","850","704","548","876","882","886","710","180","894","716","642","728","732","260","534","900","891"],"example":"840"},"IPAddress":{"description":"IPv4 or IPv6 network address.","type":"string","example":"264.31.73.24"},"RecurringPaymentState":{"description":"State of the recurring payment.","type":"string","enum":["Installed","Inactivated","Cancelled"],"example":"Installed"},"AdditionalRecurringData":{"description":"Additional Recurring Details for Merchant Initiated Recurring transaction","type":"object","properties":{"amountIndicator":{"type":"string","enum":["VARIABLE_AMOUNT"],"example":"VARIABLE_AMOUNT"},"maxAmount":{"description":"Maximum amount to be sent by merchant when Amount Indicator is VARIABLE_AMOUNT","type":"number","minimum":0,"example":10.24},"validationIndicator":{"description":"If validation is performed by merchant","type":"boolean","default":false,"example":false}}},"ReversalReason":{"type":"string","description":"Reason set by the terminal to cancel the referenced transaction.","enum":["CARD_DECLINED","CUSTOMER_CANCEL","MALFUNCTION","OFFLINE_DECLINED","ONLINE_DECLINED","PARTIAL","SUSPECTED_FRAUD","TIME_OUT","TOO_LATE_RESPONSE","UNABLE_TO_COMPLETE"]},"CustomWalletRegistration":{"description":"Container for wallet registration details.","type":"object","required":["walletType"],"properties":{"walletType":{"description":"This field specifies the type of wallet being registered.","type":"string","enum":["BANCONTACT_WALLET"]},"authenticationMethods":{"description":"Indicating how the Cardholder was authenticated by the Merchant Wallet for transaction initiation.","type":"array","items":{"type":"string","enum":["USERNAME_PASSWORD_PIN","SECRET_KEY_HARDWARE","SECRET_KEY_SOFTWARE","LOCATION_BASED_AUTHENTICATION","ENVIRONMENTAL_AUTHENTICATION","BEHAVIORAL_AUTHENTICATION","BIOMETRICS_AUTHENTICATION","OUT_OF_BAND_USER_AUTHENTICATION"]},"minItems":1}},"example":{"walletType":"BANCONTACT_WALLET","authenticationMethods":["USERNAME_PASSWORD_PIN"]}}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}