> ## Documentation Index > Fetch the complete documentation index at: https://docs.revolv3.com/llms.txt > Use this file to discover all available pages before exploring further. # Authorize With Payment Method Id > Performs a **payment authorization** using a previously stored payment method, referenced by its unique ID. The funds are held on the customer’s account but **not captured** immediately. This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios. It improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data. The authorization can later be captured using the Capture endpoint or voided via Reverse Authorization. Related Links: ## OpenAPI ````yaml /api-reference/swagger.json post /api/Payments/authorization/{paymentMethodId} openapi: 3.0.4 info: title: Revolv3 OpenApi Spec description: Spec for Revolv3 version: 1.29.1 servers: - url: 'https://api-sandbox.revolv3.com ' security: [] paths: /api/Payments/authorization/{paymentMethodId}: post: tags: - Payments summary: Authorize With Payment Method Id description: "Performs a **payment authorization** using a previously stored payment method, referenced by its unique ID.\r\nThe funds are held on the customer’s account but **not captured** immediately.\r\n\r\nThis endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios.\r\nIt improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data.\r\n\r\nThe authorization can later be captured using the Capture endpoint or voided via Reverse Authorization.\r\n\r\nRelated Links:\r\n" parameters: - name: paymentMethodId in: path description: The unique identifier for the payment method information required: true schema: type: integer format: int64 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/AuthorizeRequestDTO' examples: Minimum valid request: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With network processing (Recurring): value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With a dynamic descriptor: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: false Full request: value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: example.com dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: true application/json: schema: $ref: '#/components/schemas/AuthorizeRequestDTO' examples: Minimum valid request: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With network processing (Recurring): value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With a dynamic descriptor: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: false Full request: value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: example.com dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: true text/json: schema: $ref: '#/components/schemas/AuthorizeRequestDTO' examples: Minimum valid request: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With network processing (Recurring): value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With a dynamic descriptor: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: false Full request: value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: example.com dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: true application/*+json: schema: $ref: '#/components/schemas/AuthorizeRequestDTO' examples: Minimum valid request: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With network processing (Recurring): value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: null includeRawProcessorResponse: false With a dynamic descriptor: value: networkProcessing: null amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: null dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: false Full request: value: networkProcessing: processingType: Recurring originalNetworkTransactionId: '4731548603657339' amount: currency: USD value: 30.99 orderProcessingChannel: null ecommercePlatformUrl: example.com dynamicDescriptor: subMerchantId: null subMerchantName: Test subMerchantPhone: 408-555-1212 countryCode: null city: null includeRawProcessorResponse: true responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/AuthorizeResponseDTO' examples: Approved authorization: value: networkTransactionId: d01c9cf6-a6b3-494a-a339-83ddc16c340e paymentMethodAuthorizationId: 1 paymentMethod: paymentMethodId: 1 billingAddressId: 1 billingAddress: addressId: 1 addressLine1: 1 Default Street addressLine2: null city: Los Angeles state: CA postalCode: '90210' phoneNumber: null email: null country: US billingFirstName: John billingLastName: Doe merchantPaymentMethodRefId: custom-payment-method-ref-id-001 paymentMethodAchDetails: null paymentMethodCreditCardDetails: binNumber: '411111' paymentLast4Digit: '1111' paymentExpirationDate: '0835' accountUpdateMessage: null accountUpdateDateTime: null accountUpdateCode: null paymentProcessor: WorldPay processorMerchantId: '10071676' responseMessage: Approved responseCode: '000' rawResponse: null message: Approved processorResponseDateTime: null authCode: null processorTransactionId: null revolv3ResponseCode: null revolv3ResponseMessage: null Failed authorization: value: networkTransactionId: 72819d49-b4b3-4e79-bf43-65eaa1016462 paymentMethodAuthorizationId: null paymentMethod: paymentMethodId: 1 billingAddressId: 1 billingAddress: addressId: 1 addressLine1: 1 Default Street addressLine2: null city: Los Angeles state: CA postalCode: '90210' phoneNumber: null email: null country: US billingFirstName: John billingLastName: Doe merchantPaymentMethodRefId: custom-payment-method-ref-id-001 paymentMethodAchDetails: null paymentMethodCreditCardDetails: binNumber: '411111' paymentLast4Digit: '1111' paymentExpirationDate: '0835' accountUpdateMessage: null accountUpdateDateTime: null accountUpdateCode: null paymentProcessor: WorldPay processorMerchantId: '10071676' responseMessage: Pick Up Card responseCode: '303' rawResponse: null message: >- Pick Up Card. Unable to authorize payment for payment method 1; Transaction Id: 3. processorResponseDateTime: null authCode: null processorTransactionId: null revolv3ResponseCode: null revolv3ResponseMessage: null application/json: schema: $ref: '#/components/schemas/AuthorizeResponseDTO' examples: Approved authorization: value: networkTransactionId: d01c9cf6-a6b3-494a-a339-83ddc16c340e paymentMethodAuthorizationId: 1 paymentMethod: paymentMethodId: 1 billingAddressId: 1 billingAddress: addressId: 1 addressLine1: 1 Default Street addressLine2: null city: Los Angeles state: CA postalCode: '90210' phoneNumber: null email: null country: US billingFirstName: John billingLastName: Doe merchantPaymentMethodRefId: custom-payment-method-ref-id-001 paymentMethodAchDetails: null paymentMethodCreditCardDetails: binNumber: '411111' paymentLast4Digit: '1111' paymentExpirationDate: '0835' accountUpdateMessage: null accountUpdateDateTime: null accountUpdateCode: null paymentProcessor: WorldPay processorMerchantId: '10071676' responseMessage: Approved responseCode: '000' rawResponse: null message: Approved processorResponseDateTime: null authCode: null processorTransactionId: null revolv3ResponseCode: null revolv3ResponseMessage: null Failed authorization: value: networkTransactionId: 72819d49-b4b3-4e79-bf43-65eaa1016462 paymentMethodAuthorizationId: null paymentMethod: paymentMethodId: 1 billingAddressId: 1 billingAddress: addressId: 1 addressLine1: 1 Default Street addressLine2: null city: Los Angeles state: CA postalCode: '90210' phoneNumber: null email: null country: US billingFirstName: John billingLastName: Doe merchantPaymentMethodRefId: custom-payment-method-ref-id-001 paymentMethodAchDetails: null paymentMethodCreditCardDetails: binNumber: '411111' paymentLast4Digit: '1111' paymentExpirationDate: '0835' accountUpdateMessage: null accountUpdateDateTime: null accountUpdateCode: null paymentProcessor: WorldPay processorMerchantId: '10071676' responseMessage: Pick Up Card responseCode: '303' rawResponse: null message: >- Pick Up Card. Unable to authorize payment for payment method 1; Transaction Id: 3. processorResponseDateTime: null authCode: null processorTransactionId: null revolv3ResponseCode: null revolv3ResponseMessage: null text/json: schema: $ref: '#/components/schemas/AuthorizeResponseDTO' examples: Approved authorization: value: networkTransactionId: d01c9cf6-a6b3-494a-a339-83ddc16c340e paymentMethodAuthorizationId: 1 paymentMethod: paymentMethodId: 1 billingAddressId: 1 billingAddress: addressId: 1 addressLine1: 1 Default Street addressLine2: null city: Los Angeles state: CA postalCode: '90210' phoneNumber: null email: null country: US billingFirstName: John billingLastName: Doe merchantPaymentMethodRefId: custom-payment-method-ref-id-001 paymentMethodAchDetails: null paymentMethodCreditCardDetails: binNumber: '411111' paymentLast4Digit: '1111' paymentExpirationDate: '0835' accountUpdateMessage: null accountUpdateDateTime: null accountUpdateCode: null paymentProcessor: WorldPay processorMerchantId: '10071676' responseMessage: Approved responseCode: '000' rawResponse: null message: Approved processorResponseDateTime: null authCode: null processorTransactionId: null revolv3ResponseCode: null revolv3ResponseMessage: null Failed authorization: value: networkTransactionId: 72819d49-b4b3-4e79-bf43-65eaa1016462 paymentMethodAuthorizationId: null paymentMethod: paymentMethodId: 1 billingAddressId: 1 billingAddress: addressId: 1 addressLine1: 1 Default Street addressLine2: null city: Los Angeles state: CA postalCode: '90210' phoneNumber: null email: null country: US billingFirstName: John billingLastName: Doe merchantPaymentMethodRefId: custom-payment-method-ref-id-001 paymentMethodAchDetails: null paymentMethodCreditCardDetails: binNumber: '411111' paymentLast4Digit: '1111' paymentExpirationDate: '0835' accountUpdateMessage: null accountUpdateDateTime: null accountUpdateCode: null paymentProcessor: WorldPay processorMerchantId: '10071676' responseMessage: Pick Up Card responseCode: '303' rawResponse: null message: >- Pick Up Card. Unable to authorize payment for payment method 1; Transaction Id: 3. processorResponseDateTime: null authCode: null processorTransactionId: null revolv3ResponseCode: null revolv3ResponseMessage: null '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/StatusMessageResponse' examples: Generic error: value: message: >- ACCT LENGTH ERR. Unable to authorize payment for payment method 226452; Transaction Id: 789426. Validation error: value: message: One or more validation failed. errors: - Can't find active PaymentMethod '52' fluentValidatorErrors: - propertyName: '' errorMessage: Can't find active PaymentMethod '52' attemptedValue: null customState: null severity: Error errorCode: null formattedMessagePlaceholderValues: null application/json: schema: $ref: '#/components/schemas/StatusMessageResponse' examples: Generic error: value: message: >- ACCT LENGTH ERR. Unable to authorize payment for payment method 226452; Transaction Id: 789426. Validation error: value: message: One or more validation failed. errors: - Can't find active PaymentMethod '52' fluentValidatorErrors: - propertyName: '' errorMessage: Can't find active PaymentMethod '52' attemptedValue: null customState: null severity: Error errorCode: null formattedMessagePlaceholderValues: null text/json: schema: $ref: '#/components/schemas/StatusMessageResponse' examples: Generic error: value: message: >- ACCT LENGTH ERR. Unable to authorize payment for payment method 226452; Transaction Id: 789426. Validation error: value: message: One or more validation failed. errors: - Can't find active PaymentMethod '52' fluentValidatorErrors: - propertyName: '' errorMessage: Can't find active PaymentMethod '52' attemptedValue: null customState: null severity: Error errorCode: null formattedMessagePlaceholderValues: null '401': description: Unauthorized content: text/plain: schema: $ref: '#/components/schemas/StatusMessageResponse' example: message: Attempted to perform an unauthorized operation. application/json: schema: $ref: '#/components/schemas/StatusMessageResponse' example: message: Attempted to perform an unauthorized operation. text/json: schema: $ref: '#/components/schemas/StatusMessageResponse' example: message: Attempted to perform an unauthorized operation. '422': description: Unprocessable Content content: text/plain: schema: $ref: '#/components/schemas/StatusMessageResponse' example: message: Unable to process this operation. application/json: schema: $ref: '#/components/schemas/StatusMessageResponse' example: message: Unable to process this operation. text/json: schema: $ref: '#/components/schemas/StatusMessageResponse' example: message: Unable to process this operation. security: - Bearer: [] components: schemas: AuthorizeRequestDTO: required: - amount type: object properties: networkProcessing: allOf: - $ref: '#/components/schemas/NetworkProcessingDTO' description: "Network processing information.\r\n\r\nProcessors supporting this feature: `Adyen`, `Nuvei`, `WorldPay`, `TSYS`, `BridgePay`, `Paymentech`, `PaymentLync`." amount: allOf: - $ref: '#/components/schemas/AmountDTO' description: The amount information for the payment. orderProcessingChannel: allOf: - $ref: '#/components/schemas/OrderProcessingChannelTypeEnum' description: "Specifies the sales channel through which the shopper provides their card details.\r\n\r\n**Ecommerce** - Internet or electronic commerce transaction.\r\n**Moto** - Single mail or telephone order transaction.\r\n\r\nProcessors supporting this feature: `WorldPay`, `BridgePay`. For other processors, Ecommerce is used by default." ecommercePlatformUrl: maxLength: 100 minLength: 0 type: string description: >- The merchant's storefront or e-commerce platform URL or domain from which the transaction originates. If provided, this value will be sent to the processor (TSYS only) as the Acceptor URL Address. If not provided, the value configured in Merchant Details (E-Commerce Platform URL) will be used. If neither is available, the request is sent to TSYS without the Acceptor URL Address. dynamicDescriptor: allOf: - $ref: '#/components/schemas/TransactionDescriptorDTO' description: "Allows the merchant to define a dynamic descriptor, which appears in the payment statement. \r\nFor dynamic descriptor, special configuration is required.\r\n\r\nProcessors supporting this feature: `Nuvei`, `WorldPay`, `BridgePay`, `EPX`, `Paymentech`, `PaymentLync`." includeRawProcessorResponse: type: boolean description: Determine whether to return raw processor data in the response. default: false additionalProperties: false AuthorizeResponseDTO: type: object properties: networkTransactionId: maxLength: 100 minLength: 0 type: string description: "The identifier returned for Visa, Mastercard, and Discover transactions. Visa and Discover use this value to link subsequent payments in a recurring/installment stream back to the initial transaction.\r\nYou must include this value in the request message (**originalNetworkTransactionId** element) for subsequent recurring payments." paymentMethodAuthorizationId: maximum: 1000000000 minimum: 1 type: integer description: Unique identifier for a previously pre-authorized payment method. format: int64 paymentMethod: allOf: - $ref: '#/components/schemas/PaymentMethodDTO' description: The payment method information for the payment. paymentProcessor: maxLength: 100 minLength: 0 type: string description: The name of the processor by which the transaction was processed. processorMerchantId: maxLength: 100 minLength: 0 type: string description: >- The merchant account ID (MID) of the processor by which the transaction was processed. responseMessage: maxLength: 500 minLength: 0 type: string description: The processor response message. responseCode: maxLength: 10 minLength: 0 type: string description: The processor response code. rawResponse: maxLength: 10000 minLength: 0 type: string description: "**Conditional. The value is returned if includeRawProcessorResponse = true.**\r\nThis field contains the raw data received from the processor after attempting to bill this payment. It does not contain any sensitive information. The field value is a string with the serialized response from the processor in JSON format." message: maxLength: 500 minLength: 0 type: string description: >- The message returned directly from payment processor or a special message provided by system. processorResponseDateTime: maxLength: 40 type: string description: >- UTC timestamp of the payment processor response (format: YYYY-MM-DDThh:mm:ss). format: date-time authCode: maxLength: 20 minLength: 0 type: string description: Transaction authorization code. processorTransactionId: maxLength: 100 minLength: 0 type: string description: Payment Processor Transaction Id. revolv3ResponseCode: maxLength: 10 minLength: 0 type: string description: >- Standardized internal response code indicating the outcome of the request. revolv3ResponseMessage: maxLength: 500 minLength: 0 type: string description: Message providing additional details about the response code. additionalProperties: false StatusMessageResponse: type: object properties: message: type: string nullable: true errors: type: array items: type: string nullable: true fluentValidatorErrors: type: array items: $ref: '#/components/schemas/ValidationFailure' nullable: true additionalProperties: false NetworkProcessingDTO: type: object properties: processingType: allOf: - $ref: '#/components/schemas/PaymentProcessingTypeEnum' description: "Processing type is used to define the initial or subsequent transaction in a recurring or installment stream.\r\n\r\n**If no value is supplied, a transaction is considered a one-time payment and will not be linked to the initial one.**" originalNetworkTransactionId: maxLength: 100 minLength: 0 type: string description: "Element defines the networkTransactionId returned in the response messages for Visa, Mastercard, and Discover Auth/Sale transactions.\r\nYou must include this element and the original value returned for subsequent (after the initial) recurring/installment payments." additionalProperties: false AmountDTO: required: - value type: object properties: currency: allOf: - $ref: '#/components/schemas/CurrencyEnum' description: "The three-character ISO currency code.\r\n\r\nDefault value: `USD`" value: maximum: 9999999.99 minimum: 0 type: number description: The amount information for the payment. Must NOT be less than zero. format: double additionalProperties: false OrderProcessingChannelTypeEnum: enum: - Ecommerce - Moto type: string TransactionDescriptorDTO: type: object properties: subMerchantId: maxLength: 15 type: string description: >- The internal merchant's ID, which is sent to the relevant card scheme. subMerchantName: maxLength: 22 minLength: 0 type: string description: "The merchant name, as is displayed for the transaction on the consumer’s card statement. For payment facilitator only, might consist of the following structure: [Prefix]*[Sub Merchant Name] -\r\nwhere:\r\n1) [Prefix] – The PayFac prefix, approved by processor.\r\n2) '*' – A fixed character.\r\n3) [Sub Merchant Name] – The sub-merchant name.\r\nFor example: aaa*name\r\n\r\nRecommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal.\r\n\r\n**Nuvei** and **Paymentech** processors: the maximum length of the parameter is 22. Possible prefix length 3 or 5 or 7 or 12 characters.\r\n\r\n**WorldPay** and **PaymentLync** processor: if the value is specified, it must be between 4 and 25 characters. Possible prefix length 3 or 7 or 12 characters. Field accepts numbers, letters and special characters as follows: ampersand, asterisk (zero or one), comma, dash, period, space, or pound sign.\r\n\r\n**BridgePay** processor: the maximum length of the parameter is 46.\r\n\r\n**EPX** processor: the maximum length of the parameter is 20. Possible prefix length 3 or 7 or 9 or 12 characters." subMerchantPhone: maxLength: 13 minLength: 0 type: string description: "The merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement.\r\n\r\n**Nuvei** processor: the maximum length of the parameter is 13. It can also be an email address.\r\n**WorldPay** processor: the maximum length of the parameter is 13. Field accepts only numbers.\r\n**BridgePay**, **EPX**, **Paymentech** and **PaymentLync** processor: the maximum length of the parameter is 13." countryCode: maxLength: 2 minLength: 2 type: string description: The payment facilitator's sub-merchant's 2-letter ISO country code. city: maxLength: 20 type: string description: City. nullable: true additionalProperties: false PaymentMethodDTO: type: object properties: paymentMethodId: maximum: 1000000000 minimum: 1 type: integer description: The unique identifier for the payment method information. format: int64 billingAddressId: maximum: 1000000000 minimum: 1 type: integer description: The unique identifier of the address. format: int64 billingAddress: $ref: '#/components/schemas/AddressDTO' billingFirstName: maxLength: 100 minLength: 0 type: string nullable: true billingLastName: maxLength: 100 minLength: 0 type: string nullable: true merchantPaymentMethodRefId: maxLength: 100 minLength: 0 type: string description: Merchant's unique identifier for the payment method. paymentMethodAchDetails: allOf: - $ref: '#/components/schemas/AchViewDTO' description: ACH account information. paymentMethodCreditCardDetails: allOf: - $ref: '#/components/schemas/CreditCardViewDTO' description: The details of credit card payment method. additionalProperties: false ValidationFailure: type: object properties: propertyName: type: string nullable: true errorMessage: type: string nullable: true attemptedValue: nullable: true customState: nullable: true severity: $ref: '#/components/schemas/Severity' errorCode: type: string nullable: true formattedMessagePlaceholderValues: type: object additionalProperties: nullable: true nullable: true additionalProperties: false PaymentProcessingTypeEnum: enum: - InitialRecurring - Recurring - InitialInstallment - Installment type: string CurrencyEnum: enum: - USD - AED - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BMD - BND - BOB - BRL - BSD - BWP - BYN - BZD - CAD - CHF - CLP - CNH - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - HUF - IDR - ILS - INR - IQD - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LYD - MAD - MDL - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLE - SOS - SRD - STN - SVC - SZL - THB - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - UYU - UZS - VEF - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - AFN - KPW - LRD - LSL - STD - SYP - TJS - ZMK - ZWD - SLL - MGA - HRK - CDF - BTN - BIF type: string AddressDTO: type: object properties: addressId: type: integer description: The unique identifier of the address. format: int64 addressLine1: maxLength: 40 minLength: 2 type: string description: Address. nullable: true addressLine2: maxLength: 40 minLength: 0 type: string description: Supplemental information for the address. city: maxLength: 25 minLength: 2 type: string description: City. nullable: true state: maxLength: 2 minLength: 2 type: string description: Two-letter state abbreviation. nullable: true postalCode: maxLength: 20 minLength: 2 type: string description: Postal Code. nullable: true phoneNumber: maxLength: 20 minLength: 0 type: string description: >- The phone number associated with a payment method that is used for billing purposes. email: maxLength: 100 minLength: 0 type: string description: The email associated with a billing address. format: email country: maxLength: 2 minLength: 2 type: string description: Country. nullable: true additionalProperties: false AchViewDTO: type: object properties: accountNumberLast4Digits: maxLength: 4 minLength: 4 pattern: ^\d{4}$ type: string description: Last 4 digits of the bank account. accountNumberLength: maximum: 17 minimum: 4 type: integer description: Bank account number length. format: int32 accountType: maxLength: 8 minLength: 0 pattern: ^(Checking|Savings)$ type: string description: "**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive." additionalProperties: false nullable: true CreditCardViewDTO: type: object properties: binNumber: maxLength: 6 minLength: 0 pattern: ^\d{1,6}$ type: string description: First 6 digits (BIN) of the card number. paymentLast4Digit: maxLength: 4 minLength: 4 pattern: ^\d{4}$ type: string description: Payment card last 4 digits. paymentExpirationDate: maxLength: 4 minLength: 0 type: string description: The card expiration date. format: MMYY nullable: true accountUpdateMessage: maxLength: 500 minLength: 0 type: string description: Account updater message, if available. accountUpdateDateTime: maxLength: 20 minLength: 0 type: string description: UTC date-time of the last account updater event. format: YYYY-MM-DDThh:mm:ss nullable: true accountUpdateCode: maxLength: 50 minLength: 0 type: string description: Processor response code of the last account updater event. additionalProperties: false nullable: true Severity: enum: - Error - Warning - Info type: string securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ````