openapi: 3.2.0 info: title: Gr4vy Payment Links API version: '1.0' description: 'Operations tagged Payment Links across 2 of this provider''s published API definitions: gr4vy-docs-v1-openapi.json, gr4vy-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://api.sandbox.{id}.gr4vy.app x-speakeasy-server-id: sandbox variables: id: default: example description: The subdomain for your Gr4vy instance. - url: https://api.{id}.gr4vy.app x-speakeasy-server-id: production variables: id: default: example description: The subdomain for your Gr4vy instance. tags: - name: Payment Links description: 'In Gr4vy, payment links allow a merchant to generate a link, send it to a customer via email, SMS, etc, and then have the customer pay without the need for the merchant hosting their own checkout.' paths: /payment-links: get: operationId: list-payment-links summary: List payment links description: Lists all payment links for an account. Sorted by last updated at. tags: - Payment Links responses: '200': description: Returns a paginated list of payment links for an account. content: application/json: schema: $ref: '#/components/schemas/PaymentLinks' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' security: - bearerAuth: [] post: operationId: new-payment-link summary: Create payment link description: Creates a new payment link. tags: - Payment Links requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentLinkRequest' responses: '201': description: Returns the created payment link. content: application/json: schema: $ref: '#/components/schemas/PaymentLink' '400': description: 'Returns an error if the request was badly formatted or missing required fields.' content: application/json: schema: $ref: '#/components/schemas/Error400BadRequest' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' security: - bearerAuth: [] servers: - url: https://api.sandbox.{id}.gr4vy.app x-speakeasy-server-id: sandbox variables: id: default: example description: The subdomain for your Gr4vy instance. - url: https://api.{id}.gr4vy.app x-speakeasy-server-id: production variables: id: default: example description: The subdomain for your Gr4vy instance. /payment-links/{payment_link_id}: parameters: - schema: type: string example: 1b2e1e3d-ec3e-4884-9553-f7356683f7f9 name: payment_link_id in: path required: true description: The ID for the payment link to get the information for. get: operationId: get-payment-link summary: Get payment link description: Gets information about a payment link. tags: - Payment Links responses: '200': description: Returns a payment link. content: application/json: schema: $ref: '#/components/schemas/PaymentLink' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' '404': description: Returns an error if the resource can not be found. content: application/json: schema: $ref: '#/components/schemas/Error404NotFound' security: - bearerAuth: [] servers: - url: https://api.sandbox.{id}.gr4vy.app x-speakeasy-server-id: sandbox variables: id: default: example description: The subdomain for your Gr4vy instance. - url: https://api.{id}.gr4vy.app x-speakeasy-server-id: production variables: id: default: example description: The subdomain for your Gr4vy instance. /payment-links/{payment_link_id}/expire: parameters: - schema: type: string example: 1b2e1e3d-ec3e-4884-9553-f7356683f7f9 name: payment_link_id in: path required: true description: The ID for the payment link to get the information for. post: operationId: expire-payment-link summary: Expire payment link description: Expires a payment link. tags: - Payment Links parameters: - name: payment_link_id in: path required: true description: The ID of the payment link to expire. schema: type: string format: uuid example: 8d3fe99b-1422-42e6-bbb3-932d95ae5f79 responses: '204': description: Returns an empty response if the payment link was successfully expired. '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' '404': description: Returns an error if the resource can not be found. content: application/json: schema: $ref: '#/components/schemas/Error404NotFound' security: - bearerAuth: [] servers: - url: https://api.sandbox.{id}.gr4vy.app x-speakeasy-server-id: sandbox variables: id: default: example description: The subdomain for your Gr4vy instance. - url: https://api.{id}.gr4vy.app x-speakeasy-server-id: production variables: id: default: example description: The subdomain for your Gr4vy instance. components: schemas: ShippingDetail: title: Shipping detail type: object description: Shipping detail for a buyer. x-tags: - Buyers properties: type: type: string description: The type of this resource. Is always `shipping-details`. example: shipping-details enum: - shipping-details id: type: string format: uuid description: The unique ID for a buyer's shipping detail. example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 buyer_id: type: string format: uuid description: The unique ID for a buyer. example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 first_name: type: - string - 'null' minLength: 1 maxLength: 255 description: The first name(s) or given name of the buyer. example: John last_name: type: - string - 'null' minLength: 1 maxLength: 255 example: Lunn description: The last name, or family name, of the buyer. email_address: type: - string - 'null' minLength: 1 maxLength: 320 description: The email address of the buyer. example: john@example.com phone_number: type: - string - 'null' pattern: ^\+[1-9]\d{1,14}$ minLength: 1 maxLength: 50 description: 'The phone number of the buyer. This number is formatted according to the [E164 number standard](https://www.twilio.com/docs/glossary/what-e164).' example: '+1234567890' address: type: - object - 'null' description: The physical shipping address associated to this buyer. allOf: - $ref: '#/components/schemas/Address' PaymentLinks: title: Payment Links type: object description: A list of payment links. x-tags: - PaymentLinks properties: items: type: array description: A list of payment links. items: $ref: '#/components/schemas/PaymentLink' limit: type: integer description: 'The limit applied to request. This represents the number of items that are at maximum returned by this request.' format: int32 minimum: 1 maximum: 100 example: 1 default: 20 next_cursor: type: - string - 'null' description: 'The cursor that represents the next page of results. Use the `cursor` query parameter to fetch this page of items.' example: ZXhhbXBsZTE minLength: 1 maxLength: 1000 previous_cursor: type: - string - 'null' description: 'The cursor that represents the next page of results. Use the `cursor` query parameter to fetch this page of items.' example: null minLength: 1 maxLength: 1000 TransactionBuyerRequest: title: Buyer type: object description: Guest buyer details. x-tags: - Request Bodies properties: external_identifier: type: - string - 'null' description: An external identifier that can be used to match the buyer against your own records. This value needs to be unique for all buyers. example: user-789123 minLength: 1 maxLength: 200 display_name: type: - string - 'null' description: A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name. example: John L. minLength: 1 maxLength: 200 billing_details: type: - object - 'null' description: The optional billing details for the a buyer. allOf: - $ref: '#/components/schemas/BillingDetailsRequest' shipping_details: type: - object - 'null' description: The optional shipping details for the buyer. allOf: - $ref: '#/components/schemas/ShippingDetail' account_number: type: - string - 'null' minLength: 1 maxLength: 255 example: '1234567' description: The source account number to perform an account funding transaction. ConnectionOptions: title: Connection Options type: object properties: cybersource-card: type: - object - 'null' description: Additional options for Cybersource payment gateway. properties: meta_key_merchant_id: type: - string - 'null' description: 'An override for the merchant ID configured for the connector, used in combination with meta keys.' merchant_defined_information: type: object description: 'This is a key-value object for merchant defined information. Each key needs to be a numeric string identifying the MDI field to set. For example, for field 1 set the key to "1".' maxProperties: 100 additionalProperties: type: string example: '1': John Doe '2': trusted '99': recurring ship_to_method: type: - string - 'null' description: Shipping method for the order. cybersource-kcp: type: - object - 'null' description: Additional options for Cybersource KCP APM. properties: meta_key_merchant_id: type: - string - 'null' description: 'An override for the merchant ID configured for the connector, used in combination with meta keys.' merchant_defined_information: type: object description: 'This is a key-value object for merchant defined information. Each key needs to be a numeric string identifying the MDI field to set. For example, for field 1 set the key to "1".' maxProperties: 100 additionalProperties: type: string example: '1': John Doe '2': trusted '99': recurring ship_to_method: type: - string - 'null' description: Shipping method for the order. cybersource-ideal: type: - object - 'null' description: Additional options for Cybersource iDeal APM. properties: meta_key_merchant_id: type: - string - 'null' description: 'An override for the merchant ID configured for the connector, used in combination with meta keys.' merchant_defined_information: type: object description: 'This is a key-value object for merchant defined information. Each key needs to be a numeric string identifying the MDI field to set. For example, for field 1 set the key to "1".' maxProperties: 100 additionalProperties: type: string example: '1': John Doe '2': trusted '99': recurring ship_to_method: type: - string - 'null' description: Shipping method for the order. cybersource-anti-fraud: type: - object - 'null' description: Additional options for Cybersource Decision Manager (anti-fraud). properties: meta_key_merchant_id: type: - string - 'null' description: 'An override for the merchant ID configured for the connector, used in combination with meta keys.' merchant_defined_data: type: object description: 'This is a key-value object for merchant defined data. Each key needs to be a numeric string identifying the MDD field to set. For example, for field 1 set the key to "1". Please avoid fields "31", "48", "50"-"56" and "63"-"76" as these are auto-populated based on the transaction profile.' maxProperties: 100 additionalProperties: type: string example: '1': John Doe '2': trusted '99': recurring shipping_method: type: - string - 'null' description: Shipping method for the order. givingblock-givingblock: type: - object - 'null' description: Additional options for Giving Block connector. properties: defaultCryptocurrency: type: string description: 'The default crypto currency to display on the hosted page presented by The Giving Block.' example: ETH forter-anti-fraud: type: - object - 'null' description: Additional options for Forter (anti-fraud). properties: delivery_type: type: - string - 'null' enum: - PHYSICAL - DIGITAL - HYBRID description: 'Value to populate the `deliveryType` field in `primaryDeliveryDetails`. Represents the type of delivery. This can be set to `PHYSICAL` for any type of shipped goods, `DIGITAL` for non-shipped goods (services, gift cards etc.), or `HYBRID` for others.' delivery_method: type: - string - 'null' description: 'Value to populate the `deliveryMethod` field in `primaryDeliveryDetails`. Represents the delivery method chosen by customer such as postal service, email, in game transfer, etc.' is_guest_buyer: type: boolean default: false description: 'Defines if this is a guest check-out. This will redact the `accountId` and `created` fields from the `accountOwner` details sent to Forter.' cart_items: type: array description: 'A list of Forter cart item objects. These will be merged into the `cart_items` passed to the transaction. Every cart item here will be merged with a cart item on the transaction with the same index. Together, these will augment the `cartItems` values sent to the Forter validation API.' items: type: object properties: basic_item_data: description: General data regarding item such as name, price, etc. type: object properties: type: type: string maxLength: 12 example: TANGIBLE enum: - TANGIBLE - NON_TANGIBLE description: Tangible if physical item, non-tangible if any other product. delivery_details: description: General data regarding item such as name, price, etc. type: object properties: delivery_type: type: - string - 'null' example: PHYSICAL enum: - PHYSICAL - DIGITAL - HYBRID description: 'Value to populate the `deliveryType` field for this cart item. This overrides the type set at the wider level. Represents the type of delivery. This can be set to `PHYSICAL` for any type of shipped goods, `DIGITAL` for non-shipped goods (services, gift cards etc.), or `HYBRID` for others.' delivery_method: type: string example: USPS - Ground Mail description: 'Value to populate the `deliveryMethod` field for this cart item. This overrides the method set at the wider level. Represents the delivery method chosen by customer such as postal service, email, in game transfer, etc.' beneficiaries: type: array description: List of all entities receiving or using the purchased cart item. items: type: object required: - personal_details properties: personal_details: description: 'Personal details are those which contribute to building up a picture of the person as an individual, such as name, title, etc.' type: object properties: first_name: description: First name. type: string maxLength: 75 example: John last_name: description: Last name. type: string maxLength: 75 example: Smith email: description: Email address. type: string maxLength: 256 example: john@example.com address: description: Address details for the beneficiary. type: - object - 'null' required: - country properties: country: description: Country, two-letter ISO 3166-1 alpha 2 country code. type: string maxLength: 2 example: US address1: description: Street-level address. Required when full address details are available. type: - string - 'null' maxLength: 255 example: 235 Montgomery st. address2: description: Unit-level address. type: - string - 'null' maxLength: 255 example: Ste. 1110 zip: description: Zipcode. type: - string - 'null' maxLength: 20 example: '94104' region: description: 'Top-level administrative subdivision - state/province/department/etc. Can be either abbreviated format or full name (NY/New York).' type: - string - 'null' maxLength: 200 example: CA company: description: Company name. type: - string - 'null' maxLength: 255 example: Generic Corp. ltd. city: description: City. Required when full address details are available. type: - string - 'null' maxLength: 200 example: San Francisco phone: type: array description: List of all phone numbers for the beneficiary. items: type: object required: - phone properties: phone: description: Phone number including all country and local access codes. type: string maxLength: 25 example: '15557654321' comments: description: Comments to merchant or beneficiary written by customer. type: - object - 'null' properties: user_comments_to_merchant: description: Comments the customer left to the merchant. type: - string - 'null' maxLength: 600 example: Please wrap with care!! message_to_beneficiary: description: Comments the customer left to the beneficiary of the purchase made. type: - string - 'null' maxLength: 600 example: Enjoy the gift John! merchant_comments: description: Comments by the merchant. type: - string - 'null' maxLength: 600 example: Shipping delayed total_discount: description: 'The `totalDiscount` object that''s sent to Forter''s validation API. It represents the discount that was given to the customer.' type: - object - 'null' required: - coupon_code - discount_type properties: coupon_code_used: type: string maxLength: 150 example: FATHERSDAY2015 description: The coupon code used. discount_type: type: string maxLength: 250 example: COUPON description: The discount type. coupon_discount_amount: description: A monetary amount in USD or local currency. type: - object - 'null' required: - coupon_code - discount_type properties: amount_usd: type: string maxLength: 12 example: '99.95' description: Transaction amount in USD. amount_local_currency: type: string maxLength: 20 example: '105.55' description: Transaction amount in currency chosen by the buyer. currency: type: string maxLength: 3 example: CAD description: Transaction currency chosen by the buyer, 3-letter ISO-4217 format currency code. coupon_discount_percent: type: - string - 'null' example: 20% description: Coupon discount percentage. adyen-card: type: - object - 'null' description: 'Additional options to be passed through to Adyen when processing card transactions.' properties: additionalData: type: object description: 'A key-value object representing additional data to be passed to Adyen.' additionalProperties: type: string example: riskdata.operatorCode: operatorCode, riskdata.operatorCountry: operatorCountry autoRescue: type: boolean default: false description: Enabled Adyen's auto-rescue feature. maxDaysToRescue: type: - integer - 'null' default: null description: 'Defines the number of days to auto-retry a payment for if `autoRescue` is enabled.' autoRescueScenario: type: - string - 'null' default: null description: Defines the Adyen auto-rescue test scenario to invoke. adyen-sepa: type: - object - 'null' description: 'Additional options to be passed through to Adyen when processing SEPA transactions.' properties: autoRescue: type: boolean default: false description: Enabled Adyen's auto-rescue feature. maxDaysToRescue: type: - integer - 'null' default: null description: 'Defines the number of days to auto-retry a payment for if `autoRescue` is enabled.' autoRescueSepaScenario: type: - string - 'null' default: null description: Defines the Adyen auto-rescue test scenario to invoke. ownerName: type: - string - 'null' default: null description: Defines the type of chargeback that you want to simulate. paypal-paypal: type: - object - 'null' description: 'Additional options to be passed through to PayPal when processing transactions.' properties: additional_data: type: array description: 'An array with key-value objects representing additional data to be passed to PayPal.' items: type: object properties: key: type: string value: type: string example: - key: test value: abc paypal-paypalpaylater: type: - object - 'null' description: 'Additional options to be passed through to PayPal when processing transactions.' properties: additional_data: type: array description: 'An array with key-value objects representing additional data to be passed to PayPal.' items: type: object properties: key: type: string value: type: string example: - key: test value: abc powertranz-card: type: - object - 'null' description: 'Additional options to be passed through to Powertranz when processing transactions.' properties: skipThreeDSecure: type: boolean default: false description: 'Allows skipping of 3DS. Without this, every transaction will be sent via Powertranz''s 3DS server, even though 3DS might not be triggered.' stripe-card: type: - object - 'null' description: 'Additional options to be passed through to Stripe when processing transactions.' properties: error_on_requires_action: type: boolean default: false description: 'Defines if Stripe should automatically fail the payment if it requires two-factor authentication from the user.' stripe_connect: type: - object - 'null' description: Stripe Connect configuration options. properties: stripe_account: type: - string - 'null' description: The ID of the connected Stripe account to process for. application_fee_amount: type: - number - 'null' description: The application fee to charge when processing for a connected account. on_behalf_of: type: - string - 'null' description: The Stripe account ID that these funds are intended for. transfer_data_destination: type: - string - 'null' description: The Stripe account ID that these funds are to be transferred to. fiserv-card: type: - object - 'null' description: Additional options for Fiserv IPG payment gateway. properties: installmentOptions: type: - object - 'null' description: Fiserv installment options. properties: numberOfInstallments: type: - number - 'null' description: Number of installments for a sale transaction if the customer pays the total amount in multiple transactions. installmentsInterest: type: - boolean - 'null' description: Indicates whether the installment interest amount has been applied. installmentDelayMonths: type: - number - 'null' description: The number of months the first installment payment will be delayed. merchantAdviceCodeSupported: type: - boolean - 'null' description: Indicates if the merchant supports merchant advice code (MAC) in order to receive table 55 code for a declined recurring transaction. latitude-latitude: type: - object - 'null' description: 'Additional options to be passed through to Latitude/Gem when processing transactions.' properties: promotion_reference: type: - string - 'null' description: The promotion reference. latitude-latitudeds: type: - object - 'null' description: 'Additional options to be passed through to Latitude/Gem when processing transactions.' properties: promotion_reference: type: - string - 'null' description: The promotion reference. gem-gem: type: - object - 'null' description: 'Additional options to be passed through to Latitude/Gem when processing transactions.' properties: promotion_reference: type: - string - 'null' description: The promotion reference. gem-gemds: type: - object - 'null' description: 'Additional options to be passed through to Latitude/Gem when processing transactions.' properties: promotion_reference: type: - string - 'null' description: The promotion reference. nuvei-card: type: - object - 'null' description: 'Additional options to be passed through to Nuvei when processing transactions.' properties: customData: type: - string - 'null' description: 'Custom data that will be returned in a response and displayed in Nuvei''s reporting.' airlineData: type: - object - 'null' description: 'Custom airline travel information that will be sent to Nuvei in addition to the standard airline fields sent in the request.' properties: isCardholderTraveling: type: - boolean - 'null' description: Indicates whether the cardholder is part of the travelling party. seatClass: type: - string - 'null' description: If present, will be sent to Nuvei as the seat class for all legs. travelhub-card: type: - object - 'null' description: 'Additional options to be passed through to Worldline Travelhub when processing transactions.' properties: customData: type: array description: 'An array with name-value objects representing additional data to be passed to Worldline Travelhub.' items: type: object properties: name: type: string value: type: string example: - name: fraud_data_name1 value: aaa affirm-affirm: type: - object - 'null' description: 'Additional options to be passed through to Affirm when processing transactions.' properties: discounts: type: array description: An array of discount objects. items: type: - object - 'null' properties: discount_code: type: object description: 'The name of your discount code is the name of the object that describes the amount and display name for that discount. For example, RETURN5 is the name of the discount code, so it is represented here as the name of the first discount in the discounts object.' properties: discount_amount: type: number description: The amount of the discount. example: 500 discount_display_name: type: string description: The display name of the discount. example: Returning customer 5% discount example: - RETURN5: discount_amount: 500, discount_display_name: Returning customer 5% discount - PRESDAY10: discount_amount: 1000, discount_display_name: President's Day 10% off braintree-card: type: - object - 'null' description: 'Additional options to be passed through to Braintree when processing transactions.' properties: custom_fields: type: - object - 'null' description: 'An array with name-value objects representing additional data to be passed to Braintree. Each key is the name sent to Braintree.' additionalProperties: type: string example: key-1: Value for key1 key-2: Value for key2 dynamic_data_fields: type: - object - 'null' description: Options to dynamically add information to be sent to Braintree. properties: three_ds_auth_status: type: - string - 'null' description: 'The name of the custom field to be sent to Braintree. The value will be the 3DS authentication status.' example: three_ds_auth_status: custom-field-key-name CartItem: title: Cart Item type: object description: 'A cart item that represents a single cart line item for a transaction. Note that some optional properties are required for certain payment service providers. If no value is set for these properties, we will use their default value. If the total due to be paid for the item is required by the payment service provider, generally referred to as the "total amount", the formula below will usually be used to calculate this amount: `(unit_amount * quantity) - discount_amount + tax_amount` It''s highly recommended that the total amount to pay for all items should match the transaction''s amount to reduce the risk of the transaction being declined by the payment service provider.' required: - name - quantity - unit_amount properties: name: type: string description: 'The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.' example: GoPro HERO9 Camcorder maxLength: 255 quantity: type: integer description: 'The quantity of this item in the cart. This value cannot be negative or zero.' example: 1 minimum: 1 maximum: 99999999 unit_amount: type: integer description: 'The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.' example: 37999 minimum: 0 maximum: 99999999 discount_amount: type: - integer - 'null' description: 'The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. Please note that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total discount amount for 5 of the cart item. You might see unexpected failed transactions if the `discount_amount` can not be equally divided by the `quantity` value. This is due to the fact that some payment services require this amount to be specified per unit. In this situation we recommend splitting this item into separate items, each with their own specific discount.' example: 0 minimum: 0 maximum: 99999999 default: 0 tax_amount: type: - integer - 'null' description: 'The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. Please not that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total tax amount for 5 of the cart item. You might see unexpected failed transactions if the `tax_amount` can not be equally divided by the `quantity` value. This is due to the fact that some payment services require this amount to be specified per unit. In this situation we recommend splitting this item into separate items, each with their own specific tax amount.' example: 0 minimum: 0 maximum: 99999999 default: 0 external_identifier: type: - string - 'null' example: item-789123 description: An external identifier for the cart item. This can be set to any value and is not sent to the payment service. maxLength: 200 sku: type: - string - 'null' example: sku-789123 description: The SKU for the item. maxLength: 200 product_url: type: - string - 'null' format: url example: https://example.com/items/gopro description: The product URL for the item. maxLength: 2083 image_url: type: - string - 'null' format: url example: https://example.com/images/items/gopro.png description: The URL for the image of the item. maxLength: 2083 categories: type: - array - 'null' description: 'A list of strings containing product categories for the item. Max length per item: 50.' items: type: string maxLength: 50 maxItems: 100 product_type: type: - string - 'null' description: The product type of the cart item. example: physical enum: - physical - discount - shipping_fee - sales_tax - digital - gift_card - store_credit - surcharge - null seller_country: type: - string - 'null' description: 'The country code of the seller of the item. For some connectors, if this country code does not match the `country` then the transaction will be marked to Visa as a foreign seller transaction to meet Marketplace reporting requirements.' example: US pattern: ^[A-Z]{2}$ StatementDescriptor: title: Statement descriptor type: object description: 'The statement descriptor is the text to be shown on the buyer''s statements. The specific usage of these fields will depend on the capabilities of the underlying PSP and bank. As a typical example, ''name'' and ''description'' could be concatenated using ''* '' as a separator, and then the resulting descriptor would be truncated to 22 characters by the issuing bank.' properties: name: type: - string - 'null' minLength: 5 maxLength: 22 description: "Reflects your doing business as (DBA) name.\n\nOther validations:\n\n1. Contains only Latin characters.\n2. Contain at least one letter\n3. Does not contain any of the special characters `< > \\ ' \" *`\n4. Supports:\n 1. Lower case: `a-z`\n 2. Upper case: `A-Z`\n 3. Numbers: `0-9`\n 4. Spaces: ` `\n 5. Special characters: `. , _ - ? + /`." example: GR4VY description: type: - string - 'null' minLength: 5 maxLength: 22 example: Card payment description: "A short description about the purchase.\n\nOther validations:\n1. Contains only Latin characters.\n2. Contain at least one letter\n3. Does not contain any of the special characters `< > \\ ' \" *`\n4. Supports:\n 1. Lower case: `a-z`\n 2. Upper case: `A-Z`\n 3. Numbers: `0-9`\n 4. Spaces: ` `\n 5. Special characters: `. , _ - ? + /`." city: type: - string - 'null' minLength: 1 maxLength: 13 description: 'The merchant''s city to be displayed in a statement descriptor.' example: London country: description: 'The 2-letter ISO country code of the merchant to be displayed in a statement descriptor. ' example: US type: - string - 'null' phone_number: type: - string - 'null' pattern: ^\+[1-9]\d{1,14}$ minLength: 5 maxLength: 20 description: 'The value in the phone number field of a customer''s statement which should be formatted according to the [E164 number standard](https://www.twilio.com/docs/glossary/what-e164).' example: '+1234567890' url: type: - string - 'null' minLength: 1 maxLength: 50 description: 'The merchant''s URL to be displayed in a statement descriptor.' example: www.gr4vy.com Error404NotFound: title: Not Found Error type: object description: Not Found Error (HTTP 404). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: The reason code for the error. example: not_found enum: - not_found - pending_creation status: type: integer description: '`404`.' example: 404 enum: - 404 message: type: string description: The human readable reason for the error. example: The resource could not be found details: type: array description: 'A list of detail objects that further clarify the reason for the error. Not every error supports more detail.' example: [] items: $ref: '#/components/schemas/ErrorDetail' Buyer--Snapshot: title: Buyer (Snapshot) type: object description: 'Snapshot of a buyer, as used when embedded inside other resources.' x-tags: - Buyers properties: type: type: string description: The type of this resource. Is always `buyer`. example: buyer enum: - buyer id: type: - string - 'null' example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique Gr4vy ID for this buyer. format: uuid billing_details: allOf: - $ref: '#/components/schemas/BillingDetails' description: 'The billing details associated with the buyer, which include the address and tax ID.' display_name: description: A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name. example: John L. maxLength: 200 minLength: 1 type: - string - 'null' external_identifier: description: An external identifier that can be used to match the buyer against your own records. example: user-789123 maxLength: 200 minLength: 1 type: - string - 'null' account_number: type: - string - 'null' minLength: 1 maxLength: 255 example: '1234567' description: The source account number to perform an account funding transaction. ErrorDetail: title: Error details description: Additional detail about the part of a request body that caused an issue. type: object x-tags: - Errors properties: location: type: string example: body description: The location where the error caused an issue. enum: - query - body - path - header type: type: string example: value_error.missing description: A unique identifier for the type of error that occurred. pointer: type: string example: /payment_method/number description: 'The exact item for which the validation did not succeed. This is a JSON pointer for request bodies, while for query, path, and header parameters it is the name of the parameter.' message: type: string example: field required description: A human readable message for this error detail. Error401Unauthorized: title: Unauthorized Error type: object description: Unauthorized Error (HTTP 401). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: '`unauthorized`.' example: unauthorized enum: - unauthorized status: type: integer description: '`401`.' example: 401 enum: - 401 message: type: string description: No valid API authentication found. example: No valid API authentication found enum: - No valid API authentication found details: type: array description: 'A list of detail objects that further clarify the reason for the error. Not every error supports more detail.' example: [] items: $ref: '#/components/schemas/ErrorDetail' BillingDetails: title: Billing details type: object description: Billing details associated to a buyer. x-tags: - Buyers properties: type: type: string description: The type of this resource. Is always `billing-details`. example: billing-details enum: - billing-details first_name: type: - string - 'null' minLength: 1 maxLength: 255 description: The first name(s) or given name of the buyer. example: John last_name: type: - string - 'null' minLength: 1 maxLength: 255 example: Lunn description: The last name, or family name, of the buyer. email_address: type: - string - 'null' minLength: 1 maxLength: 320 description: The email address of the buyer. example: john@example.com phone_number: type: - string - 'null' pattern: ^\+[1-9]\d{1,14}$ minLength: 1 maxLength: 50 description: 'The phone number of the buyer. This number is formatted according to the [E164 number standard](https://www.twilio.com/docs/glossary/what-e164).' example: '+1234567890' address: description: The billing address of the buyer. allOf: - $ref: '#/components/schemas/Address' tax_id: description: The tax information associated with the billing details. allOf: - $ref: '#/components/schemas/TaxId' Address: title: Address type: object description: An address for the buyer. x-tags: - Buyers properties: city: type: - string - 'null' minLength: 1 maxLength: 100 description: The city for the address. example: London country: type: - string - 'null' minLength: 2 maxLength: 2 description: The country for the address in ISO 3166 format. example: GB postal_code: type: - string - 'null' minLength: 1 maxLength: 50 description: The postal code or zip code for the address. example: '789123' state: type: - string - 'null' minLength: 1 maxLength: 255 description: The state, county, or province for the address. example: Greater London state_code: type: - string - 'null' minLength: 4 maxLength: 6 description: 'The code of state, county, or province for the address in ISO 3166-2 format.' example: GB-LND house_number_or_name: type: - string - 'null' minLength: 1 maxLength: 255 description: 'The house number or name for the address. Not all payment services use this field but some do.' example: '10' line1: type: - string - 'null' minLength: 1 maxLength: 255 description: The first line of the address. example: 10 Oxford Street line2: type: - string - 'null' minLength: 1 maxLength: 255 description: The second line of the address. example: New Oxford Court organization: type: - string - 'null' minLength: 1 maxLength: 255 description: 'The optional name of the company or organisation to add to the address.' example: Gr4vy PaymentLinkRequest: title: Payment Link (Create) type: object description: Request body for creating a new payment link. x-tags: - Request Bodies required: - amount - currency - country properties: amount: type: number example: 1299 minimum: 1 maximum: 99999999 description: The amount to request payment for. currency: type: string example: USD description: The ISO-4217 currency code for the payment. country: description: 'The 2-letter ISO code of the country of the transaction. This is used to filter the payment services that is used to process the transaction. ' example: US type: string buyer: description: Guest buyer details provided inline. No buyer resource will be created on Gr4vy when used. oneOf: - $ref: '#/components/schemas/TransactionBuyerRequest' type: - object - 'null' x-model-name: TransactionBuyerRequest expires_at: type: - string - 'null' format: date-time example: '2022-01-01T12:00:00+00:00' description: The date and time when this payment link expires. Defaults to 24 hours from creation. connection_options: allOf: - $ref: '#/components/schemas/ConnectionOptions' description: 'Allows for passing optional configuration per connection to take advantage of connection specific features. When provided, the data is only passed to the target connection type to prevent sharing configuration across connections. Please note that each of the keys this object are in kebab-case, for example `cybersource-anti-fraud` as they represent the ID of the connector. All the other keys will be snake case, for example `merchant_defined_data` or camel case to match an external API that the connector uses.' type: - object - 'null' external_identifier: type: - string - 'null' description: A value that can be used to match the payment link against your own records. This will also be applied to any transaction. example: payment-link-123 minLength: 1 maxLength: 200 statement_descriptor: type: - object - 'null' allOf: - $ref: '#/components/schemas/StatementDescriptor' locale: type: - string - 'null' description: The locale used to translate text within the payment link. example: en enum: - en - en-GB - es - pt - pt-BR merchant_name: type: - string - 'null' description: The name of the merchant to display on the payment link. example: Gr4vy maxLength: 100 merchant_url: type: - string - 'null' description: The URL of the merchant to display on the payment link. example: https://gr4vy.com merchant_banner_url: type: - string - 'null' description: The URL of the merchant banner to display on the payment link. example: https://gr4vy.com/banner.png merchant_color: type: - string - 'null' description: The color code of the merchant to display on the payment link. example: '#FF0000' merchant_message: type: - string - 'null' description: The message to display on the payment link. example: Thank you for shopping with us! maxLength: 255 merchant_terms_and_conditions_url: type: - string - 'null' description: The URL of the merchant terms and conditions to display on the payment link. example: https://gr4vy.com/terms merchant_favicon_url: type: - string - 'null' description: The URL of the merchant favicon icon. example: https://gr4vy.com/favicon.png intent: type: - string - 'null' description: The intent of the payment link. example: authorize enum: - authorize - capture default: authorize return_url: type: - string - 'null' description: The URL to redirect the buyer to after payment. example: https://gr4vy.com/return cart_items: description: An array of cart items that represents the line items of a payment link. items: $ref: '#/components/schemas/CartItem' maxItems: 249 type: array metadata: additionalProperties: type: string description: 'Any additional information about the payment link that you would like to store as key-value pairs. This data is passed to payment service providers that support it.' example: key: value maxProperties: 20 type: - object - 'null' payment_source: type: - string - 'null' description: The source of the payment link. example: recurring enum: - ecommerce - moto - recurring - installment - card_on_file BillingDetailsRequest: title: Billing details (Create) type: object description: Billing details to use associated to a buyer. x-tags: - Buyers properties: first_name: type: - string - 'null' minLength: 1 maxLength: 255 description: The first name(s) or given name for the buyer. example: John last_name: type: - string - 'null' minLength: 1 maxLength: 255 example: Lunn description: The last name, or family name, of the buyer. email_address: type: - string - 'null' minLength: 1 maxLength: 320 description: The email address for the buyer. example: john@example.com phone_number: type: - string - 'null' pattern: ^\+[1-9]\d{1,14}$ minLength: 1 maxLength: 50 description: 'The phone number for the buyer which should be formatted according to the [E164 number standard](https://www.twilio.com/docs/glossary/what-e164).' example: '+1234567890' address: type: - object - 'null' description: The billing address for the buyer. allOf: - $ref: '#/components/schemas/Address' - required: - line1 - city - state - postal_code - country tax_id: type: - object - 'null' description: The tax ID information associated with the billing details. allOf: - $ref: '#/components/schemas/TaxId' TaxId: title: Tax ID type: object description: The tax ID information associated to a buyer. x-tags: - Buyers required: - kind - value properties: value: type: string minLength: 1 maxLength: 50 description: The tax ID for the buyer. example: '12345678931' kind: type: string description: The kind of tax ID. example: gb.vat enum: - ae.trn - au.abn - ar.dni - ar.cuil - ar.cuit - br.cnpj - br.cpf - ca.bn - ca.gst_hst - ca.pst_bc - ca.pst_mb - ca.pst_sk - ca.qst - ch.vat - cl.tin - es.cif - eu.vat - gb.vat - hk.br - id.nik - id.npwp - in.gst - jp.cn - jp.rn - kr.brn - li.uid - mx.curp - my.frp - my.itn - my.nric - my.sst - no.vat - nz.gst - ph.tin - ru.inn - ru.kpp - sa.vat - sg.gst - sg.uen - th.id - th.vat - tw.vat - us.ein - za.vat Error400BadRequest: title: Bad Request type: object description: Bad Request (HTTP 400). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: A short code that describes the reason for the error. example: bad_request enum: - bad_request - incorrect_json - invalid_credentials status: type: integer description: '`400`.' example: 400 enum: - 400 message: type: string description: A human-readable reason for the error. example: Missing '****' field details: type: array description: A list of detail objects that further clarify the reason for the error. items: $ref: '#/components/schemas/ErrorDetail' PaymentLink: title: Payment Link type: object x-tags: - PaymentLink properties: id: type: string format: uuid description: The ID of a payment link. example: 8d3fe99b-1422-42e6-bbb3-932d95ae5f79 type: type: string description: The type of this resource. Is always `payment_link`. example: payment_link enum: - payment_link amount: description: 'The monetary amount for this payment link, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`.' type: integer example: 1299 currency: type: string example: USD description: A supported ISO-4217 currency code. created_at: type: string description: The date and time when this payment link was created. format: date-time example: '2022-01-01T12:00:00+00:00' updated_at: type: string description: The date and time when this payment link was created. format: date-time example: '2022-01-01T12:00:00+00:00' expires_at: type: string description: The date and time when this payment link expires. format: date-time example: '2022-01-01T12:00:00+00:00' status: type: string example: active enum: - active - completed - expired - processing external_identifier: type: - string - 'null' description: A value that can be used to match the payment link against your own records. example: payment-link-123 minLength: 1 maxLength: 200 statement_descriptor: type: - object - 'null' allOf: - $ref: '#/components/schemas/StatementDescriptor' locale: type: - string - 'null' description: The locale used to translate text within the payment link. example: en enum: - en - en-GB - es - pt - pt-BR merchant_name: type: - string - 'null' description: The name of the merchant to display on the payment link. example: Gr4vy maxLength: 100 merchant_url: type: - string - 'null' description: The URL of the merchant to display on the payment link. example: https://gr4vy.com merchant_banner_url: type: - string - 'null' description: The URL of the merchant banner to display on the payment link. example: https://gr4vy.com/banner.png merchant_color: type: - string - 'null' description: The color code of the merchant to display on the payment link. example: '#FF0000' merchant_message: type: - string - 'null' description: The message to display on the payment link. example: Thank you for shopping with us! maxLength: 255 merchant_terms_and_conditions_url: type: - string - 'null' description: The URL of the merchant terms and conditions to display on the payment link. example: https://gr4vy.com/terms merchant_favicon_url: type: - string - 'null' description: The URL of the merchant favicon icon. example: https://gr4vy.com/favicon.png country: description: 'The 2-letter ISO code of the country of the transaction. This is used to filter the payment services that is used to process the transaction. ' example: US type: - string - 'null' intent: type: - string - 'null' description: The intent of the payment link. example: authorize enum: - authorize - capture return_url: type: - string - 'null' description: The URL to redirect the buyer to after payment. example: https://gr4vy.com/return cart_items: description: An array of cart items that represents the line items of a payment link. items: $ref: '#/components/schemas/CartItem' maxItems: 249 type: array metadata: additionalProperties: type: string description: 'Any additional information about the payment link that you would like to store as key-value pairs. This data is passed to payment service providers that support it.' example: key: value maxProperties: 20 type: - object - 'null' payment_source: type: - string - 'null' description: The source of the payment link. Defaults to `ecommerce`. example: recurring enum: - ecommerce - moto - recurring - installment - card_on_file buyer: type: - object - 'null' allOf: - $ref: '#/components/schemas/Buyer--Snapshot' description: The buyer used for this transaction. shipping_details: description: Shipping details for the payment link. allOf: - $ref: '#/components/schemas/ShippingDetail' type: - object - 'null' x-model-name: ShippingDetail WorldpayVapOptions: additionalProperties: false properties: reportGroup: anyOf: - type: string - type: 'null' default: null description: Overrides the default report group to pass to the Worldpay VAP API. title: Reportgroup orderId: anyOf: - maxLength: 256 type: string - type: 'null' default: null description: Overrides the `orderId` passed to the Worldpay VAP API, which defaults to the Gr4vy transaction ID. examples: - order-123 title: Orderid title: WorldpayVapOptions type: object WpayPaytoOptions: additionalProperties: false properties: instrument: anyOf: - $ref: '#/components/schemas/WpayPaytoResourceOptions' - type: 'null' default: null description: Options to pass to the `instrument` resource in the Wpay PayTo API. payment: anyOf: - $ref: '#/components/schemas/WpayPaytoResourceOptions' - type: 'null' default: null description: Options to pass to the `payment` resource in the Wpay PayTo API. refund: anyOf: - $ref: '#/components/schemas/WpayPaytoResourceOptions' - type: 'null' default: null description: Options to pass to the `refund` resource in the Wpay PayTo API. title: WpayPaytoOptions type: object CybersourceOptions: additionalProperties: false properties: meta_key_merchant_id: anyOf: - type: string - type: 'null' default: null description: The merchant ID to use for this transaction. This requires a meta key to be set up for use with Cybersource, and this overrides the connector configuration. examples: - merchant-1234 title: Meta Key Merchant Id merchant_defined_information: anyOf: - additionalProperties: type: string type: object - type: 'null' default: null description: A list of merchant defined data to be passed to the Cybersource. Each key needs to be a numeric string. examples: - '1': data title: Merchant Defined Information ship_to_method: anyOf: - type: string - type: 'null' default: null description: The shipping method for this transaction. examples: - sameday title: Ship To Method comments: anyOf: - type: string - type: 'null' default: null description: Brief description of the order or any comment you wish to add to the order. examples: - This order is for a new customer title: Comments title: CybersourceOptions type: object Error401: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `unauthorized` default: unauthorized examples: - unauthorized status: type: integer title: Status description: Always `401`. default: 401 examples: - 401 message: type: string title: Message description: A human readable message that provides more context to the error. default: No valid API authentication found examples: - No valid API authentication found details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error401 KlarnaOptions: additionalProperties: false properties: subscription: anyOf: - $ref: '#/components/schemas/KlarnaSubscriptionOptions' - type: 'null' default: null description: Provides subscription information to Klarna. token_only_mode: anyOf: - type: boolean - type: 'null' default: null description: When set to `true`, this will authorize the transaction with Klarna for the purposes of tokenizing the payment method with the transaction details. No funds will be captured and the authorization will be automatically voided. This is useful for up-sell scenarios where you want to tokenize a Klarna payment method for future use. examples: - true title: Token Only Mode authorization_token: anyOf: - type: string - type: 'null' default: null description: An authorization token returned by the Klarna Express Checkout JS SDK after the buyer completes payment in the embedded widget. When provided, the connector skips the HPP redirect and places the Klarna order directly using this token. examples: - '...' title: Authorization Token title: KlarnaOptions type: object ErrorLocation: type: string enum: - query - body - path - header - unknown title: ErrorLocation ForterAntiFraudOptionsDiscountCouponDiscountAmount: additionalProperties: false properties: amount_usd: anyOf: - type: string - type: 'null' default: null description: The discount amount in USD. title: Amount Usd amount_local_currency: anyOf: - type: string - type: 'null' default: null description: The discount amount in local currency. title: Amount Local Currency currency: anyOf: - examples: - EUR - GBP - USD pattern: ^[A-Z]{3}$ type: string - type: 'null' default: null description: The currency code for the discount amount. title: Currency title: ForterAntiFraudOptionsDiscountCouponDiscountAmount type: object ForterAntiFraudOptionsDiscount: additionalProperties: false properties: coupon_code_used: description: The coupon code applied to the order. title: Coupon Code Used type: string discount_type: description: The type of discount applied to the order. title: Discount Type type: string coupon_discount_amount: anyOf: - $ref: '#/components/schemas/ForterAntiFraudOptionsDiscountCouponDiscountAmount' - type: 'null' default: null description: Monetary details of the discount amount. coupon_discount_percent: anyOf: - type: string - type: 'null' default: null description: The percentage discount applied via the coupon. title: Coupon Discount Percent required: - coupon_code_used - discount_type title: ForterAntiFraudOptionsDiscount type: object MattildaTapiOptions: additionalProperties: false properties: payment_method_expires_at: anyOf: - type: string - type: 'null' default: null description: Defines the date at which the payment will expire if not completed. Must be provided in ISO 8601 format `(YYYY-MM-DD`). If not specified, it defaults to 7 days in the future from the current date. examples: - '2030-12-01' title: Payment Method Expires At title: MattildaTapiOptions type: object DlocalWalletOptions: additionalProperties: false properties: name: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.name` to the dLocal API for those connectors that need it. examples: - John Doe title: Name email: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.email` to the dLocal API for those connectors that need it. examples: - john@example.com title: Email token: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.token` to the dLocal API for those connectors that need it. examples: - '123456' title: Token username: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.username` to the dLocal API for those connectors that need it. examples: - johnd title: Username verify: anyOf: - type: boolean - type: 'null' default: null description: Passes `wallet.verify` to the dLocal API for those connectors that need it. examples: - true title: Verify title: DlocalWalletOptions type: object Error425: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `too_early` default: too_early examples: - too_early status: type: integer title: Status description: Always `425`. default: 425 examples: - 425 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error425 ForterAntiFraudOptionsCartItem: additionalProperties: false properties: basic_item_data: anyOf: - $ref: '#/components/schemas/ForterAntiFraudOptionsCartItemBasicItemData' - type: 'null' default: null description: Basic information about the cart item. delivery_details: anyOf: - $ref: '#/components/schemas/ForterAntiFraudOptionsCartItemDeliveryDetails' - type: 'null' default: null description: Details about how the item will be delivered. beneficiaries: anyOf: - items: $ref: '#/components/schemas/ForterAntiFraudOptionsCartItemBeneficiary' type: array - type: 'null' default: [] description: List of beneficiaries who will receive this item. title: Beneficiaries title: ForterAntiFraudOptionsCartItem type: object ForterAntiFraudOptionsCartItemBeneficiaryPersonalDetails: additionalProperties: false properties: first_name: anyOf: - type: string - type: 'null' default: null description: First name of the beneficiary. title: First Name last_name: anyOf: - type: string - type: 'null' default: null description: Last name of the beneficiary. title: Last Name email: anyOf: - type: string - type: 'null' default: null description: Email address of the beneficiary. title: Email title: ForterAntiFraudOptionsCartItemBeneficiaryPersonalDetails type: object ErrorDetail_2: properties: location: $ref: '#/components/schemas/ErrorLocation' description: The part of the request where the property can be found that caused the error. examples: - body pointer: anyOf: - type: string format: json-pointer - type: string title: Pointer description: A JSON pointer for the particular property that caused the error. examples: - /currency message: type: string title: Message description: A human-readdable explanation of the error. examples: - 'Unknown ISO 4217 currency code: USX' type: type: string title: Type description: The type of error that was raised for this property. examples: - value_error additionalProperties: false type: object required: - location - pointer - message - type title: ErrorDetail DlocalPIXOptions: additionalProperties: false properties: subscription: anyOf: - $ref: '#/components/schemas/DlocalPIXSubscriptionOptions' - type: 'null' default: null description: Passes `subscription` data to the dLocal API for those connectors that need it. scheduled_date: anyOf: - type: string - type: 'null' default: null description: Defines scheduled payment start date. Must be provided in ISO 8601 format `(YYYY-MM-DD`). If not specified, The default is 2 days in the future. examples: - '2030-12-01' title: Scheduled Date title: DlocalPIXOptions type: object NuveiPSEOptions: additionalProperties: false properties: userType: anyOf: - type: string - type: 'null' default: null description: Customer type ("N" for persona natural, "J" for persona jurídica) examples: - N title: Usertype userFisNumber: anyOf: - type: string - type: 'null' default: null description: Customer's document type examples: - CC title: Userfisnumber fiscalNumber: anyOf: - type: string - type: 'null' default: null description: Customer's document number examples: - CC title: Fiscalnumber bankCode: anyOf: - type: string - type: 'null' default: null description: The bank code of the selected bank examples: - '5432' title: Bankcode title: NuveiPSEOptions type: object BillingDetails_2: properties: first_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: First Name description: The first name(s) or given name for the buyer. examples: - John last_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Last Name description: The last name, or family name, of the buyer. examples: - Doe email_address: anyOf: - type: string maxLength: 320 minLength: 1 - type: 'null' title: Email Address description: The email address for the buyer. examples: - john@example.com phone_number: anyOf: - type: string pattern: ^\+[1-9]\d{1,14}$ examples: - '+14155552671' - '+442071838750' - type: 'null' title: Phone Number description: The phone number for the buyer which should be formatted according to the E164 number standard. examples: - '+1234567890' address: anyOf: - $ref: '#/components/schemas/Address_2' - type: 'null' description: The billing address for the buyer. tax_id: anyOf: - $ref: '#/components/schemas/TaxId_2' - type: 'null' description: The tax ID information associated with the billing details. additionalProperties: false type: object title: BillingDetails GivingBlockOptions: additionalProperties: false properties: defaultCryptocurrency: anyOf: - type: string - type: 'null' default: null description: The default cryptocurrency to present at checkout. This can be used to ensure the user is presented with the same currency in both your checkout and the Giving Block checkout. examples: - BTC title: Defaultcryptocurrency title: GivingBlockOptions type: object FiservInstallmentOptions: additionalProperties: false properties: numberOfInstallments: anyOf: - type: integer - type: 'null' default: null description: Passes the `order.installmentOptions.numberOfInstallments` field to the Fiserv API. examples: - 6 title: Numberofinstallments installmentsInterest: anyOf: - type: boolean - type: 'null' default: null description: Passes the `order.installmentOptions.installmentsInterest` field to the Fiserv API. examples: - true title: Installmentsinterest installmentDelayMonths: anyOf: - type: integer - type: 'null' default: null description: Passes the `order.installmentOptions.installmentDelayMonths` field to the Fiserv API. examples: - 1 title: Installmentdelaymonths merchantAdviceCodeSupported: anyOf: - type: boolean - type: 'null' default: null description: Passes the `order.installmentOptions.merchantAdviceCodeSupported` field to the Fiserv API. examples: - true title: Merchantadvicecodesupported title: FiservInstallmentOptions type: object PaypalShippingOptionsItem: additionalProperties: false properties: id: description: A unique ID that identifies a payer-selected shipping option. maxLength: 127 minLength: 1 title: Id type: string label: description: A description that the payer sees, which helps them choose an appropriate shipping option. examples: - Free Shipping - USPS Priority Shipping - Expédition prioritaire USPS - USPS yōuxiān fā huò maxLength: 127 minLength: 1 title: Label type: string selected: description: If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. Only one shipping.option can be set to selected=true. title: Selected type: boolean type: anyOf: - enum: - SHIPPING - PICKUP - PICKUP_IN_STORE - PICKUP_FROM_PERSON type: string - type: 'null' default: null description: A classification for the method of purchase fulfillment. examples: - SHIPPING - PICKUP - PICKUP_IN_STORE - PICKUP_FROM_PERSON title: Type amount: anyOf: - $ref: '#/components/schemas/PaypalShippingOptionsItemAmount' - type: 'null' default: null description: The shipping cost for the selected option. required: - id - label - selected title: PaypalShippingOptionsItem type: object ForterAntiFraudOptionsCartItemBeneficiaryComments: additionalProperties: false properties: user_comments_to_merchant: anyOf: - type: string - type: 'null' default: null description: Comments from the user to the merchant. title: User Comments To Merchant message_to_beneficiary: anyOf: - type: string - type: 'null' default: null description: Message intended for the beneficiary of the item. title: Message To Beneficiary merchant_comments: anyOf: - type: string - type: 'null' default: null description: Comments from the merchant about this transaction. title: Merchant Comments title: ForterAntiFraudOptionsCartItemBeneficiaryComments type: object Error400: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `bad_request` default: bad_request examples: - bad_request status: type: integer title: Status description: Always `400`. default: 400 examples: - 400 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error400 AdyenPixOptions: additionalProperties: false properties: additionalData: anyOf: - additionalProperties: type: string type: object - type: 'null' default: null description: Passes additional data to the Adyen API when creating a transaction. examples: - subMerchantID: '12345' title: Additionaldata pixRecurring: anyOf: - $ref: '#/components/schemas/AdyenPixRecurringOptions' - type: 'null' default: null description: Passes `pixRecurring` data to Adyen title: AdyenPixOptions type: object KlarnaSubscriptionOptions: additionalProperties: false properties: name: description: The name of the subscription product. The recommended format includes a subscription id and double curly brackets. examples: - Premium Membership {{{{12394832}}}} title: Name type: string interval: description: The cadence unit for the subscription plan. enum: - DAY - WEEK - MONTH - YEAR examples: - DAY - WEEK - MONTH - YEAR title: Interval type: string interval_count: description: The number corresponding to the interval unit. examples: - 1 - 2 - 3 title: Interval Count type: integer reference: description: Reference to a SKU in the transaction's cart items to link subscription to. examples: - a0366204-2365-45fd-af60-23d0a59fdea9 title: Reference type: string required: - name - interval - interval_count - reference title: KlarnaSubscriptionOptions type: object RepayBankOptions: additionalProperties: false properties: sec_code: anyOf: - enum: - WebDebit - TelDebit - PpdDebit type: string - type: 'null' default: null description: The Nacha Standard Entry Class code describing how the account holder authorized an ACH debit. When omitted, `TelDebit` is used for a `moto` payment source and `WebDebit` otherwise. Ignored for business accounts, which Repay requires to use `CcdDebit`. examples: - WebDebit title: Sec Code title: RepayBankOptions type: object Error502: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `bad_gateway` default: bad_gateway examples: - bad_gateway status: type: integer title: Status description: Always `502`. default: 502 examples: - 502 message: type: string title: Message description: A human readable message that provides more context to the error. default: Request could not be processed examples: - Request could not be processed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error502 ProductType: type: string enum: - physical - discount - shipping_fee - sales_tax - digital - gift_card - store_credit - surcharge title: ProductType DlocalUPIWalletOptions: additionalProperties: false properties: name: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.name` to the dLocal API for those connectors that need it. examples: - John Doe title: Name email: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.email` to the dLocal API for those connectors that need it. examples: - john@example.com title: Email token: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.token` to the dLocal API for those connectors that need it. examples: - '123456' title: Token username: anyOf: - type: string - type: 'null' default: null description: Passes `wallet.username` to the dLocal API for those connectors that need it. examples: - johnd title: Username verify: anyOf: - type: boolean - type: 'null' default: null description: Passes `wallet.verify` to the dLocal API for those connectors that need it. examples: - true title: Verify recurring_info: anyOf: - $ref: '#/components/schemas/DlocalUPIRecurringInfoOptions' - type: 'null' default: null description: Passes `wallet.recurring_info` to the dLocal API for those connectors that need it. examples: - subscription_end_at: '20241201' subscription_frequency: 1 subscription_frequency_unit: MONTH subscription_start_at: '20231201' title: DlocalUPIWalletOptions type: object AdyenPixRecurringOptions: additionalProperties: false properties: frequency: anyOf: - type: string - type: 'null' default: null description: 'The frequency at which the shopper will be charged. Possible values: weekly, monthly, quarterly, half-yearly, and yearly.' examples: - monthly title: Frequency recurringAmount: anyOf: - $ref: '#/components/schemas/AdyenPixRecurringAmount' - type: 'null' description: For a billing plan where the payment amount is fixed, the currency and value for each recurring payment startsAt: anyOf: - type: string - type: 'null' default: null description: Start date of the billing plan, in YYYY-MM-DD format. examples: - '2026-01-01' title: Startsat endsAt: anyOf: - type: string - type: 'null' default: null description: End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper. examples: - '2026-12-31' title: Endsat recurringStatement: anyOf: - type: string - type: 'null' default: null description: The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. examples: - My recurring subscription title: Recurringstatement required: - recurringAmount title: AdyenPixRecurringOptions type: object AdyenSplitsOptions: additionalProperties: false properties: authorization: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' default: null description: Split payment values to pass to the Adyen API on payment authorization. See [the Adyen docs](https://docs.adyen.com/platforms/online-payments/split-transactions/split-payments-at-authorization/) for details on the format and contents of the list. title: Authorization capture: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' default: null description: Split payment values to pass to the Adyen API on payment capture. See [the Adyen docs](https://docs.adyen.com/platforms/online-payments/split-transactions/split-payments-at-capture/) for details on the format and contents of the list. title: Capture refund: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' default: null description: Split payment values to pass to the Adyen API on payment refund. See [the Adyen docs](https://docs.adyen.com/platforms/online-payments/split-transactions/split-refunds/) for details on the format and contents of the list. title: Refund title: AdyenSplitsOptions type: object GuestBuyer: properties: display_name: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Display Name description: The display name for the buyer. examples: - John Doe external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant identifier for this buyer. examples: - buyer-12345 billing_details: anyOf: - $ref: '#/components/schemas/BillingDetails_2' - type: 'null' description: The billing name, address, email, and other fields for this buyer. account_number: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Account Number description: The buyer account number shipping_details: anyOf: - $ref: '#/components/schemas/ShippingDetailsCreate' - type: 'null' description: The optional shipping details for this buyer. additionalProperties: false type: object title: GuestBuyer PaymentLink_2: properties: id: type: string format: uuid title: Id description: The unique identifier for the payment link. examples: - a1b2c3d4-5678-90ab-cdef-1234567890ab type: type: string const: payment-link title: Type description: Always `payment-link`. default: payment-link examples: - payment-link url: type: string title: Url description: The URL for the payment link. examples: - https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At description: The expiration date and time for the payment link. examples: - '2024-06-01T00:00:00.000Z' external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant reference for the payment link. examples: - external-12345 statement_descriptor: anyOf: - $ref: '#/components/schemas/StatementDescriptor_2' - type: 'null' description: The statement descriptor for the payment link. locale: anyOf: - type: string - type: 'null' title: Locale description: The locale for the payment link. examples: - en - en-GB - pt - pt-BR - es merchant_name: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Merchant Name description: The merchant's display name. examples: - ACME Inc. merchant_url: anyOf: - type: string - type: 'null' title: Merchant Url description: The merchant's website URL. examples: - https://merchant.example.com merchant_banner_url: anyOf: - type: string - type: 'null' title: Merchant Banner Url description: The merchant's banner image URL. examples: - https://merchant.example.com/banner.png merchant_color: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Merchant Color description: The merchant's brand color. examples: - '#FF5733' merchant_message: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Merchant Message description: A message from the merchant. examples: - Thank you for your purchase! merchant_terms_and_conditions_url: anyOf: - type: string - type: 'null' title: Merchant Terms And Conditions Url description: URL to the merchant's terms and conditions. examples: - https://merchant.example.com/terms merchant_favicon_url: anyOf: - type: string - type: 'null' title: Merchant Favicon Url description: URL to the merchant's favicon. examples: - https://merchant.example.com/favicon.ico amount: type: integer maximum: 99999999.0 minimum: 0.0 title: Amount description: The amount for the payment link. examples: - 1299 country: type: string pattern: ^[A-Z]{2}$ title: Country description: The country code for the payment link. examples: - DE - GB - US currency: type: string pattern: ^[A-Z]{3}$ title: Currency description: The currency code for the payment link. examples: - EUR - GBP - USD intent: $ref: '#/components/schemas/TransactionIntent' description: The transaction intent for the payment link. examples: - authorize - capture return_url: anyOf: - type: string - type: 'null' title: Return Url description: The return URL after payment completion. examples: - https://merchant.example.com/return cart_items: anyOf: - items: $ref: '#/components/schemas/CartItem_2' type: array - type: 'null' title: Cart Items description: The cart items for the payment link. examples: - - amount: currency: USD value: 500 name: Widget quantity: 2 metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata description: Arbitrary metadata for the payment link. examples: - order_id: ORD-12345 payment_source: $ref: '#/components/schemas/TransactionPaymentSource' description: The payment source for the payment link. examples: - ecommerce created_at: type: string format: date-time title: Created At description: The date and time the payment link was created. examples: - '2024-05-30T12:34:56.000Z' updated_at: type: string format: date-time title: Updated At description: The date and time the payment link was last updated. examples: - '2024-05-30T13:00:00.000Z' status: $ref: '#/components/schemas/PaymentLinkStatus' description: The status of the payment link. examples: - active - expired - completed buyer: anyOf: - $ref: '#/components/schemas/TransactionBuyer' - type: 'null' description: The buyer associated with the payment link. shipping_details: anyOf: - $ref: '#/components/schemas/ShippingDetails' - type: 'null' description: The shipping details for the payment link. connection_options: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Connection Options description: The connection options for the payment link. store: type: boolean title: Store description: Whether the payment method was stored. default: false buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to associate with the stored payment method. examples: - a1b2c3d4-5678-90ab-cdef-1234567890ab installment_count: anyOf: - type: integer maximum: 100.0 minimum: 1.0 - type: 'null' title: Installment Count description: The number of installments a buyer is required to make. additionalProperties: false type: object required: - id - url - amount - country - currency - intent - cart_items - payment_source - created_at - updated_at - status title: PaymentLink DlocalUPIOptions: additionalProperties: false properties: wallet: anyOf: - $ref: '#/components/schemas/DlocalUPIWalletOptions' - type: 'null' default: null description: Passes `wallet` data to the dLocal API for those connectors that need it. title: DlocalUPIOptions type: object Error409: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `duplicate_record` default: duplicate_record examples: - duplicate_record status: type: integer title: Status description: Always `409`. default: 409 examples: - 409 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] resource_id: anyOf: - type: string - type: 'null' title: Resource Id description: The ID of the conflicting resource. examples: - cdc70639-cb9c-4222-a73f-b8ce39f7821b additionalProperties: false type: object title: Error409 RiskifiedAntiFraudOptions: additionalProperties: false properties: line_items: anyOf: - items: $ref: '#/components/schemas/RiskifiedAntiFraudOptionsLineItem' type: array - type: 'null' default: [] description: A list of line items details to override when passing to the Riskified API. title: Line Items title: RiskifiedAntiFraudOptions type: object TransactionPaymentSource: type: string enum: - ecommerce - moto - recurring - installment - card_on_file title: TransactionPaymentSource description: The way payment method information made it to this transaction. PaypalDirectOrderOptions: additionalProperties: false properties: order_id: description: The ID of an existing PayPal order that was already created and approved by the buyer entirely outside of Gr4vy. Gr4vy retrieves this order and authorizes (or captures) it directly, without creating an order of its own. examples: - 5O190127TN364715T title: Order Id type: string required: - order_id title: PaypalDirectOrderOptions type: object LatitudeOptions: additionalProperties: false properties: promotion_reference: anyOf: - maxLength: 128 type: string - type: 'null' default: null description: The `promotionReference` field passed to the purchase API. examples: - promotion-123 title: Promotion Reference title: LatitudeOptions type: object AdyenSepaOptions: additionalProperties: false properties: autoRescue: anyOf: - type: boolean - type: 'null' default: null description: Set to `true` to enable Auto Rescue for a transaction. Use the `maxDaysToRescue` to specify a rescue window. examples: - true title: Autorescue maxDaysToRescue: anyOf: - type: integer - type: 'null' default: null description: The rescue window for a transaction, in days, when `autoRescue` is set to `true`. You can specify a value between 1 and 48. For cards, the default is one calendar month. For SEPA, the default is 42 days. examples: - 20 title: Maxdaystorescue additionalData: anyOf: - additionalProperties: type: string type: object - type: 'null' default: null description: Passes additional data to the Adyen API when creating a transaction. examples: - subMerchantID: '12345' title: Additionaldata autoRescueSepaScenario: anyOf: - $ref: '#/components/schemas/AdyenAutoRescueSepaScenariosEnum' - type: 'null' default: null description: The rescue scenario to simulate for a transaction, when `autoRescue` is set to `true`. examples: - AutoRescueSuccessfulFirst ownerName: anyOf: - type: string - type: 'null' default: null description: The name on the SEPA bank account. examples: - A. Schneider title: Ownername title: AdyenSepaOptions type: object PaymentLinkCreate: properties: buyer: anyOf: - $ref: '#/components/schemas/GuestBuyer' - type: 'null' description: The guest buyer for the payment link. expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At description: The expiration date and time for the payment link. examples: - '2024-06-01T00:00:00.000Z' connection_options: anyOf: - $ref: '#/components/schemas/TransactionConnectionOptions' - type: 'null' title: Connection Options description: Connection options for the payment link. external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant reference for the payment link. examples: - external-12345 statement_descriptor: anyOf: - $ref: '#/components/schemas/StatementDescriptor_2' - type: 'null' description: The statement descriptor for the payment link. locale: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Locale description: The locale for the payment link. examples: - en - en-GB - pt - pt-BR - es merchant_name: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Merchant Name description: The merchant's display name. examples: - ACME Inc. merchant_url: anyOf: - type: string - type: 'null' title: Merchant Url description: The merchant's website URL. examples: - https://merchant.example.com merchant_banner_url: anyOf: - type: string - type: 'null' title: Merchant Banner Url description: The merchant's banner image URL. examples: - https://merchant.example.com/banner.png merchant_color: anyOf: - type: string format: color - type: 'null' title: Merchant Color description: The merchant's brand color. examples: - '#FF5733' merchant_message: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Merchant Message description: A message from the merchant. examples: - Thank you for your purchase! merchant_terms_and_conditions_url: anyOf: - type: string - type: 'null' title: Merchant Terms And Conditions Url description: URL to the merchant's terms and conditions. examples: - https://merchant.example.com/terms merchant_favicon_url: anyOf: - type: string - type: 'null' title: Merchant Favicon Url description: URL to the merchant's favicon. examples: - https://merchant.example.com/favicon.ico amount: type: integer maximum: 99999999.0 minimum: 0.0 title: Amount description: The amount for the payment link. examples: - 1299 country: type: string pattern: ^[A-Z]{2}$ title: Country description: The country code for the payment link. examples: - DE - GB - US currency: type: string pattern: ^[A-Z]{3}$ title: Currency description: The currency code for the payment link. examples: - EUR - GBP - USD intent: $ref: '#/components/schemas/TransactionIntent' description: The transaction intent for the payment link. default: authorize examples: - authorize - capture return_url: anyOf: - type: string - type: 'null' title: Return Url description: The return URL after payment completion. examples: - https://merchant.example.com/return cart_items: anyOf: - items: $ref: '#/components/schemas/CartItem_2' type: array - type: 'null' title: Cart Items description: The cart items for the payment link. metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata description: Arbitrary metadata for the payment link. examples: - order_id: ORD-12345 payment_source: $ref: '#/components/schemas/TransactionPaymentSource' description: The payment source for the payment link. default: ecommerce examples: - ecommerce store: type: boolean title: Store description: Whether to store the payment method for future use. default: false examples: - true buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: 'The ID of the buyer to associate the payment method with. Note: When `buyer_id` is provided, the payment link should be treated as a secret as it will allow the user to manage payment methods for the associated buyer.' examples: - a1b2c3d4-5678-90ab-cdef-1234567890ab installment_count: anyOf: - type: integer maximum: 100.0 minimum: 1.0 - type: 'null' title: Installment Count description: The number of installments a buyer is required to make. additionalProperties: false type: object required: - amount - country - currency title: PaymentLinkCreate ForterAntiFraudOptionsCartItemDeliveryDetails: additionalProperties: false properties: delivery_type: anyOf: - enum: - DIGITAL - PHYSICAL - HYBRID type: string - type: 'null' default: null description: The type of delivery for this cart item. title: Delivery Type delivery_method: anyOf: - type: string - type: 'null' default: null description: The method of delivery for this cart item. title: Delivery Method title: ForterAntiFraudOptionsCartItemDeliveryDetails type: object DlocalUPIRecurringInfoOptions: additionalProperties: false properties: subscription_frequency_unit: description: 'Indicates the frequency unit for the subscription. Allowed values are: `DAY`, `WEEK`, `MONTH`, `BI_MONTHLY`, `QUARTER`, `SEMI_ANNUALLY`, `YEAR`, `ONDEMAND`.' enum: - MONTH - WEEK - BI_MONTHLY - ONDEMAND - QUARTER - YEAR - SEMI_ANNUALLY - DAY examples: - MONTH title: Subscription Frequency Unit type: string subscription_frequency: description: Indicates the frequency for the subscription. examples: - 1 title: Subscription Frequency type: integer subscription_start_at: description: Indicates the start date for the subscription in format `YYYYMMDD`. examples: - '20231201' title: Subscription Start At type: string subscription_end_at: description: Indicates the end date for the subscription in format `YYYYMMDD`. examples: - '20241201' title: Subscription End At type: string required: - subscription_frequency_unit - subscription_frequency - subscription_start_at - subscription_end_at title: DlocalUPIRecurringInfoOptions type: object EcommpayOptions: additionalProperties: false properties: booking_start_date: anyOf: - type: string - type: 'null' default: null description: The start date of the booking in ISO 8601 format (YYYY-MM-DD). Required for certain MCCs. examples: - '2030-12-01' title: Booking Start Date booking_end_date: anyOf: - type: string - type: 'null' default: null description: The end date of the booking in ISO 8601 format (YYYY-MM-DD). Required for certain MCCs. examples: - '2030-12-10' title: Booking End Date title: EcommpayOptions type: object AdyenCardAutoRescueScenariosEnum: enum: - AutoRescueSuccessfulFirst - AutoRescueSuccessfulSecond - AutoRescueFailed - AutoRescueFraud title: AdyenCardAutoRescueScenariosEnum type: string AdyenOptions: additionalProperties: false properties: additionalData: anyOf: - additionalProperties: type: string type: object - type: 'null' default: null description: Passes additional data to the Adyen API when creating a transaction. examples: - subMerchantID: '12345' title: Additionaldata title: AdyenOptions type: object ForterAntiFraudOptionsCartItemBasicItemData: additionalProperties: false properties: type: anyOf: - enum: - TANGIBLE - NON_TANGIBLE type: string - type: 'null' default: null description: Indicates whether the item is a physical good or a service/digital item. title: Type title: ForterAntiFraudOptionsCartItemBasicItemData type: object RiskifiedAntiFraudOptionsLineItem: additionalProperties: false properties: delivered_to: anyOf: - enum: - shipping_address - store_pickup type: string - type: 'null' default: null description: Indicates whether the item will be shipped or picked up. title: Delivered To title: RiskifiedAntiFraudOptionsLineItem type: object TrustlyOptions: additionalProperties: false properties: refreshSplitToken: anyOf: - type: boolean - type: 'null' default: null description: Indicates to Gr4vy whether or not the stored Trustly agreement needs refreshing. examples: - true title: Refreshsplittoken title: TrustlyOptions type: object StripeOptions: additionalProperties: false properties: stripe_connect: anyOf: - $ref: '#/components/schemas/StripeConnectOptions' - type: 'null' default: null description: Stripe options to support Stripe Connect title: StripeOptions type: object WpayPaytoResourceOptions: additionalProperties: false properties: simulation: anyOf: - $ref: '#/components/schemas/WpayPaytoSimulationOptions' - type: 'null' default: null description: Simulate responses for this resource. title: WpayPaytoResourceOptions type: object AccountUpdaterOptions: additionalProperties: false properties: response_code: anyOf: - const: updated type: string - type: 'null' default: null description: The type of response to simulate. examples: - updated title: Response Code account_number: anyOf: - maxLength: 18 minLength: 12 type: string - type: 'null' default: null description: When the `response_code` is set to `updated`, the payment method's account number will be updated to this value. examples: - '4242424242424242' title: Account Number expiration_month: anyOf: - maxLength: 2 minLength: 2 type: string - type: 'null' default: null description: When the `response_code` is set to `updated`, the payment method's expiration month will be updated to this value. examples: - '12' title: Expiration Month expiration_year: anyOf: - maxLength: 4 minLength: 4 type: string - type: 'null' default: null description: When the `response_code` is set to `updated`, the payment method's expiration year will be updated to this value. examples: - '2030' title: Expiration Year error_code: anyOf: - type: string - type: 'null' default: null description: The type of error code to simulate. examples: - error title: Error Code title: AccountUpdaterOptions type: object StatementDescriptor_2: properties: name: anyOf: - type: string maxLength: 22 minLength: 5 - type: 'null' title: Name description: Reflects your doing business as (DBA) name. examples: - ACME description: anyOf: - type: string maxLength: 22 minLength: 5 - type: 'null' title: Description description: A short description about the purchase. examples: - ACME San Jose Electronics city: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: City description: The merchant's city to be displayed in a statement descriptor. examples: - San Jose country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Country description: The 2-letter ISO country code of the merchant to be displayed in a statement descriptor. examples: - US phone_number: anyOf: - type: string pattern: ^\+[1-9]\d{1,14}$ examples: - '+14155552671' - '+442071838750' - type: 'null' title: Phone Number description: The value in the phone number field of a customer's statement which should be formatted according to the E164 number standard. examples: - '+1234567890' url: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Url description: The merchant's URL to be displayed in a statement descriptor. examples: - www.example.com postal_code: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Postal Code description: The merchant's postal code or zip code. examples: - '94560' additionalProperties: false type: object title: StatementDescriptor description: Information to show the user on their payments statement Error405: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `method_not_allowed` default: method_not_allowed examples: - method_not_allowed status: type: integer title: Status description: Always `405`. default: 405 examples: - 405 message: type: string title: Message description: A human readable message that provides more context to the error. default: Method Not Allowed examples: - Method Not Allowed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error405 TravelhubOptions: additionalProperties: false properties: customData: anyOf: - items: $ref: '#/components/schemas/TravelHubCustomData' type: array - type: 'null' default: null description: A list of `customData` to pass to the TravelHub API. title: Customdata companyName: anyOf: - type: string - type: 'null' default: null description: Customer company name to pass to the TravelHub API. title: Companyname title: TravelhubOptions type: object DlocalPIXSubscriptionAmountOptions: additionalProperties: false properties: type: description: 'Indicates the amount type unit for the subscription. Allowed values are: `FIXED`, `VARIABLE`.' enum: - FIXED - VARIABLE examples: - FIXED title: Type type: string value: anyOf: - type: string - type: 'null' default: null description: Fixed subscription amount in local currency. Required only for fixed amount subscriptions depending on the payment method. examples: - '10.00' title: Value min_value: anyOf: - type: string - type: 'null' description: Minimum payer enrollment limit, not minimum recurring charge amount. examples: - '10.00' title: Min Value required: - type - min_value title: DlocalPIXSubscriptionAmountOptions type: object TaxId_2: properties: value: type: string maxLength: 50 minLength: 1 title: Value description: The tax ID for the buyer. examples: - '12345678931' kind: $ref: '#/components/schemas/TaxIdKind' description: The kind of tax ID examples: - us.ein additionalProperties: false type: object required: - value - kind title: TaxId AffirmItineraryOptions: additionalProperties: false properties: type: anyOf: - type: string - type: 'null' default: null description: The type of itinerary object. examples: - flight title: Type sku: anyOf: - type: string - type: 'null' default: null description: The booking/itinerary number (if applicable). examples: - ABC123 title: Sku display_name: anyOf: - type: string - type: 'null' default: null description: Readable description of the itinerary item. examples: - MIA-DCA-2019-12-11T12:07 title: Display Name venue: anyOf: - type: string - type: 'null' default: null description: The name of the venue where the event is hosted. examples: - Petco Park title: Venue location: anyOf: - type: string - type: 'null' default: null description: The address object that can be parsed. examples: - 925 Collins Avenue, Miami Beach, FL, 33140, US title: Location date_start: anyOf: - type: string - type: 'null' default: null description: The start date of this itinerary item. examples: - '2019-12-05' title: Date Start management: anyOf: - type: string - type: 'null' default: null description: The corporation. examples: - Marriott title: Management title: AffirmItineraryOptions type: object BraintreeDynamicDataFieldsOptions: additionalProperties: false properties: three_ds_auth_status: anyOf: - type: string - type: 'null' default: null description: Passes the 3DS status to the Braintree API using `customFields` with the key set to the value of `three_ds_auth_status` examples: - threeDStatus title: Three Ds Auth Status purchase_order_number: anyOf: - type: string - type: 'null' default: null description: Passes the `transaction.purchaseOrderNumber` field when creating a new transaction. examples: - po-12345 title: Purchase Order Number vault_payment_method_criteria: anyOf: - enum: - ALWAYS - ON_SUCCESSFUL_TRANSACTION type: string - type: 'null' default: null description: Passes the `vaultPaymentMethodCriteria` field when creating a new transaction. examples: - ON_SUCCESSFUL_TRANSACTION title: Vault Payment Method Criteria title: BraintreeDynamicDataFieldsOptions type: object TransactionConnectionOptions: additionalProperties: false properties: account-updater: anyOf: - $ref: '#/components/schemas/AccountUpdaterOptions' - type: 'null' default: null description: Custom options to be passed to the `account-updater` connector, allowing for simulating different account updater responses. adyen-ach: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-ach` connector. adyen-afterpay: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-afterpay` connector. adyen-cashappafterpay: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-cashappafterpay` connector. adyen-alipay: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-alipay` connector. adyen-card: anyOf: - $ref: '#/components/schemas/AdyenCardOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-card` connector. adyen-cashapp: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-cashapp` connector. adyen-gcash: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-gcash` connector. adyen-giropay: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-giropay` connector. adyen-ideal: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-ideal` connector. adyen-konbini: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-konbini` connector. adyen-paybybank: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-paybybank` connector. adyen-paypay: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-paypay` connector. adyen-pix: anyOf: - $ref: '#/components/schemas/AdyenPixOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-pix` connector. adyen-sepa: anyOf: - $ref: '#/components/schemas/AdyenSepaOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-sepa` connector. adyen-seveneleven: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-seveneleven` connector. adyen-sofort: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-sofort` connector. adyen-swish: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-swish` connector. adyen-vipps: anyOf: - $ref: '#/components/schemas/AdyenOptions' - type: 'null' default: null description: Custom options to be passed to the `adyen-vipps` connector. affirm-affirm: anyOf: - $ref: '#/components/schemas/AffirmOptions' - type: 'null' default: null description: Custom options to be passed to the `affirm-affirm` connector. braintree-card: anyOf: - $ref: '#/components/schemas/BraintreeOptions' - type: 'null' default: null description: Custom options to be passed to the `braintree-card` connector. chaseorbital-card: anyOf: - $ref: '#/components/schemas/ChaseOptions' - type: 'null' default: null description: Custom options to be passed to the `chaseorbital-card` connector. cybersource-anti-fraud: anyOf: - $ref: '#/components/schemas/CybersourceAntiFraudOptions' - type: 'null' default: null description: Custom options to be passed to the `cybersource-anti-fraud` connector. cybersource-card: anyOf: - $ref: '#/components/schemas/CybersourceOptions' - type: 'null' default: null description: Custom options to be passed to the `cybersource-card` connector. cybersource-ideal: anyOf: - $ref: '#/components/schemas/CybersourceOptions' - type: 'null' default: null description: Custom options to be passed to the `cybersource-ideal` connector. cybersource-kcp: anyOf: - $ref: '#/components/schemas/CybersourceOptions' - type: 'null' default: null description: Custom options to be passed to the `cybersource-kcp` connector. dlocal-card: anyOf: - $ref: '#/components/schemas/DlocalCardOptions' - type: 'null' default: null description: Custom options to be passed to the `dlocal-card` connector. dlocal-nequi: anyOf: - $ref: '#/components/schemas/DlocalOptions' - type: 'null' default: null description: Custom options to be passed to the `dlocal-nequi` connector. dlocal-upi: anyOf: - $ref: '#/components/schemas/DlocalUPIOptions' - type: 'null' default: null description: Custom options to be passed to the `dlocal-upi` connector. dlocal-pix: anyOf: - $ref: '#/components/schemas/DlocalPIXOptions' - type: 'null' default: null description: Custom options to be passed to the `dlocal-pix` connector. dlocal-gcash: anyOf: - $ref: '#/components/schemas/DlocalOptions' - type: 'null' default: null description: Custom options to be passed to the `dlocal-gcash` connector. ecommpay-card: anyOf: - $ref: '#/components/schemas/EcommpayOptions' - type: 'null' default: null description: Custom options to be passed to the `ecommpay-card` connector. klarna-klarna: anyOf: - $ref: '#/components/schemas/KlarnaOptions' - type: 'null' default: null description: Custom options to be passed to the `klarna-klarna` connector. fiserv-card: anyOf: - $ref: '#/components/schemas/FiservOptions' - type: 'null' default: null description: Custom options to be passed to the `fiserv-card` connector. forter-anti-fraud: anyOf: - $ref: '#/components/schemas/ForterAntiFraudOptions' - type: 'null' default: null description: Custom options to be passed to the `forter-anti-fraud` connector. gem-gem: anyOf: - $ref: '#/components/schemas/LatitudeOptions' - type: 'null' default: null description: Custom options to be passed to the `gem-gem` connector. gem-gemds: anyOf: - $ref: '#/components/schemas/LatitudeOptions' - type: 'null' default: null description: Custom options to be passed to the `gem-gemds` connector. givingblock-givingblock: anyOf: - $ref: '#/components/schemas/GivingBlockOptions' - type: 'null' default: null description: Custom options to be passed to the `givingblock-givingblock` connector. gocardless-gocardless: anyOf: - $ref: '#/components/schemas/GoCardlessOptions' - type: 'null' default: null description: Custom options to be passed to the `gocardless-gocardless` connector. latitude-latitude: anyOf: - $ref: '#/components/schemas/LatitudeOptions' - type: 'null' default: null description: Custom options to be passed to the `latitude-latitude` connector. latitude-latitudeds: anyOf: - $ref: '#/components/schemas/LatitudeOptions' - type: 'null' default: null description: Custom options to be passed to the `latitude-latitudeds` connector. mattilda-tapi: anyOf: - $ref: '#/components/schemas/MattildaTapiOptions' - type: 'null' default: null description: Custom options to be passed to the `mattilda-tapi` connector. mattilda-tapifintechs: anyOf: - $ref: '#/components/schemas/MattildaTapiOptions' - type: 'null' default: null description: Custom options to be passed to the `mattilda-tapifintechs` connector. monato-spei: anyOf: - $ref: '#/components/schemas/MonatoSpeiOptions' - type: 'null' default: null description: Custom options to be passed to the `monato-spei` connector. mock-card: anyOf: - $ref: '#/components/schemas/MockCardOptions' - type: 'null' default: null description: Custom options to be passed to the `mock-card` connector. mockds-card: anyOf: - $ref: '#/components/schemas/MockCardOptions' - type: 'null' default: null description: Custom options to be passed to the `mockds-card` connector. nuvei-card: anyOf: - $ref: '#/components/schemas/NuveiOptions' - type: 'null' default: null description: Custom options to be passed to the `nuvei-card` connector. nuvei-ideal: anyOf: - $ref: '#/components/schemas/NuveiIDealOptions' - type: 'null' default: null description: Custom options to be passed to the `nuvei-ideal` connector. nuvei-klarna: anyOf: - $ref: '#/components/schemas/NuveiKlarnaOptions' - type: 'null' default: null description: Custom options to be passed to the `nuvei-klarna` connector. nuvei-pse: anyOf: - $ref: '#/components/schemas/NuveiPSEOptions' - type: 'null' default: null description: Custom options to be passed to the `nuvei-pse` connector. oxxo-oxxo: anyOf: - $ref: '#/components/schemas/OxxoOptions' - type: 'null' default: null description: Custom options to be passed to the `oxxo-oxxo` connector. paypal-paypal: anyOf: - $ref: '#/components/schemas/PaypalOptions' - type: 'null' default: null description: Custom options to be passed to the `paypal-paypal` connector. paypal-paypaldirectorder: anyOf: - $ref: '#/components/schemas/PaypalDirectOrderOptions' - type: 'null' default: null description: Custom options to be passed to the `paypal-paypaldirectorder` connector. paypal-paypalpaylater: anyOf: - $ref: '#/components/schemas/PaypalOptions' - type: 'null' default: null description: Custom options to be passed to the `paypal-paypalpaylater` connector. powertranz-card: anyOf: - $ref: '#/components/schemas/PowertranzOptions' - type: 'null' default: null description: Custom options to be passed to the `powertranz-card` connector. repay-bank: anyOf: - $ref: '#/components/schemas/RepayBankOptions' - type: 'null' default: null description: Custom options to be passed to the `repay-bank` connector. riskified-anti-fraud: anyOf: - $ref: '#/components/schemas/RiskifiedAntiFraudOptions' - type: 'null' default: null description: Custom options to be passed to the `riskified-anti-fraud` connector. stripe-affirm: anyOf: - $ref: '#/components/schemas/StripeOptions' - type: 'null' default: null description: Custom options to be passed to the `stripe-affirm` connector. stripe-card: anyOf: - $ref: '#/components/schemas/StripeCardOptions' - type: 'null' default: null description: Custom options to be passed to the `stripe-card` connector. stripe-klarna: anyOf: - $ref: '#/components/schemas/StripeOptions' - type: 'null' default: null description: Custom options to be passed to the `stripe-klarna` connector. stripe-onelink: anyOf: - $ref: '#/components/schemas/StripeOptions' - type: 'null' default: null description: Custom options to be passed to the `stripe-onelink` connector. stripe-stripe: anyOf: - $ref: '#/components/schemas/StripeOptions' - type: 'null' default: null description: Custom options to be passed to the `stripe-stripe` connector. travelhub-card: anyOf: - $ref: '#/components/schemas/TravelhubOptions' - type: 'null' default: null description: Custom options to be passed to the `travelhub-card` connector. trustly-trustly: anyOf: - $ref: '#/components/schemas/TrustlyOptions' - type: 'null' default: null description: Custom options to be passed to the `trustly-trustly` connector. worldpayvap-card: anyOf: - $ref: '#/components/schemas/WorldpayVapOptions' - type: 'null' default: null description: Custom options to be passed to the `worldpayvap-card` connector. wpay-everydaypay: anyOf: - $ref: '#/components/schemas/WpayEverdaypayOptions' - type: 'null' default: null description: Custom options to be passed to the `wpay-everydaypay` connector. wpay-payto: anyOf: - $ref: '#/components/schemas/WpayPaytoOptions' - type: 'null' default: null description: Custom options to be passed to the `wpay-payto` connector. title: TransactionConnectionOptions type: object Address_2: properties: city: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: City description: The city for the address. examples: - San Jose country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Country description: The country for the address in ISO 3166 format. examples: - US postal_code: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Postal Code description: The postal code or zip code for the address. examples: - '94560' state: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: State description: The state, county, or province for the address. examples: - California state_code: anyOf: - type: string pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$ examples: - GB-LND - US-CA - type: 'null' title: State Code description: The code of state, county, or province for the address in ISO 3166-2 format. examples: - US-CA house_number_or_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: House Number Or Name description: The house number or name for the address. Not all payment services use this field but some do. examples: - '10' line1: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Line1 description: The first line of the address. examples: - Stafford Appartments line2: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Line2 description: The second line of the address. examples: - 29th Street organization: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Organization description: The optional name of the company or organisation to add to the address. examples: - Gr4vy additionalProperties: false type: object title: Address ForterAntiFraudOptionsCartItemBeneficiaryPhone: additionalProperties: false properties: phone: description: The phone number of the beneficiary. title: Phone type: string required: - phone title: ForterAntiFraudOptionsCartItemBeneficiaryPhone type: object PaymentLinks_2: properties: items: items: $ref: '#/components/schemas/PaymentLink_2' type: array title: Items description: A list of items returned for this request. limit: type: integer maximum: 100.0 minimum: 1.0 title: Limit description: The number of items for this page. default: 20 examples: - 20 next_cursor: anyOf: - type: string maxLength: 1000 minLength: 1 - type: 'null' title: Next Cursor description: The cursor pointing at the next page of items. examples: - ZXhhbXBsZTE previous_cursor: anyOf: - type: string maxLength: 1000 minLength: 1 - type: 'null' title: Previous Cursor description: The cursor pointing at the previous page of items. examples: - Xkjss7asS additionalProperties: false type: object required: - items title: PaymentLinks Error403: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `forbidden` default: forbidden examples: - forbidden status: type: integer title: Status description: Always `403`. default: 403 examples: - 403 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error403 CartItem_2: properties: name: type: string maxLength: 255 minLength: 1 title: Name description: The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters. examples: - GoPro HD quantity: type: integer maximum: 99999999.0 exclusiveMinimum: 0.0 title: Quantity description: The quantity of this item in the cart. This value cannot be negative or zero. examples: - 2 unit_amount: type: integer maximum: 99999999.0 minimum: 0.0 title: Unit Amount description: The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item. examples: - 1299 discount_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Discount Amount description: The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. default: 0 examples: - 0 tax_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Tax Amount description: The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` USD cents represents `$12.99`. default: 0 examples: - 0 external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: An external identifier for the cart item. This can be set to any value and is not sent to the payment service. examples: - goprohd sku: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Sku description: The SKU or product code for the item. examples: - GPHD1078 upc: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Upc description: The UPC for the item. examples: - 012345678905 product_url: anyOf: - type: string - type: 'null' title: Product Url description: The product URL for the item. examples: - https://example.com/catalog/go-pro-hd image_url: anyOf: - type: string - type: 'null' title: Image Url description: The URL for the image of the item. examples: - https://example.com/images/go-pro-hd.jpg categories: anyOf: - items: type: string maxLength: 50 minLength: 1 type: array - type: 'null' title: Categories description: A list of strings containing product categories for the item. examples: - - camera - travel - gear subcategories: anyOf: - items: type: string maxLength: 50 minLength: 1 type: array - type: 'null' title: Subcategories description: A list of strings containing product subcategories for the item. examples: - - action-cameras brand: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Brand description: The brand of the item. examples: - GoPro product_type: anyOf: - $ref: '#/components/schemas/ProductType' - type: 'null' description: The product type of the cart item. examples: - physical seller_country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Seller Country description: The seller country of the cart item. examples: - US - GB tax_exempt: anyOf: - type: boolean - type: 'null' title: Tax Exempt description: Whether the item is exempt of tax. examples: - false unit_of_measure: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Unit Of Measure description: The unit of measure or the unit of measure code. examples: - feet - kg commodity_code: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Commodity Code description: Item commodity code. Generally a UNSPSC code. examples: - '43211503' - '84111502' description: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Description description: Brief item description. examples: - A brief description of an interesting item. duty_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Duty Amount description: Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99` examples: - 1299 shipping_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Shipping Amount description: Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99` examples: - 1299 additionalProperties: false type: object required: - name - quantity - unit_amount title: CartItem AdyenAutoRescueSepaScenariosEnum: enum: - AutoRescueSuccessfulFirst - AutoRescueSuccessfulSecond - AutoRescueFailed title: AdyenAutoRescueSepaScenariosEnum type: string FiservOptions: additionalProperties: false properties: installmentOptions: anyOf: - $ref: '#/components/schemas/FiservInstallmentOptions' - type: 'null' default: null description: Passes installment data to the Fiserv API. This is now also a dedicated feature on the Gr4vy API. title: FiservOptions type: object ForterAntiFraudOptionsCartItemBeneficiary: additionalProperties: false properties: personal_details: $ref: '#/components/schemas/ForterAntiFraudOptionsCartItemBeneficiaryPersonalDetails' description: Personal details of the beneficiary. address: anyOf: - $ref: '#/components/schemas/ForterAntiFraudOptionsCartItemBeneficiaryAddress' - type: 'null' default: null description: Address information of the beneficiary. phone: anyOf: - items: $ref: '#/components/schemas/ForterAntiFraudOptionsCartItemBeneficiaryPhone' type: array - type: 'null' default: [] description: Phone numbers associated with the beneficiary. title: Phone comments: anyOf: - $ref: '#/components/schemas/ForterAntiFraudOptionsCartItemBeneficiaryComments' - type: 'null' default: null description: Comments related to the beneficiary. required: - personal_details title: ForterAntiFraudOptionsCartItemBeneficiary type: object AdyenCardOptions: additionalProperties: false properties: autoRescue: anyOf: - type: boolean - type: 'null' default: null description: Set to `true` to enable Auto Rescue for a transaction. Use the `maxDaysToRescue` to specify a rescue window. examples: - true title: Autorescue maxDaysToRescue: anyOf: - type: integer - type: 'null' default: null description: The rescue window for a transaction, in days, when `autoRescue` is set to `true`. You can specify a value between 1 and 48. For cards, the default is one calendar month. For SEPA, the default is 42 days. examples: - 20 title: Maxdaystorescue additionalData: anyOf: - additionalProperties: type: string type: object - type: 'null' default: null description: Passes additional data to the Adyen API when creating a transaction. examples: - subMerchantID: '12345' title: Additionaldata autoRescueScenario: anyOf: - $ref: '#/components/schemas/AdyenCardAutoRescueScenariosEnum' - type: 'null' default: null description: The rescue scenario to simulate for a transaction, when `autoRescue` is set to `true`. examples: - AutoRescueSuccessfulFirst window_origin: anyOf: - type: string - type: 'null' default: null description: The origin of the window where the payment is initiated, used for 3D Secure authentication. examples: - https://example.com title: Window Origin splits: anyOf: - $ref: '#/components/schemas/AdyenSplitsOptions' - type: 'null' default: null description: Passes information of splitting payment amounts to the Adyen API. merchantRiskIndicator: anyOf: - additionalProperties: true type: object - type: 'null' default: null description: Passes `merchantRiskIndicator` data to Adyen. title: Merchantriskindicator accountInfo: anyOf: - additionalProperties: true type: object - type: 'null' default: null description: Passes `accountInfo` data to Adyen. title: Accountinfo riskData: anyOf: - additionalProperties: true type: object - type: 'null' default: null description: Passes `riskData.customFields` to Adyen. title: Riskdata threeDSRequestorChallengeInd: anyOf: - type: string - type: 'null' default: null description: Passes `threeDS2RequestData.threeDSRequestorChallengeInd` to Adyen. title: Threedsrequestorchallengeind attemptAuthentication: anyOf: - type: string - type: 'null' default: null description: Passes `authenticationData.attemptAuthentication` to Adyen. title: Attemptauthentication title: AdyenCardOptions type: object Error404: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `not_found` default: not_found examples: - not_found status: type: integer title: Status description: Always `404`. default: 404 examples: - 404 message: type: string title: Message description: A human readable message that provides more context to the error. default: The resource could not be found examples: - The resource could not be found details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error404 StripeCardOptions: additionalProperties: false properties: stripe_connect: anyOf: - $ref: '#/components/schemas/StripeConnectOptions' - type: 'null' default: null description: Stripe options to support Stripe Connect customer_id: anyOf: - type: string - type: 'null' default: null description: A Stripe customer ID (`cus_xxx`) to associate with the PaymentIntent for network token transactions. When provided, Stripe Radar can access the customer's payment history, dispute rate, and account age to improve risk scoring for returning customers. examples: - cus_UgwySgjyKWrN5o title: Customer Id error_on_requires_action: anyOf: - type: boolean - type: 'null' default: null description: Passes the `error_on_requires_action` option to the Stripe API. Set to true to fail the payment attempt if it transitions into requires_action. Use this parameter for simpler integrations that don't handle customer actions, such as saving cards without authentication. examples: - true title: Error On Requires Action title: StripeCardOptions type: object PaymentLinkStatus: type: string enum: - active - completed - expired - processing title: PaymentLinkStatus OxxoOptions: additionalProperties: false properties: payment_method_expires_at: anyOf: - type: integer - type: 'null' default: null description: Defines a custom expiration time (unix time) after which Oxxo payment requests are cancelled examples: - 1750074293 title: Payment Method Expires At approval_url: anyOf: - type: string - type: 'null' default: null description: Approval URL that will receive a charge payment method reference. examples: - https://example.com title: Approval Url title: OxxoOptions type: object TravelHubCustomData: additionalProperties: false properties: name: description: The key of the custom data field. examples: - user_id title: Name type: string value: description: The value of the custom data field. examples: - user-123 title: Value type: string type: anyOf: - type: string - type: 'null' default: null description: The type of the custom data field. title: Type required: - name - value title: TravelHubCustomData type: object PowertranzOptions: additionalProperties: false properties: skipThreeDSecure: anyOf: - type: boolean - type: 'null' default: false description: Indicates to PowerTranz whether to skip the 3DS authentication for this transaction. examples: - true title: Skipthreedsecure title: PowertranzOptions type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PaypalShippingOptions: additionalProperties: false properties: options: anyOf: - items: $ref: '#/components/schemas/PaypalShippingOptionsItem' maxItems: 10 type: array - type: 'null' default: null description: Shipping options that the payee or merchant offers to the payer to ship or pick up their items. title: Options title: PaypalShippingOptions type: object ChaseOptions: additionalProperties: false properties: comments: anyOf: - type: string - type: 'null' default: null description: Custom order comment title: Comments title: ChaseOptions type: object WpayEverdaypayOptions: additionalProperties: false properties: merchant_defined_data: anyOf: - additionalProperties: type: string type: object - type: 'null' default: null description: A dictionary of merchant defined data, to be passed to Wpay for anti-fraud control. title: Merchant Defined Data customerId: anyOf: - type: string - type: 'null' default: null description: The customer ID for the Everyday Rewards account. title: Customerid rewardsAccessToken: anyOf: - type: string - type: 'null' default: null description: The access token for the Everyday Rewards account. title: Rewardsaccesstoken deviceId: anyOf: - type: string - type: 'null' default: null description: The ID of the device on which the payment is occuring. title: Deviceid postPaymentRedirect: anyOf: - type: boolean - type: 'null' default: null description: Whether the transaction should redirect post-payment examples: - true title: Postpaymentredirect title: WpayEverdaypayOptions type: object MockCardOptions: additionalProperties: false properties: merchant_advice_code: anyOf: - $ref: '#/components/schemas/MockCardMerchantAdviceCodeOptions' - type: 'null' default: null description: Allows for mocking the merchant advice code. skip_retry: anyOf: - type: boolean - type: 'null' default: null description: When set to true, prevents retries on failed transactions. title: Skip Retry title: MockCardOptions type: object Error500: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `server_error` default: server_error examples: - server_error status: type: integer title: Status description: Always `500`. default: 500 examples: - 500 message: type: string title: Message description: A human readable message that provides more context to the error. default: Request could not be processed examples: - Request could not be processed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error500 Error504: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `gateway_timeout` default: gateway_timeout examples: - gateway_timeout status: type: integer title: Status default: 504 message: type: string title: Message description: A human readable message that provides more context to the error. default: Request could not be processed examples: - Request could not be processed details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error504 DlocalCardOptions: additionalProperties: false properties: three_dsecure_force: anyOf: - type: boolean - type: 'null' default: null description: Indicates whether to force dlocal hosted 3D Secure authentication for the card transaction. examples: - true title: Three Dsecure Force title: DlocalCardOptions type: object StripeConnectOptions: additionalProperties: false properties: stripe_account: anyOf: - type: string - type: 'null' default: null description: The Stripe Connect account to target using the `Stripe-Account` header. examples: - act_123456 title: Stripe Account application_fee_amount: anyOf: - type: integer - type: 'null' default: null description: The fee to charge the connected account. examples: - '123' title: Application Fee Amount on_behalf_of: anyOf: - type: string - type: 'null' default: null description: The Stripe Connect account to target using the `on_behalf_of` request parameter. examples: - act_123456 title: On Behalf Of transfer_data_destination: anyOf: - type: string - type: 'null' default: null description: The Stripe Connect account to target using the `transfer_data.destination` request parameter. examples: - act_123456 title: Transfer Data Destination transfer_group: anyOf: - type: string - type: 'null' default: null description: A string that identifies the payment as part of a group. examples: - ORDER100 title: Transfer Group title: StripeConnectOptions type: object NuveiKlarnaOptions: additionalProperties: false properties: customData: anyOf: - maxLength: 255 type: string - type: 'null' default: null description: Additional data to be sent to Nuvei. examples: - user=123,trusted=false title: Customdata title: NuveiKlarnaOptions type: object NuveiIDealOptions: additionalProperties: false properties: customData: anyOf: - maxLength: 255 type: string - type: 'null' default: null description: Additional data to be sent to Nuvei. examples: - user=123,trusted=false title: Customdata title: NuveiIDealOptions type: object NuveiAirlineDataOptions: additionalProperties: false properties: seatClass: anyOf: - type: string - type: 'null' default: null description: The seat class of the booking examples: - F title: Seatclass isCardholderTraveling: anyOf: - type: boolean - type: 'null' default: null description: Indicates whether the cardholder is also a passenger. examples: - true title: Iscardholdertraveling title: NuveiAirlineDataOptions type: object MockCardMerchantAdviceCodeOptions: additionalProperties: false properties: result: anyOf: - type: string - type: 'null' default: null description: The MAC to return for this request. title: Result account_number: anyOf: - type: string - type: 'null' description: When set, the MAC is only returned if the card number matches this account number. title: Account Number required: - account_number title: MockCardMerchantAdviceCodeOptions type: object ForterAntiFraudOptions: additionalProperties: false properties: delivery_type: anyOf: - enum: - DIGITAL - PHYSICAL - HYBRID type: string - type: 'null' default: null description: The delivery type examples: - DIGITAL title: Delivery Type delivery_method: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' default: null description: The delivery method title: Delivery Method is_guest_buyer: anyOf: - type: boolean - type: 'null' default: null description: Defines if this payment is made using guest checkout. examples: - true title: Is Guest Buyer cart_items: anyOf: - items: $ref: '#/components/schemas/ForterAntiFraudOptionsCartItem' type: array - type: 'null' default: [] description: A list of cart items details to pass to the Forter API. title: Cart Items total_discount: anyOf: - $ref: '#/components/schemas/ForterAntiFraudOptionsDiscount' - type: 'null' default: null description: Information about the discount applied to this order. title: ForterAntiFraudOptions type: object WpayPaytoSimulationOptions: additionalProperties: false properties: simulate: anyOf: - type: string - type: 'null' default: null description: The simulation being requested. Please refer to the developer guide for a list of all available simulations. title: Simulate delay: anyOf: - type: integer - type: 'null' default: null description: The delay in seconds before the requested simulation is executed. examples: - 5 title: Delay title: WpayPaytoSimulationOptions type: object MonatoSpeiOptions: additionalProperties: false properties: approval_url: description: Approval URL that will receive a charge payment method reference. examples: - https://example.com title: Approval Url type: string required: - approval_url title: MonatoSpeiOptions type: object CybersourceAntiFraudOptions: additionalProperties: false properties: merchant_defined_data: anyOf: - additionalProperties: maxLength: 5000 minLength: 0 type: string type: object - type: 'null' default: null description: A list of merchant defined data to be passed to the Cybersource Decision Manager API. Each key needs to be a numeric string. examples: - '1': data title: Merchant Defined Data meta_key_merchant_id: anyOf: - type: string - type: 'null' default: null description: The merchant ID to use for this transaction. This requires a meta key to be set up for use with Cybersource Decision Manager, and this overrides the connector configuration. examples: - merchant-1234 title: Meta Key Merchant Id shipping_method: anyOf: - type: string - type: 'null' default: null description: The shipping method for this transaction. examples: - sameday title: Shipping Method title: CybersourceAntiFraudOptions type: object TransactionIntent: type: string enum: - authorize - capture title: TransactionIntent AdyenPixRecurringAmount: additionalProperties: false properties: value: anyOf: - type: integer - type: 'null' default: null description: Amount in the smallest currency unit for the given currency examples: - 1299 title: Value currency: anyOf: - type: string - type: 'null' default: null description: ISO 4217 currency code examples: - BRL title: Currency title: AdyenPixRecurringAmount type: object ForterAntiFraudOptionsCartItemBeneficiaryAddress: additionalProperties: false properties: country: description: The country code of the beneficiary's address. examples: - DE - GB - US pattern: ^[A-Z]{2}$ title: Country type: string address1: anyOf: - type: string - type: 'null' default: null description: First line of the beneficiary's address. title: Address1 address2: anyOf: - type: string - type: 'null' default: null description: Second line of the beneficiary's address. title: Address2 zip: anyOf: - type: string - type: 'null' default: null description: Zip or postal code of the beneficiary's address. title: Zip region: anyOf: - type: string - type: 'null' default: null description: State or region of the beneficiary's address. title: Region company: anyOf: - type: string - type: 'null' default: null description: Company name associated with the beneficiary's address. title: Company city: anyOf: - type: string - type: 'null' default: null description: City of the beneficiary's address. title: City required: - country title: ForterAntiFraudOptionsCartItemBeneficiaryAddress type: object NuveiOptions: additionalProperties: false properties: customData: anyOf: - maxLength: 255 type: string - type: 'null' default: null description: General data about the customer provided by the merchant. examples: - user=123,trusted=false title: Customdata airlineData: anyOf: - $ref: '#/components/schemas/NuveiAirlineDataOptions' - type: 'null' default: null description: Provides additional airline data for Nuvei payments. title: NuveiOptions type: object PaypalOrderUpdateCallbackConfig: additionalProperties: false properties: callback_url: anyOf: - type: string - type: 'null' default: null description: The URL for the webhook endpoint you provide for PayPal to send you order update events. examples: - https://example.com/callback title: Callback Url callback_events: anyOf: - items: enum: - SHIPPING_ADDRESS - SHIPPING_OPTIONS type: string type: array - type: 'null' default: null description: The events that trigger a callback. examples: - - SHIPPING_ADDRESS - SHIPPING_OPTIONS title: Callback Events title: PaypalOrderUpdateCallbackConfig type: object ShippingDetails: properties: first_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: First Name description: The first name(s) or given name for the buyer. examples: - John last_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Last Name description: The last name, or family name, of the buyer. examples: - Doe email_address: anyOf: - type: string maxLength: 320 minLength: 1 - type: 'null' title: Email Address description: The email address for the buyer. examples: - john@example.com phone_number: anyOf: - type: string pattern: ^\+[1-9]\d{1,14}$ examples: - '+14155552671' - '+442071838750' - type: 'null' title: Phone Number description: The phone number for the buyer which should be formatted according to the E164 number standard. examples: - '+1234567890' address: anyOf: - $ref: '#/components/schemas/Address_2' - type: 'null' description: The billing address for the buyer. id: anyOf: - type: string format: uuid - type: 'null' title: Id description: The ID for the shipping details. examples: - bf8c36ad-02d9-4904-b0f9-a230b149e341 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID for the buyer. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 type: type: string const: shipping-details title: Type description: Always `shipping-details`. default: shipping-details examples: - shipping-details additionalProperties: false type: object title: ShippingDetails PaypalShippingOptionsItemAmount: additionalProperties: false properties: currency_code: description: The three-character ISO currency code. examples: - EUR - GBP - USD pattern: ^[A-Z]{3}$ title: Currency Code type: string value: description: The amount value, which might include a decimal portion. examples: - '10.00' maxLength: 32 minLength: 1 title: Value type: string required: - currency_code - value title: PaypalShippingOptionsItemAmount type: object Error429: properties: type: type: string const: error title: Type description: Always `error`. default: error examples: - error code: type: string title: Code description: Always `too_many_requests` default: too_many_requests examples: - too_many_requests status: type: integer title: Status description: Always `429`. default: 429 examples: - 429 message: type: string title: Message description: A human readable message that provides more context to the error. default: Generic error examples: - Request failed validation details: items: $ref: '#/components/schemas/ErrorDetail_2' type: array title: Details description: A list of details that further ellaborate on the error. default: [] additionalProperties: false type: object title: Error429 TaxIdKind: type: string enum: - ae.trn - au.abn - ar.dni - ar.cuil - ar.cuit - br.cnpj - br.cpf - ca.bn - ca.gst_hst - ca.pst_bc - ca.pst_mb - ca.pst_sk - ca.qst - ch.vat - cl.tin - co.itin - co.nit - co.cc - co.ce - co.de - co.rc - co.ti - co.passport - es.cif - eu.vat - gb.vat - hk.br - id.nik - id.npwp - in.gst - in.pan - jp.cn - jp.rn - kr.brn - li.uid - mx.curp - mx.rfc - my.frp - my.itn - my.nric - my.sst - no.vat - nz.gst - pe.ruc - ph.tin - ru.inn - ru.kpp - sa.vat - sg.gst - sg.uen - th.id - th.vat - tw.vat - us.ein - za.vat - bo.ci - uy.rut - uy.ci title: TaxIdKind DlocalPIXSubscriptionOptions: additionalProperties: false properties: amount: anyOf: - $ref: '#/components/schemas/DlocalPIXSubscriptionAmountOptions' - type: 'null' default: null description: Passes `subscription.amount` to the dLocal API for those connectors that need it. examples: - min_value: '10.00' type: FIXED value: '589.01' frequency: description: 'Indicates the frequency unit for the subscription. Allowed values are: `WEEKLY`, `MONTHLY`, `QUARTERLY`, `SEMI_ANNUAL`, `ANNUAL`.' enum: - WEEKLY - MONTHLY - QUARTERLY - SEMI_ANNUAL - ANNUAL examples: - WEEKLY title: Frequency type: string start_date: anyOf: - type: string - type: 'null' default: null description: Defines subscription start date. Must be provided in ISO 8601 format `(YYYY-MM-DD`). If not specified, The default is the current date. examples: - '2030-12-01' title: Start Date end_date: anyOf: - type: string - type: 'null' default: null description: Defines subscription expiration date. Must be provided in ISO 8601 format `(YYYY-MM-DD`). If not provided, the subscription will not expire. examples: - '2030-12-01' title: End Date required: - frequency title: DlocalPIXSubscriptionOptions type: object GoCardlessOptions: additionalProperties: false properties: purpose_code: anyOf: - enum: - mortgage - utility - loan - dependant_support - gambling - retail - salary - personal - government - pension - tax - other type: string - type: 'null' default: null description: Specifies the high-level purpose of a mandate and/or payment using a set of pre-defined categories. Required for the PayTo scheme, optional for all others examples: - mortgage - utility - loan - dependant_support - gambling - retail - salary - personal - government - pension - tax - other title: Purpose Code title: GoCardlessOptions type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError TransactionBuyer: properties: type: type: string const: buyer title: Type description: Always `buyer`. default: buyer examples: - buyer id: anyOf: - type: string format: uuid - type: 'null' title: Id description: The ID for the buyer. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 reconciliation_id: anyOf: - type: string - type: 'null' title: Reconciliation Id description: The base62 encoded buyer ID. This represents a shorter version of this buyer's `id` which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's buyer against our system. examples: - 7jZXl4gBUNl0CnaLEnfXbt display_name: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Display Name description: The display name for the buyer. examples: - John Doe external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant identifier for this buyer. examples: - buyer-12345 billing_details: anyOf: - $ref: '#/components/schemas/BillingDetails_2' - type: 'null' description: The billing name, address, email, and other fields for this buyer. account_number: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Account Number description: The buyer account number. additionalProperties: false type: object title: TransactionBuyer DlocalOptions: additionalProperties: false properties: wallet: anyOf: - $ref: '#/components/schemas/DlocalWalletOptions' - type: 'null' default: null description: Passes `wallet` data to the dLocal API for those connectors that need it. title: DlocalOptions type: object PaypalOptions: additionalProperties: false properties: order_update_callback_config: anyOf: - $ref: '#/components/schemas/PaypalOrderUpdateCallbackConfig' - type: 'null' default: null description: Configuration for server-side callbacks during the PayPal checkout flow. additional_data: anyOf: - items: additionalProperties: type: string type: object type: array - type: 'null' default: null description: Additional Set Transaction Context Values (STC) to be sent to PayPal as part of the transaction. examples: - sender_account_id: customer-1234 title: Additional Data shipping: anyOf: - $ref: '#/components/schemas/PaypalShippingOptions' - type: 'null' default: null description: Shipping information to be passed to the PayPal API. examples: - options: - amount: currency_code: USD value: '10.00' id: ship_1234 label: Free Shipping selected: true type: SHIPPING user_action: anyOf: - type: string - type: 'null' default: null description: Customizes the PayPal Checkout button text. Use `PAY_NOW` to show a pay now button, or `CONTINUE` to show a continue button for deferred payments. examples: - PAY_NOW - CONTINUE title: User Action shipping_preference: anyOf: - type: string - type: 'null' default: null description: Controls the shipping address display in the PayPal Checkout flow. Use `GET_FROM_FILE` to use the shipping address from the PayPal account, `NO_SHIPPING` to hide shipping address fields, or `SET_PROVIDED_ADDRESS` to use the shipping address provided in the request. examples: - GET_FROM_FILE - NO_SHIPPING - SET_PROVIDED_ADDRESS title: Shipping Preference brand_name: anyOf: - maxLength: 127 type: string - type: 'null' default: null description: The merchant brand name that appears in the PayPal Checkout flow. Maximum 127 characters. examples: - Acme Store title: Brand Name landing_page: anyOf: - type: string - type: 'null' default: null description: The type of landing page to display on the PayPal Checkout. Use `LOGIN` to show the PayPal login page, `GUEST_CHECKOUT` to show the guest checkout page, or `NO_PREFERENCE` to let PayPal decide. examples: - LOGIN - GUEST_CHECKOUT - NO_PREFERENCE title: Landing Page locale: anyOf: - type: string - type: 'null' default: null description: The BCP 47 locale used to localize the PayPal Checkout page. For example, `en-US` or `fr-FR`. examples: - en-US - fr-FR title: Locale title: PaypalOptions type: object BraintreeOptions: additionalProperties: false properties: discount_amount: anyOf: - type: integer - type: 'null' default: null description: Passes a discount amount to be applied to the transaction when using Braintree. examples: - 1000 title: Discount Amount custom_fields: anyOf: - additionalProperties: type: string type: object - type: 'null' default: null description: Passes `customFields` to the Braintree API when creating a new payment. Custom fields allow you to customize your checkout experience by collecting specific information about your customers and their purchases. examples: - checkout: primary title: Custom Fields dynamic_data_fields: anyOf: - $ref: '#/components/schemas/BraintreeDynamicDataFieldsOptions' - type: 'null' default: null description: Additional dynamic fields to pass to the Braintree API title: BraintreeOptions type: object ShippingDetailsCreate: properties: first_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: First Name description: The first name(s) or given name for the buyer. examples: - John last_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Last Name description: The last name, or family name, of the buyer. examples: - Doe email_address: anyOf: - type: string maxLength: 320 minLength: 1 - type: 'null' title: Email Address description: The email address for the buyer. examples: - john@example.com phone_number: anyOf: - type: string pattern: ^\+[1-9]\d{1,14}$ examples: - '+14155552671' - '+442071838750' - type: 'null' title: Phone Number description: The phone number for the buyer which should be formatted according to the E164 number standard. examples: - '+1234567890' address: anyOf: - $ref: '#/components/schemas/Address_2' - type: 'null' description: The billing address for the buyer. additionalProperties: false type: object title: ShippingDetailsCreate AffirmOptions: additionalProperties: false properties: discounts: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' default: null description: Passes additional discounts to the Affirm widget. examples: - PRESDAY10: discount_amount: 1000 discount_display_name: President's Day 10% off RETURN5: discount_amount: 500 discount_display_name: Returning customer 5% discount title: Discounts itinerary: anyOf: - $ref: '#/components/schemas/AffirmItineraryOptions' - type: 'null' default: null description: Passes itinerary data to the Affirm API. title: AffirmOptions type: object securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT OAuth2PasswordBearer: type: oauth2 flows: password: scopes: embed: Shorthand for all gr4vy embed related scopes sessions.refresh: Refresh access-token anti-fraud-service-definitions.read: Read Anti Fraud Service Definitions anti-fraud-services.read: Read Anti Fraud Services api-key-pairs.read: Read API Key Pairs api-logs.read: Read API Logs apple-pay-certificates.read: Read Apple Pay Certificates audit-logs.read: Read Audit Logs bin-checker.read: Read BIN Checker buyers.read: Read Buyers buyers.billing-details.read: Read Billing Details card-scheme-definitions.read: Read Card Scheme Definitions checkout-sessions.read: Read Checkout Sessions connections.read: Read Connections digital-wallets.read: Read Digital Wallets flows.read: Read Flows gift-card-service-definitions.read: Read Gift Card Service Definitions gift-card-services.read: Read Gift Card Services gift-cards.read: Read Gift Cards merchant-accounts.read: Read Merchant Accounts payment-links.read: Read Payment Links payment-method-definitions.read: Read Payment Method Definitions payment-methods.read: Read Payment Methods payment-options.read: Read Payment Options payment-service-definitions.read: Read Payment Service Definitions payment-services.read: Read Payment Service payouts.read: Read Payouts reports.read: Read Reports roles.read: Read Roles three-ds-scenarios.read: Read 3DS Scenarios transactions.read: Read Transactions users.me.read: Read User Profile vault-forward.read: Read Vault Forward vault-forward-authentications.read: Read Vault Forward Authentications vault-forward-configs.read: Read Vault Forward Configurations vault-forward-definitions.read: Read Vault Forward Definitions webhook-subscriptions.read: Read Webhook Subscriptions business-contexts.read: Read Business Contexts health-dashboard.read: Read Health Dashboard metrics-explorer.read: Read Metrics Explorer monitoring.read: Read Monitoring reset.read: Read Reset sessions.read: Read Sessions users.read: Read Users anti-fraud-service-definitions.write: Write Anti Fraud Service Definitions anti-fraud-services.write: Write Anti Fraud Services api-key-pairs.write: Write API Key Pairs api-logs.write: Write API Logs apple-pay-certificates.write: Write Apple Pay Certificates audit-logs.write: Write Audit Logs bin-checker.write: Write BIN Checker buyers.write: Write Buyers buyers.billing-details.write: Write Billing Details card-scheme-definitions.write: Write Card Scheme Definitions checkout-sessions.write: Write Checkout Sessions connections.write: Write Connections digital-wallets.write: Write Digital Wallets flows.write: Write Flows gift-card-service-definitions.write: Write Gift Card Service Definitions gift-card-services.write: Write Gift Card Services gift-cards.write: Write Gift Cards merchant-accounts.write: Write Merchant Accounts payment-links.write: Write Payment Links payment-method-definitions.write: Write Payment Method Definitions payment-methods.write: Write Payment Methods payment-options.write: Write Payment Options payment-service-definitions.write: Write Payment Service Definitions payment-services.write: Write Payment Service payouts.write: Write Payouts reports.write: Write Reports roles.write: Write Roles three-ds-scenarios.write: Write 3DS Scenarios transactions.write: Write Transactions users.me.write: Write User Profile vault-forward.write: Write Vault Forward vault-forward-authentications.write: Write Vault Forward Authentications vault-forward-configs.write: Write Vault Forward Configurations vault-forward-definitions.write: Write Vault Forward Definitions webhook-subscriptions.write: Write Webhook Subscriptions business-contexts.write: Write Business Contexts health-dashboard.write: Write Health Dashboard metrics-explorer.write: Write Metrics Explorer monitoring.write: Write Monitoring reset.write: Write Reset sessions.write: Write Sessions users.write: Write Users tokenUrl: auth/token x-refined-from: - gr4vy-docs-v1-openapi.json - gr4vy-openapi.json