openapi: 3.2.0 info: title: Gr4vy Transactions API version: '1.0' description: 'Operations tagged Transactions 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: Transactions description: 'In Gr4vy, a transaction represents a payment in any state, either before it is authorized, once it is captured, or after it has been refunded. The transactions API can be used to: - Authorize, capture, and store cards. - Authorize, capture, and store alternative payment methods like PayPal. - Refund, void, and otherwise cancel existing transactions.' paths: /transactions: get: operationId: list-transactions summary: List transactions description: Lists all transactions for an account. Sorted by last updated at. tags: - Transactions parameters: - schema: type: string example: user-12345 in: query name: buyer_external_identifier description: 'Filters the results to only the items for which the `buyer` has an `external_identifier` that matches this value.' - schema: type: string example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 in: query name: buyer_id description: 'Filters the results to only the items for which the `buyer` has an `id` that matches this value.' - schema: type: string format: '' example: ZXhhbXBsZTE in: query name: cursor description: 'A cursor that identifies the page of results to return. This is used to paginate the results of this API. For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the `next_cursor` field. Similarly the `previous_cursor` can be used to reverse backwards in the list.' - schema: type: integer default: 20 example: 1 minimum: 1 maximum: 500 format: int32 in: query name: limit description: Defines the maximum number of items to return for this request. - schema: type: integer example: 500 in: query name: amount_eq description: 'Filters for transactions that have an `amount` that is equal to the provided `amount_eq` value.' - schema: type: integer example: 500 in: query name: amount_gte description: 'Filters for transactions that have an `amount` that is greater than or equal to the `amount_gte` value.' - schema: type: integer example: 500 in: query name: amount_lte description: 'Filters for transactions that have an `amount` that is less than or equal to the `amount_lte` value.' - schema: type: string format: uuid example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 in: query name: checkout_session_id description: Filters for transactions that are linked to the unique ID for a Checkout Session. - schema: type: string format: date-time example: '2022-01-01T12:00:00+08:00' in: query name: created_at_gte description: 'Filters the results to only transactions created after this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. `2022-01-01T12:00:00+08:00` must be encoded as `2022-01-01T12%3A00%3A00%2B08%3A00`.' - schema: type: string format: date-time example: '2022-01-01T12:00:00+08:00' in: query name: created_at_lte description: 'Filters the results to only transactions created before this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. `2022-01-01T12:00:00+08:00` must be encoded as `2022-01-01T12%3A00%3A00%2B08%3A00`.' - schema: type: array items: type: string example: - USD - GBP in: query name: currency description: 'Filters for transactions that have matching `currency` values. The `currency` values provided must be formatted as 3-letter ISO currency code.' - schema: type: string example: user-12345 in: query name: external_identifier description: 'Filters the results to only the items for which the `external_identifier` matches this value.' - schema: type: string example: be828248-56de-481e-a580-44b6e1d4df81 format: uuid in: query name: gift_card_id description: 'Filters for transactions that have at least one gift card redemption with a matching `gift_card_id` value.' - schema: type: string example: '7890' minLength: 4 maxLength: 4 in: query name: gift_card_last4 description: 'Filters for transactions that have at least one gift card redemption where the last 4 digits of its gift card number matches exactly with the provided value.' - schema: type: boolean example: true in: query name: has_gift_card_redemptions description: 'When set to `true`, filters for transactions that have at least one gift card redemption associated with it. When set to `false`, filter for transactions that have no gift card redemptions.' - schema: type: boolean example: true in: query name: has_refunds description: 'When set to `true`, filter for transactions that have at least one completed refund (including gift card refunds) associated with it. When set to `false`, filter for transactions that have no completed refunds.' - schema: type: boolean example: true in: query name: has_settlements description: 'When set to `true`, filter for transactions that have at least one settlement. When set to `false`, filter for transactions that have no settlements.' - schema: type: string example: be828248-56de-481e-a580-44b6e1d4df81 format: uuid in: query name: id description: Filters for the transaction that has a matching `id` value. - schema: type: array items: type: string example: - '{"key": "value"}' - '{"key_one": "value", "key_two": "value"}' explode: true in: query name: metadata description: 'Filters for transactions where their `metadata` values contain all of the provided `metadata` keys. The value sent for `metadata` must be formatted as a JSON string, and all keys and values must be strings. This value should also be URL encoded. Duplicate keys are not supported. If a key is duplicated, only the last appearing value will be used.' - schema: type: array example: - card items: type: string example: card enum: - affirm - afterpay - alipay - alipayhk - applepay - bacs - bancontact - banked - becs - bitpay - boleto - boost - card - cashapp - chaseorbital - checkout-session - clearpay - click-to-pay - dana - dcb - dlocal - ebanx - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - googlepay - googlepay_pan_only - gopay - grabpay - id - ideal - kakaopay - kcp - klarna - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - network-token - oney_3x - oney_4x - oney_6x - oney_10x - oney_12x - ovo - oxxo - payid - paymaya - paypal - paypalpaylater - payto - venmo - pix - pse - rabbitlinepay - razorpay - scalapay - sepa - shopeepay - singteldash - smartpay - sofort - spei - stripedd - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - vipps - waave - webpay - wechat - zippay in: query name: method description: 'Filters the results to only the items for which the `method` has been set to this value.' - schema: type: string example: 46973e9d-88a7-44a6-abfe-be4ff0134ff4 format: uuid in: query name: payment_method_id description: Filters for transactions that have a payment method with an ID that matches exactly with the provided value. - schema: type: string example: '1234' in: query name: payment_method_label description: 'Filters for transactions that have a payment method with a label that matches exactly with the provided value.' - schema: type: array items: type: string format: uuid example: - 46973e9d-88a7-44a6-abfe-be4ff0134ff4 in: query name: payment_service_id description: 'Filters for transactions that were processed by the provided `payment_service_id` values.' - schema: type: string example: transaction_123 in: query name: payment_service_transaction_id description: 'Filters for transactions that have a matching `payment_service_transaction_id` value. The `payment_service_transaction_id` is the identifier of the transaction given by the payment service.' - schema: type: boolean example: true in: query name: pending_review description: 'When set to `true`, filter for transactions that have a manual review pending. When set to `false`, filter for transactions that don''t have a manual review pending.' - schema: type: string format: string example: 7EgeeeTX0DS45RBDNt4AEY in: query name: reconciliation_id description: Filters for transactions based on their transaction reconciliation identifier. - schema: type: string example: be828248-56de-481e-a580-44b6e1d4df81 in: query name: search deprecated: true description: 'Filters for transactions that have one of the following fields match exactly with the provided `search` value. * `buyer_external_identifier` * `buyer_id` * `external_identifier` * `id` * `payment_service_transaction_id` The search will apply against all fields at the same time. Please do not use this query parameter in a production application, as this API call is very inefficient and may negatively impact transaction performance.' - schema: type: array items: type: string enum: - processing - buyer_approval_pending - authorization_succeeded - authorization_failed - authorization_declined - capture_pending - capture_succeeded - authorization_void_pending - authorization_voided example: - capture_succeeded - processing in: query name: status description: 'Filters the results to only the transactions that have a `status` that matches with any of the provided status values.' - schema: type: string format: date-time example: '2022-01-01T12:00:00+08:00' in: query name: updated_at_gte description: 'Filters the results to only transactions last updated after this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. `2022-01-01T12:00:00+08:00` must be encoded as `2022-01-01T12%3A00%3A00%2B08%3A00`.' - schema: type: string format: date-time example: '2022-01-01T12:00:00+08:00' in: query name: updated_at_lte description: 'Filters the results to only transactions last updated before this ISO date-time string. The time zone must be included. Ensure that the date-time string is URL encoded, e.g. `2022-01-01T12:00:00+08:00` must be encoded as `2022-01-01T12%3A00%3A00%2B08%3A00`.' - schema: type: boolean example: true in: query name: is_subsequent_payment description: 'When set to `true`, filter for transactions that are a subsequent payment. When set to `false`, filter for transactions that are not an initial payment.' - schema: type: boolean example: true in: query name: merchant_initiated description: 'When set to `true`, filter for transactions that are merchant initiated. When set to `false`, filter for transactions that are not merchant initiated.' - schema: type: string example: '411111' in: query name: payment_method_bin description: Filter for transactions that have a card with a BIN that matches exactly with the provided value. - schema: type: array example: - ecommerce - recurring items: type: string example: recurring enum: - ecommerce - moto - recurring - installment - card_on_file in: query name: payment_source description: Filters the results to only the transactions that have a payment source that matches with any of the provided values. responses: '200': description: Returns a paginated list of transactions for an account. content: application/json: schema: $ref: '#/components/schemas/Transactions' '401': description: Returns an error if no valid authentication was provided. content: application/json: schema: $ref: '#/components/schemas/Error401Unauthorized' x-speakeasy-pagination: type: cursor inputs: - name: cursor in: parameters type: cursor outputs: nextCursor: $.next_cursor security: - bearerAuth: [] post: summary: New transaction tags: - Transactions operationId: new-transaction description: 'Attempts to create an authorization for a payment method. In some cases it is not possible to create the authorization without redirecting the user for their authorization. In these cases the status is set to indicate buyer approval is pending and an approval URL is returned. Duplicated gift card numbers are not supported. This includes both stored gift cards, as well as those directly provided via the request.' parameters: - schema: type: string maxLength: 255 example: bffa9ce6-7a8a-449c-889a-65bd2ee86903 in: header name: Idempotency-Key description: 'A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions.' requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionRequest' examples: Authorize a new card: value: amount: 1299 currency: USD payment_method: method: card number: '4111111111111111' expiration_date: 11/25 security_code: '123' redirect_url: https://example.com/callback Authorize and store a card: value: amount: 1299 currency: USD store: true payment_method: method: card number: '4111111111111111' expiration_date: 11/25 security_code: '123' redirect_url: https://example.com/callback Authorize, capture, and store a card: value: amount: 1299 currency: USD intent: capture store: true payment_method: method: card number: '4111111111111111' expiration_date: 11/25 security_code: '123' redirect_url: https://example.com/callback Authorize and capture a GoCardless transaction: value: amount: 1299 currency: USD intent: capture payment_method: method: gocardless redirect_url: https://example.com/callback country: US currency: USD Authorize and capture using a previously stored card: value: amount: 1299 currency: USD intent: capture payment_method: method: id id: 46973e9d-88a7-44a6-abfe-be4ff0134ff4 Authorize a new card with connection options and anti-fraud fingerprint: value: amount: 1299 currency: USD payment_method: method: card number: '4111111111111111' expiration_date: 11/25 security_code: '123' redirect_url: https://example.com/callback connection_options: cybersource-anti-fraud: merchant_defined_data: '1': John Doe '2': trusted '99': recurring anti_fraud_fingerprint: yGeBAFYgFmM= Authorize and asynchronously capture a card transaction: value: amount: 1299 currency: USD intent: capture async_capture: true payment_method: method: card number: '4111111111111111' expiration_date: 11/25 security_code: '123' redirect_url: https://example.com/callback responses: '201': description: Returns the created transaction. content: application/json: schema: $ref: '#/components/schemas/Transaction' '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' '409': description: Returns an error if duplicate resource has been found. content: application/json: schema: $ref: '#/components/schemas/Error409DuplicateRecord' '429': description: 'Returns an error if the same token is used for too many requests per minute. The exact rate limit differs per instance.' content: application/json: schema: $ref: '#/components/schemas/Error429TooManyRequests' 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. /transactions/{transaction_id}: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. get: operationId: get-transaction summary: Get transaction description: Get information about a transaction. tags: - Transactions responses: '200': description: Returns a transaction resource. content: application/json: schema: $ref: '#/components/schemas/Transaction' '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 or has not yet been created. content: application/json: schema: $ref: '#/components/schemas/Error404NotFound' security: - bearerAuth: [] put: tags: - Transactions summary: Manually update a transaction description: Manually updates a transaction. operationId: update_transaction security: - OAuth2PasswordBearer: - transactions.write parameters: - name: transaction_id in: path required: true schema: type: string format: uuid description: The ID of the transaction examples: - 7099948d-7286-47e4-aad8-b68f7eb44591 title: Transaction Id description: The ID of the transaction - name: x-gr4vy-merchant-account-id in: header required: false schema: anyOf: - type: string - type: 'null' description: The ID of the merchant account to use for this request. examples: - default title: X-Gr4Vy-Merchant-Account-Id description: The ID of the merchant account to use for this request. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TransactionUpdate' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Transaction_2' '400': description: The request was invalid. content: application/json: schema: $ref: '#/components/schemas/Error400' '401': description: The request was unauthorized. content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: The credentials were invalid or the caller did not have permission to act on the resource. content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error404' '405': description: The request method was not allowed. content: application/json: schema: $ref: '#/components/schemas/Error405' '409': description: A duplicate record was found. content: application/json: schema: $ref: '#/components/schemas/Error409' '425': description: The request was too early. content: application/json: schema: $ref: '#/components/schemas/Error425' '429': description: Too many requests were made. content: application/json: schema: $ref: '#/components/schemas/Error429' '500': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error500' '502': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error502' '504': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error504' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-name-override: update x-speakeasy-group: transactions 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. /transactions/{transaction_id}/actions: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. get: operationId: get-transaction-actions summary: List actions for transaction description: Gets actions for a given transaction. tags: - Transactions x-internal: true responses: '200': description: Returns associated actions. content: application/json: schema: $ref: '#/components/schemas/Actions' '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. /transactions/{transaction_id}/capture: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. post: operationId: capture-transaction summary: Capture transaction description: Captures a previously authorized transaction. tags: - Transactions requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionCaptureRequest' examples: Capture an authorization: value: amount: 1299 responses: '200': description: Returns the captured transaction. content: application/json: schema: $ref: '#/components/schemas/Transaction' '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' '404': description: Returns an error if the resource can not be found or has not yet been created. 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. /transactions/{transaction_id}/events: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. get: operationId: get-transaction-events summary: List events for transaction description: Get a list of events related to processing a transaction. tags: - Transactions x-internal: true parameters: - schema: type: string format: '' example: ZXhhbXBsZTE in: query name: cursor description: 'A cursor that identifies the page of results to return. This is used to paginate the results of this API. For the first page of results, this parameter can be left out. For additional pages, use the value returned by the API in the `next_cursor` field. Similarly the `previous_cursor` can be used to reverse backwards in the list.' - schema: type: integer default: 100 example: 1 minimum: 1 maximum: 500 format: int32 in: query name: limit description: Defines the maximum number of items to return for this request. responses: '200': description: Returns a collection of transaction history events. content: application/json: schema: $ref: '#/components/schemas/TransactionHistoryEvents' '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 or has not yet been created. 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. /transactions/{transaction_id}/refunds: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. get: operationId: list-transaction-refunds summary: List refunds description: Lists all refunds associated with a certain transaction. tags: - Transactions responses: '200': description: Returns a list of refunds. content: application/json: schema: $ref: '#/components/schemas/Refunds' '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: [] post: operationId: new-refund summary: Refund transaction description: 'Refunds a transaction, fully or partially. If the transaction was not yet successfully captured, the refund will not be processed. Authorized transactions can be voided instead.' tags: - Transactions requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionRefundRequest' examples: Request a full refund on a transaction: value: {} Request a partial refund on a transaction: value: amount: 1299 responses: '201': description: Returns the created refund. content: application/json: schema: $ref: '#/components/schemas/Refund' '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' '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. /transactions/{transaction_id}/refunds/all: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. post: operationId: refund-all summary: Refund all instruments in a transaction description: Refunds a transaction fully across all instruments. tags: - Transactions requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/TransactionRefundAllRequest' examples: Request a full refund on a transaction with a reason: value: reason: Refund due to user request responses: '201': description: Returns the created refunds. Not all refunds may have succeeded. content: application/json: schema: $ref: '#/components/schemas/Refunds' '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' '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. /transactions/{transaction_id}/refunds/{refund_id}: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. - schema: type: string example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 name: refund_id in: path required: true description: The unique ID of the refund. get: operationId: get-refund summary: Get refund description: Gets information about a refund associated with a certain transaction. tags: - Transactions responses: '200': description: Returns a refund. content: application/json: schema: $ref: '#/components/schemas/Refund' '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. /transactions/{transaction_id}/settlements: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. get: operationId: get-transaction-settlements summary: List settlements for transaction description: Gets settlements for a given transaction. tags: - Transactions responses: '200': description: Returns associated settlements. content: application/json: schema: $ref: '#/components/schemas/Settlements' '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. /transactions/{transaction_id}/settlements/{settlement_id}: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. - schema: type: string example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 name: settlement_id in: path required: true description: The unique ID of the settlement. get: operationId: get-transaction-settlement summary: Get settlement description: Gets information about a settlement associated with a certain transaction. tags: - Transactions responses: '200': description: Returns a settlement. content: application/json: schema: $ref: '#/components/schemas/Settlement' '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. /transactions/{transaction_id}/sync: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. post: operationId: sync-transaction summary: Sync transaction description: 'Sync the transaction with the payment service to get the latest status, amounts, and some of the identifiers. This is only available for some payment service providers.' tags: - Transactions responses: '200': description: Returns the updated transaction resource. content: application/json: schema: $ref: '#/components/schemas/Transaction' '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 or has not yet been created. 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. /refunds/{refund_id}: parameters: - schema: type: string example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 name: refund_id in: path required: true description: The unique ID of the refund. get: operationId: get-single-refund summary: Get refund description: Gets information about a refund. tags: - Transactions responses: '200': description: Returns a refund. content: application/json: schema: $ref: '#/components/schemas/Refund' '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. /transactions/{transaction_id}/summary: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. get: operationId: get-transaction-summary summary: Get transaction summary description: Gets summary for a given transaction. tags: - Transactions x-internal: true responses: '200': description: Returns associated transaction status summary. content: application/json: schema: $ref: '#/components/schemas/TransactionStatusSummary' '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. /transactions/{transaction_id}/void: parameters: - schema: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 name: transaction_id in: path required: true description: The ID for the transaction to get the information for. post: operationId: void-transaction summary: Void transaction description: 'Voids a transaction. If the transaction was not yet successfully authorized, or was already captured, the void will not be processed. Captured transactions can be refunded instead. Voiding zero-amount authorized transactions is not supported. Once voided, the status of the transaction will be either `authorization_voided`, `authorization_void_pending`, or if the void fails the original status will remain.' tags: - Transactions responses: '200': description: Returns the voided transaction. content: application/json: schema: $ref: '#/components/schemas/Transaction' '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' '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. /transactions/{transaction_id}/cancel: post: tags: - Transactions summary: Cancel transaction description: Cancels a pending transaction. If the transaction was successfully authorized, or was already captured, the cancel will not be processed. operationId: cancel_transaction security: - OAuth2PasswordBearer: - transactions.write parameters: - name: transaction_id in: path required: true schema: type: string format: uuid description: The ID of the transaction examples: - 7099948d-7286-47e4-aad8-b68f7eb44591 title: Transaction Id description: The ID of the transaction - name: x-gr4vy-merchant-account-id in: header required: false schema: anyOf: - type: string - type: 'null' description: The ID of the merchant account to use for this request. examples: - default title: X-Gr4Vy-Merchant-Account-Id description: The ID of the merchant account to use for this request. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TransactionCancel' '400': description: The request was invalid. content: application/json: schema: $ref: '#/components/schemas/Error400' '401': description: The request was unauthorized. content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: The credentials were invalid or the caller did not have permission to act on the resource. content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error404' '405': description: The request method was not allowed. content: application/json: schema: $ref: '#/components/schemas/Error405' '409': description: A duplicate record was found. content: application/json: schema: $ref: '#/components/schemas/Error409' '425': description: The request was too early. content: application/json: schema: $ref: '#/components/schemas/Error425' '429': description: Too many requests were made. content: application/json: schema: $ref: '#/components/schemas/Error429' '500': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error500' '502': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error502' '504': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error504' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-name-override: cancel x-speakeasy-group: transactions /transactions/{transaction_id}/authorization/increment: post: tags: - Transactions summary: Increment transaction authorization description: Increment the transaction authorization amount of a given transaction_id. operationId: increment_transaction_authorization security: - OAuth2PasswordBearer: - transactions.write parameters: - name: transaction_id in: path required: true schema: type: string format: uuid description: The unique identifier of the transaction. examples: - 7099948d-7286-47e4-aad8-b68f7eb44591 title: Transaction Id description: The unique identifier of the transaction. - name: x-gr4vy-merchant-account-id in: header required: false schema: anyOf: - type: string - type: 'null' description: The ID of the merchant account to use for this request. examples: - default title: X-Gr4Vy-Merchant-Account-Id description: The ID of the merchant account to use for this request. - name: idempotency-key in: header required: false schema: anyOf: - type: string - type: 'null' description: A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions. examples: - request-12345 title: Idempotency-Key description: A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TransactionAuthorizationIncrementCreate' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TransactionAuthorizationIncrement' '400': description: The request was invalid. content: application/json: schema: $ref: '#/components/schemas/Error400' '401': description: The request was unauthorized. content: application/json: schema: $ref: '#/components/schemas/Error401' '403': description: The credentials were invalid or the caller did not have permission to act on the resource. content: application/json: schema: $ref: '#/components/schemas/Error403' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error404' '405': description: The request method was not allowed. content: application/json: schema: $ref: '#/components/schemas/Error405' '409': description: A duplicate record was found. content: application/json: schema: $ref: '#/components/schemas/Error409' '425': description: The request was too early. content: application/json: schema: $ref: '#/components/schemas/Error425' '429': description: Too many requests were made. content: application/json: schema: $ref: '#/components/schemas/Error429' '500': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error500' '502': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error502' '504': description: The server encountered an error. content: application/json: schema: $ref: '#/components/schemas/Error504' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-speakeasy-name-override: increment_authorization x-speakeasy-group: transactions components: schemas: PaymentConnectorReportTransactionSettled: title: Settlement - Sourced from Connector Report type: object description: 'This event logs the exact details for the settlement of a transaction as sourced from a connector report.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: 'The name of this resource. Is always `payment-connector-report-transaction-settled`.' example: payment-connector-report-transaction-settled enum: - payment-connector-report-transaction-settled created_at: type: string description: The date and time when this transaction was settled. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: settlement_id: type: string format: uuid example: 577b430a-b516-4c96-bba2-7f63604c4d62 description: The unique ID of this transaction's settlement. posted_at: type: string format: date-time example: '2023-07-26T19:23:00.000+00:00' description: The date and time when this transaction was settled. ingested_at: type: string format: date-time example: '2023-07-26T19:23:00.000+00:00' description: 'The date and time when information about this transaction''s settlement was ingested into our system.' currency: type: string example: USD description: 'The currency of this transaction''s settlement in ISO 4217 three-letter code format.' amount: type: integer example: 500 description: The net amount settled for this transaction. exchange_rate: type: - number - 'null' example: 0.95 description: 'The exchange rate used to convert amounts from the processing currency to the settlement currency.' commission: type: integer example: 5 description: The total commission paid on this transaction, expressed in `currency`. interchange: type: - integer - 'null' example: 5 description: The interchange fee for this transaction, expressed in `currency`. markup: type: - integer - 'null' example: 10 description: The markup applied to this transaction by the acquirer, expressed in `currency`. scheme_fee: type: - integer - 'null' example: 5 description: The scheme fee for this transaction, expressed in `currency`. payment_service_id: type: string example: 5d8fe189-ea36-4a92-b0b2-d0b2f9d8639f format: uuid description: The unique ID of the payment service used. payment_service_definition_id: type: string example: stripe-card description: The payment service definition used. payment_service_display_name: type: string example: Stripe description: The display name of the payment service used. payment_service_report_id: type: string format: uuid example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 description: 'The ID of the payment service report containing this transaction''s settlement.' payment_service_report_file_ids: type: array items: type: string format: uuid example: - 0302e601-d2c3-42b2-9825-9457145331ae - 7deec061-71a5-435f-beae-40f35820ca67 description: 'The list of payment service report file IDs that make up the payment service report containing this transaction''s settlement.' payment_service_transaction_id: type: string description: The external ID of the transaction as set by the payment service. example: transaction-1234 report_payment_service_id: type: string example: 5d8fe189-ea36-4a92-b0b2-d0b2f9d8639f format: uuid description: The unique ID of the payment service that reported this transaction's settlement. report_payment_service_definition_id: type: string example: stripe-card description: The definition ID of the payment service that reported this transaction's settlement. report_payment_service_display_name: type: string example: Stripe description: The display name of the payment service that reported this transaction's settlement. Transactions: title: Transactions description: A list of transactions. type: object x-tags: - Transactions properties: items: type: array description: A list of transactions. items: $ref: '#/components/schemas/TransactionSummary' 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: 500 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 TransactionRequest: title: Transaction (Create) type: object description: A request to create a transaction. x-tags: - Request Bodies required: - amount - currency properties: amount: description: 'The monetary amount for this transaction, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`. If the `intent` is set to `capture`, an amount greater than zero must be supplied. All gift card amounts are subtracted from this amount before the remainder is charged to the provided `payment_method`.' type: integer example: 1299 minimum: 0 maximum: 99999999 currency: type: string example: USD description: 'A supported ISO-4217 currency code. For redirect requests, this value must match the one specified for `currency` in `payment_method`. ' payment_method: description: The optional payment method to use for this transaction. This field is required if no `gift_cards` have been added. oneOf: - $ref: '#/components/schemas/TransactionCardRequest' - $ref: '#/components/schemas/TransactionRedirectRequest' - $ref: '#/components/schemas/TokenizedRequest' - $ref: '#/components/schemas/ApplePayRequest' - $ref: '#/components/schemas/GooglePayRequest' - $ref: '#/components/schemas/TransactionCheckoutSessionRequest' - $ref: '#/components/schemas/TransactionNetworkTokenRequest' - $ref: '#/components/schemas/TransactionNetworkTokenApplePayRequest' - $ref: '#/components/schemas/TransactionNetworkTokenGooglePayRequest' type: - object - 'null' x-model-name: TransactionPaymentMethodRequest anti_fraud_fingerprint: default: null description: 'This field represents the fingerprint data to be passed to the active anti-fraud service.' example: yGeBAFYgFmM= type: - string - 'null' async_capture: default: false description: "Whether to capture the transaction asynchronously.\n\n- When `async_capture` is `false` (default), the transaction is captured\n in the same request.\n- When `async_capture` is `true`, the transaction is automatically\n captured at a later time.\n\nRedirect transactions are not affected by this flag.\n\nThis flag can only be set to `true` when `intent` is set to `capture`." example: true type: boolean browser_info: allOf: - $ref: '#/components/schemas/BrowserInfo' description: Information about the browser used by the buyer. type: - object - 'null' buyer_external_identifier: description: 'The `external_identifier` of the buyer to associate this payment method to. If this field is provided then the `buyer_id` field needs to be unset. If a stored payment method or gift card is provided, then the buyer for that payment method needs to match the buyer for this field.' example: user-789123 type: string buyer_id: description: 'The ID of the buyer to associate this payment method to. If this field is provided then the `buyer_external_identifier` field needs to be unset. If a stored payment method or gift card is provided, then the buyer for that payment method needs to match the buyer for this field.' example: fe26475d-ec3e-4884-9553-f7356683f7f9 format: uuid type: string buyer: description: 'Guest buyer details provided inline rather than creating a buyer resource beforehand and using the `buyer_id` or `buyer_external_identifier` keys. No buyer resource will be created on Gr4vy when used.' oneOf: - $ref: '#/components/schemas/TransactionBuyerRequest' type: - object - 'null' x-model-name: TransactionBuyerRequest cart_items: description: An array of cart items that represents the line items of a transaction. items: $ref: '#/components/schemas/CartItem' maxItems: 249 type: array 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' country: description: 'The 2-letter ISO code of the country where the transaction is processed. This is also used to filter the payment services that can process the transaction. If this value is provided for redirect requests and it''s not `null`, it must match the one specified for `country` in `payment_method`. Otherwise, the value specified for `country` in `payment_method` will be assumed implicitly. ' example: US type: - string - 'null' external_identifier: description: An external identifier that can be used to match the transaction against your own records. example: user-789123 type: - string - 'null' gift_cards: description: 'The optional gift card(s) to use for this transaction. At least one gift card is required if no other `payment_method` has been added. By default, only a maximum limit of 10 gift cards may be used in a single transaction. Please contact our team to change this limit.' items: oneOf: - $ref: '#/components/schemas/TransactionGiftCardNewRequest' - $ref: '#/components/schemas/TransactionGiftCardStoredRequest' x-model-name: TransactionGiftCardRequest type: - array - 'null' intent: default: authorize description: 'Defines the intent of this API call. This determines the desired initial state of the transaction. * `authorize` - (Default) Optionally approves and then authorizes a transaction but does not capture the funds. * `capture` - Optionally approves and then authorizes and captures the funds of the transaction.' enum: - authorize - capture example: capture type: string is_subsequent_payment: default: false description: 'Indicates whether the transaction represents a subsequent payment coming from a setup recurring payment. Please note there are some restrictions on how this flag may be used. The flag can only be `false` (or not set) when the transaction meets one of the following criteria: * It is not `merchant_initiated`. * `payment_source` is set to `card_on_file`. The flag can only be set to `true` when the transaction meets one of the following criteria: * It is not `merchant_initiated`. * `payment_source` is set to `recurring` or `installment` and `merchant_initiated` is set to `true`. * `payment_source` is set to `card_on_file`.' example: true type: boolean merchant_initiated: default: false description: 'Indicates whether the transaction was initiated by the merchant (true) or customer (false).' example: true type: boolean metadata: additionalProperties: type: string description: 'Any additional information about the transaction 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 payment_source: description: The source of the transaction. Defaults to `ecommerce`. type: string example: recurring enum: - ecommerce - moto - recurring - installment - card_on_file previous_scheme_transaction_id: default: null description: 'A scheme''s transaction identifier to use in connecting a merchant initiated transaction to a previous customer initiated transaction. If not provided, and a qualifying customer initiated transaction has been previously made, then Gr4vy will populate this value with the identifier returned for that transaction. e.g. the Visa Transaction Identifier, or Mastercard Trace ID.' example: '123456789012345' type: - string - 'null' shipping_details_id: default: null description: 'The unique identifier of a set of shipping details stored for the buyer. If provided, the created transaction will include a copy of the details at the point of transaction creation; i.e. it will not be affected by later changes to the detail in the database.' example: 47da6902-5eae-4b4b-88fd-856802d627d6 format: uuid type: - string - 'null' statement_descriptor: allOf: - $ref: '#/components/schemas/StatementDescriptor' type: - object - 'null' store: default: false description: 'Whether or not to also try and store the payment method with us so that it can be used again for future use. This is only supported for payment methods that support this feature. There are also a few restrictions on how the flag may be set: * The flag has to be set to `true` when the `payment_source` is set to `recurring` or `installment`, and `merchant_initiated` is set to `false`. * The flag has to be set to `false` (or not set) when using a previously vaulted payment method.' example: true type: boolean three_d_secure_data: description: 'Pass through 3-D Secure data to support external 3-D Secure authorisation. If using an external 3-D Secure provider, you should not pass a `redirect_url` in the `payment_method` object for a transaction.' oneOf: - $ref: '#/components/schemas/ThreeDSecureDataV1' - $ref: '#/components/schemas/ThreeDSecureDataV2' type: object x-model-name: ThreeDSecureDataV1V2 payment_service_id: default: null description: 'The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped.' example: 47da6902-5eae-4b4b-88fd-856802d627d6 type: - string - 'null' format: uuid airline: type: - object - 'null' allOf: - $ref: '#/components/schemas/Airline' description: 'The airline addendum data which describes the airline booking associated with this transaction.' account_funding_transaction: type: - boolean - 'null' default: false description: Whether or not the transaction is an account funding transaction. example: true recipient: type: - object - 'null' allOf: - $ref: '#/components/schemas/Recipient' description: The recipient of an account funding transaction. allow_partial_authorization: type: - boolean - 'null' default: false description: 'Whether or not to allow partial authorization of the transaction. Support for this will depend on the connector used. When a connector does not support partial authorization, and the user does not have sufficient funds, the transaction will be declined.' example: true NetworkTokenCryptogramProvisionFailed: title: Network Token Cryptogram Provision - Failure type: object description: This event logs the request and response details of HTTP calls made to provision a cryptogram for a network token, in case the call failed. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `network-token-cryptogram-provision-failed`. example: network-token-cryptogram-provision-failed enum: - network-token-cryptogram-provision-failed created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: url: type: - string - 'null' description: The endpoint for the request, if performed. request: type: - string - 'null' description: The HTTP body sent to the Network Token provider, if performed. response: type: - string - 'null' description: The HTTP body received from the Network Token provider, if any. response_status_code: type: - number - 'null' description: The HTTP response status code from the Network Token provider, if any. reason: type: string description: The reason we could not provision the cryptogram. example: Network Error PaymentConnectorResponseTransactionVoidFailedEvent: title: Void - Failed type: object description: 'This event logs the exact details parsed details for a failed void as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-void-failed`. example: payment-connector-response-transaction-void-failed enum: - payment-connector-response-transaction-void-failed created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. AntiFraudDecisionErrorEvent: title: Anti-fraud - Error type: object description: This event logs the reason why we were unable to get an anti-fraud decision. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-decision-error`. example: anti-fraud-decision-error enum: - anti-fraud-decision-error created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. status_code: type: number description: The HTTP response status code from the anti-fraud provider, if we received any. reason: type: string description: The reason we could not get the anti-fraud decision. example: Network Error silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' GiftCardRefundSucceeded: title: Gift Cards Refund - Succeeded type: object description: This event logs the request and response details of HTTP calls made to refund gift cards, in case the call succeeded. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `gift-card-refund-succeeded`. example: gift-card-refund-succeeded enum: - gift-card-refund-succeeded created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: gift_card_service_id: type: string format: uuid description: The unique ID of the Gift Card service used. gift_card_service_name: type: string description: The name of the Gift Card service used. gift_card_service_definition_id: type: string description: The Gift Card service definition used. url: type: - string - 'null' description: The endpoint for the request. request: type: string description: The HTTP body sent to the Gift Card provider. response: type: string description: The HTTP body received from the Gift Card provider. response_status_code: type: number description: The HTTP response status code from the Gift Card provider. PaymentMethod--Snapshot: title: Payment method (Snapshot) description: 'Snapshot of a payment method, as used when embedded inside other resources.' type: object x-tags: - Payment Methods properties: type: type: string description: '`payment-method`.' example: payment-method enum: - payment-method id: type: - string - 'null' description: The unique ID of the payment method. format: uuid example: 77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5 approval_target: type: - string - 'null' example: any description: The browser target that an approval URL must be opened in. If `any` or `null`, then there is no specific requirement. enum: - any - new_window approval_url: description: The optional URL that the buyer needs to be redirected to to further authorize their payment. example: https://api.example.app.gr4vy.com/payment-methods/ffc88ec9-e1ee-45ba-993d-b5902c3b2a8c/approve format: uri type: - string - 'null' country: description: 'The 2-letter ISO code of the country this payment method can be used for. If this value is `null` the payment method may be used in multiple countries.' example: US type: - string - 'null' currency: description: 'The ISO-4217 currency code that this payment method can be used for. If this value is `null` the payment method may be used for multiple currencies.' example: USD type: - string - 'null' details: allOf: - $ref: '#/components/schemas/PaymentMethodDetailsCard' expiration_date: description: 'The expiration date for this payment method. This is mostly used by cards where the card might have an expiration date.' example: 11/25 maxLength: 5 minLength: 5 pattern: ^\d{2}/\d{2}$ type: - string - 'null' external_identifier: description: 'An external identifier that can be used to match the payment method against your own records.' example: user-789123 type: - string - 'null' label: description: 'A label for the payment method. This can be the last 4 digits for a card, or the email address for an alternative payment method.' example: '1111' type: - string - 'null' last_replaced_at: description: "The date and time when this card was last replaced.\n\nWhen the Account Updater determines that new card details are available, existing details are not\nchanged immediately. There are three scenarios in which the actual replacement occurs:\n\n1. When this card has expired.\n2. When only the expiration date changed.\n3. When a transaction using this card is declined with any of the following codes:\n * `canceled_payment_method`\n * `expired_payment_method`\n * `unavailable_payment_method`\n * `unknown_payment_method`\n\nWhen the replacement is applied, this field is updated.\nFor non-card payment methods, the value of this field is always set to `null`." example: '2023-07-26T19:23:00.000+00:00' format: date-time type: - string - 'null' method: description: The type of this payment method. type: string example: card enum: - affirm - afterpay - alipay - alipayhk - applepay - bacs - bancontact - banked - becs - bitpay - boleto - boost - card - cashapp - chaseorbital - checkout-session - clearpay - click-to-pay - dana - dcb - dlocal - ebanx - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - googlepay - googlepay_pan_only - gopay - grabpay - id - ideal - kakaopay - kcp - klarna - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - network-token - oney_3x - oney_4x - oney_6x - oney_10x - oney_12x - ovo - oxxo - payid - paymaya - paypal - paypalpaylater - payto - venmo - pix - pse - rabbitlinepay - razorpay - scalapay - sepa - shopeepay - singteldash - smartpay - sofort - spei - stripedd - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - vipps - waave - webpay - wechat - zippay payment_account_reference: description: 'The payment account reference (PAR) returned by the card scheme. This is a unique reference to the underlying account that has been used to fund this payment method. This value will be unique if the same underlying account was used, regardless of the actual payment method used. For example, a network token or an Apple Pay device token will return the same PAR when possible. The uniqueness of this value will depend on the card scheme, please refer to their documentation for further details. The availability of the PAR in our API depends on the availability of its value in the API of the payment service used for the transaction.' type: - string - 'null' example: V0010014629724763377327521982 scheme: description: 'An additional label used to differentiate different sub-types of a payment method. Most notably this can include the type of card used in a transaction. This field is `null` for the non-card payment methods. This represents the card scheme sent to the connector and it could be different from the actual card scheme that is being used by the PSP to process the transaction in the following situations: 1. `use_additional_scheme` transformation is used with the `PAN` instrument but we already have a PSP token for the card. 2. `use_additional_scheme` transformation is used but PSP has fallen back to the main card scheme internally.' type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null fingerprint: type: - string - 'null' description: The unique hash derived from the payment method identifier (e.g. card number). example: 20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17 TransactionNetworkTokenRequest: title: Network Token payment method request type: object description: Details for a Network Token payment method. x-tags: - Request Bodies required: - method - token - expiration_date properties: method: type: string description: '`network-token`.' example: network-token enum: - network-token token: type: string description: The value of the network token. expiration_date: type: string description: The expiration date of the network token, formatted `MM/YY`. example: 11/25 pattern: ^\d{2}/\d{2}$ minLength: 5 maxLength: 5 eci: type: string pattern: ^0?\d$ minLength: 1 maxLength: 2 description: The ecommerce indicator. example: '05' cryptogram: type: - string - 'null' description: The cryptogram of the network token. redirect_url: type: - string - 'null' format: uri description: 'We strongly recommend providing a `redirect_url` either when 3-D Secure is enabled and `three_d_secure_data` is not provided, or when using connections where 3DS is enabled. This value will be appended with both a transaction ID and status (e.g. `https://example.com/callback?gr4vy_transaction_id=123 &gr4vy_transaction_status=capture_succeeded`) after 3-D Secure has completed. For those cases, if the value is not present, the transaction will be marked as failed.' example: https://example.com/callback 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' AntiFraudTransactionStatusUpdateEvent: title: Anti-fraud - Transaction update sent type: object description: This event logs the request and response details of HTTP calls made to an anti-fraud provider to update on a transaction status. For example, when a capture is successful. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-transaction-status-update`. example: anti-fraud-transaction-status-update enum: - anti-fraud-transaction-status-update created_at: type: string description: The date and time when this transaction event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. request: type: string description: The HTTP body sent to fetch a decision. response: type: string description: The HTTP body received from the anti-fraud provider. response_status_code: type: number description: The HTTP response status code from the anti-fraud provider. silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' PaymentConnectorResponseTransactionCaptureSucceededEvent: title: Capture - Succeeded type: object description: 'This event logs the exact details parsed details for a succeeded capture as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-capture-succeeded`. example: payment-connector-response-transaction-capture-succeeded enum: - payment-connector-response-transaction-capture-succeeded created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 status: type: string enum: - capture_succeeded description: 'The new status code for the transaction. This is always set to `capture_succeeded`.' example: capture_succeeded instrument_type: type: - string - 'null' example: pan enum: - pan - card_token - redirect - redirect_token - googlepay - applepay - network_token description: The type of instrument used for this transaction. retry_rule: type: - string - 'null' description: This will always be `null` because the transaction succeeded. example: null deprecated: true raw_response_code: type: - string - 'null' description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip raw_response_description: type: - string - 'null' description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' auth_response_code: description: This is the response description received from the processor. example: '00' type: - string - 'null' avs_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. - `no_match` - neither address or postal code match - `match` - both address and postal code match - `partial_match_address` - address matches but postal code does not - `partial_match_postcode` - postal code matches but address does not - `unavailable ` - AVS is unavailable for card/country The value of this field can be `null` if the payment service did not provide a response.' example: partial_match_address enum: - no_match - match - partial_match_address - partial_match_postcode - unavailable cvv_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. - `no_match` - the CVV does not match the expected value - `match` - the CVV matches the expected value - `unavailable ` - CVV check unavailable for card our country - `not_provided ` - CVV not provided The value of this field can be `null` if the payment service did not provide a response.' example: match enum: - no_match - match - unavailable payment_method_scheme: description: The card scheme sent to the connector. type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null ThreeDSecureRequestErrorEvent: title: 3DS - Error type: object description: Error details for a failed 3DS call. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `three-d-secure-request-error`. example: three-d-secure-request-error enum: - three-d-secure-request-error created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: 3DS post-authentication context. properties: url: type: string description: The URL that was called for this request. example: https://3dserver.example/auth reason: type: string description: The reason for the error. example: TIMEOUT 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. 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' TransactionSummary: title: Transaction type: object description: A transaction record. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction`. example: transaction enum: - transaction id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this transaction. format: uuid amount: description: 'The authorized amount for this transaction. This can be more than the actual captured amount and part of this amount may be refunded.' example: 1299 maximum: 99999999 minimum: 0 type: integer authorized_amount: description: 'The amount for this transaction that has been authorized for the `payment_method`. This can be less than the `amount` if gift cards were used.' example: 1299 maximum: 99999999 minimum: 0 type: integer buyer: allOf: - $ref: '#/components/schemas/Buyer--Snapshot' description: The buyer used for this transaction. captured_amount: description: 'The captured amount for this transaction. This can be the full value of the `authorized_amount` or less.' example: 999 maximum: 99999999 minimum: 0 type: integer checkout_session_id: description: The identifier for the checkout session this transaction is associated with. example: fe26475d-ec3e-4884-9553-f7356683f7f9 format: uuid type: - string - 'null' 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' created_at: description: The date and time when this transaction was created in our system. example: '2013-07-16T19:23:00.000+00:00' format: date-time type: string currency: description: The currency code for this transaction. example: USD type: string external_identifier: description: An external identifier that can be used to match the transaction against your own records. example: user-789123 type: - string - 'null' gift_card_redemptions: description: The gift cards redeemed for this transaction. items: $ref: '#/components/schemas/GiftCardRedemption' type: array instrument_type: type: - string - 'null' description: 'The name of the instrument used to process the transaction. ' enum: - applepay - card_token - googlepay - network_token - pan - redirect - redirect_token example: network_token intent: description: 'The original `intent` used when the transaction was [created](#operation/authorize-new-transaction).' enum: - authorize - capture example: authorize type: string merchant_account_id: description: The ID of the merchant account to which this transaction belongs to. example: default maximum: 22 minimum: 1 type: string method: type: - string - 'null' example: card enum: - affirm - afterpay - alipay - alipayhk - applepay - bacs - bancontact - banked - becs - bitpay - boleto - boost - card - cashapp - chaseorbital - checkout-session - clearpay - click-to-pay - dana - dcb - dlocal - ebanx - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - googlepay - googlepay_pan_only - gopay - grabpay - id - ideal - kakaopay - kcp - klarna - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - network-token - oney_3x - oney_4x - oney_6x - oney_10x - oney_12x - ovo - oxxo - payid - paymaya - paypal - paypalpaylater - payto - venmo - pix - pse - rabbitlinepay - razorpay - scalapay - sepa - shopeepay - singteldash - smartpay - sofort - spei - stripedd - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - vipps - waave - webpay - wechat - zippay payment_method: allOf: - $ref: '#/components/schemas/PaymentMethod--Snapshot' description: The payment method used for this transaction. payment_service: allOf: - $ref: '#/components/schemas/PaymentService--Snapshot' description: The payment service used for this transaction. pending_review: description: Whether a manual review is pending. example: true type: boolean raw_response_code: description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip type: - string - 'null' raw_response_description: description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' type: - string - 'null' reconciliation_id: description: 'The base62 encoded transaction ID. This represents a shorter version of this transaction''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 transaction against our system. This ID is sent instead of the transaction ID because not all services support 36 digit identifiers.' example: 7jZXl4gBUNl0CnaLEnfXbt type: string refunded_amount: description: 'The refunded amount for this transaction. This can be the full value of the `captured_amount` or less.' example: 100 maximum: 99999999 minimum: 0 type: integer status: description: 'The status of the transaction. The status may change over time as asynchronous processing events occur.' enum: - processing - buyer_approval_pending - authorization_succeeded - authorization_failed - authorization_declined - capture_pending - capture_succeeded - authorization_void_pending - authorization_voided example: processing type: string updated_at: description: Defines when the transaction was last updated. example: '2013-07-16T19:23:00.000+00:00' format: date-time type: string settled_currency: description: 'The currency of this transaction''s settlement in ISO 4217 three-letter code format.' example: GBP type: - string - 'null' settled_amount: description: The net amount settled for this transaction. example: 1000 type: integer settled: description: Indicates whether this transaction has been settled. example: true type: boolean AntiFraudDecisionUpdateErrorEvent: title: Anti-fraud - Decision update failed type: object description: This event logs the failure reason when attempting to update the decision on the anti-fraud provider. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-decision-update-error`. example: anti-fraud-decision-update-error enum: - anti-fraud-decision-update-error created_at: type: string description: The date and time when this transaction event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. anti_fraud_service_check_id: type: string description: The external ID of the decision. example: decision-1234 decision: type: string description: The updated decision sent to the anti-fraud provider. example: ACCEPT reason: type: string description: The reason we could not update the anti-fraud decision. example: Network Error silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' GiftCardRedemptionFailed: title: Gift Cards Redemption - Failure type: object description: This event logs the request and response details of HTTP calls made to redeem gift cards, in case the call failed. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `gift-card-redemption-failed`. example: gift-card-redemption-failed enum: - gift-card-redemption-failed created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: gift_card_service_id: type: string format: uuid description: The unique ID of the Gift Card service used. gift_card_service_name: type: string description: The name of the Gift Card service used. gift_card_service_definition_id: type: string description: The Gift Card service definition used. url: type: - string - 'null' description: The endpoint for the request, if performed. request: type: - string - 'null' description: The HTTP body sent to the Gift Card provider, if performed. response: type: - string - 'null' description: The HTTP body received from the Gift Card provider, if any. response_status_code: type: - number - 'null' description: The HTTP response status code from the Gift Card provider, if any. reason: type: string description: The reason we could not redeem the gift cards. example: Network Error Error409DuplicateRecord: title: Duplicate Record Error type: object description: Duplicate Record Error (HTTP 409). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: '`duplicate_record`.' example: duplicate_record enum: - duplicate_record status: type: integer description: '`409`.' example: 409 enum: - 409 message: type: string description: Further details on the field that triggered the error. example: A duplicate record exists with this external_identifier value 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' TransactionGiftCardStoredRequest: title: Transaction gift card request (Stored) type: object description: Create a transaction with a stored gift card. x-tags: - Request Bodies required: - amount - id properties: id: type: string format: uuid example: e6cdf979-87e2-4796-8ff6-9784d5aed893 description: The ID of the gift card to check a balance for. amount: description: 'The monetary amount to charge for this gift card, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`. All gift card amounts are subtracted from the total transaction amount. The remainder is charged to the provided `payment_method`.' type: integer example: 1299 minimum: 1 maximum: 99999999 GiftCardService--Snapshot: title: Gift card service (Snapshot) type: object description: A snapshot of a gift card service used in a transaction. x-tags: - Gift Card Services properties: type: type: string description: The type of this resource. example: gift-card-service enum: - gift-card-service id: type: string format: uuid description: The ID of this gift card service. example: 6c020bf3-179b-4f4f-858d-84e39e196e0f gift_card_service_definition_id: type: string description: 'The ID of the gift card service definition used to create this service. ' example: qwikcilver-gift-card minLength: 1 maxLength: 50 display_name: type: string description: The custom name set for this service. example: Qwikcilver UK minLength: 1 maxLength: 200 Recipient--Snapshot: title: Recipient (Snapshot) type: object description: 'Snapshot of a recipient of an account funding transaction, as used when embedded inside other resources.' x-tags: - Transactions properties: first_name: type: - string - 'null' minLength: 1 maxLength: 255 description: The first name(s) or given name for the recipient. example: John last_name: type: - string - 'null' minLength: 1 maxLength: 255 example: Lunn description: The last name, or family name, of the recipient. address: type: - object - 'null' description: The billing address for the recipient. allOf: - $ref: '#/components/schemas/Address' - required: - line1 - city - state - postal_code - country account_number: type: - string - 'null' minLength: 1 maxLength: 255 example: '1234567' description: The destination account number to receive an account funding transaction. date_of_birth: type: - string - 'null' description: The recipient's date of birth. format: date example: '1996-08-31' ThreeDSecureError: title: 3-D Secure Error Data type: object description: Details about the error resulting from 3DS processing a Transaction. x-tags: - Transactions required: - description - detail - component - code properties: description: type: - string - 'null' description: The error description. example: Invalid ThreeDSCompInd maxLength: 2048 detail: type: - string - 'null' description: Detail for the error. example: The threeDSCompInd must be 'Y' when successful maxLength: 2048 code: type: - string - 'null' description: The error code. example: '305' maxLength: 3 minLength: 3 component: type: - string - 'null' minLength: 1 maxLength: 1 description: Code indicating the 3-D Secure component that identified the error.. example: C TransactionAPIResponse: title: Transaction API Response type: object description: Details related to transaction API response. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `transaction-api-response`. example: transaction-api-response enum: - transaction-api-response created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Event context. properties: url: type: string description: The URL requested. example: https://api.spider.gr4vy.app/transactions method: type: string description: The HTTP method. example: POST response: type: string description: The body of the response. example: '{''foo'': ''bar''}' response_status_code: type: number description: The request status code. example: 200 latency: type: number description: The time taken to process the request in milliseconds. example: 123 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' NetworkTokenProvisionFailed: title: Network Token Provision - Failure type: object description: This event logs the request and response details of HTTP calls made to provision a network token, in case the call failed. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `network-token-provision-failed`. example: network-token-provision-failed enum: - network-token-provision-failed created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: url: type: - string - 'null' description: The endpoint for the request, if performed. request: type: - string - 'null' description: The HTTP body sent to the Network Token provider, if performed. response: type: - string - 'null' description: The HTTP body received from the Network Token provider, if any. response_status_code: type: - number - 'null' description: The HTTP response status code from the Network Token provider, if any. reason: type: string description: The reason we could not provision the network token. example: Network Error AirlineLeg: title: Airline Addendum Leg type: object description: Each of the separate trip segment, contains detailed itinerary information. properties: carrier_code: type: - string - 'null' minLength: 2 maxLength: 2 description: 2 character airline code as set by IATA. example: LY carrier_name: type: - string - 'null' minLength: 1 maxLength: 100 description: The name of the airline. example: El Al Israel Airlines iata_designator: type: - string - 'null' minLength: 2 maxLength: 2 description: 2 character IATA code of the airline. example: LY icao_code: type: - string - 'null' minLength: 3 maxLength: 3 description: 3 character ICAO code of the airline. example: ELY flight_number: type: - string - 'null' minLength: 3 maxLength: 6 description: Unique identifier of the flight number. example: BA98 departure_at: type: - string - 'null' format: date-time description: The date and time of travel in local time at the departure airport. example: '2013-07-16T19:23:00.000+00:00' departure_country: type: - string - 'null' minLength: 2 maxLength: 2 description: Departure country code in ISO 3166 format. example: UK departure_city: type: - string - 'null' minLength: 1 maxLength: 100 description: Departure city name. example: London departure_airport: type: - string - 'null' minLength: 3 maxLength: 3 description: 'Departure airport code of leg. 3-letter ISO code according to IATA official directory.' example: LHR arrival_at: type: - string - 'null' format: date-time description: The date and time of travel in local time at the arrival airport. example: '2013-07-16T19:23:00.000+00:00' arrival_country: type: - string - 'null' minLength: 2 maxLength: 2 description: Arrival country code in ISO 3166 format. example: UK arrival_city: type: - string - 'null' minLength: 1 maxLength: 100 description: Arrival city name. example: London arrival_airport: type: - string - 'null' minLength: 3 maxLength: 3 description: 'Arrival airport code of leg. 3-letter ISO code according to IATA official directory.' example: LHR fare_basis_code: type: - string - 'null' minLength: 1 maxLength: 8 description: The alphanumeric code for the "booking class" of a ticket. example: WH7LNR flight_class: type: - string - 'null' minLength: 1 maxLength: 5 description: Indicates service class (first class, business class, etc.). example: E stop_over: type: - boolean - 'null' description: Indicates whether a stopover is allowed on this ticket. example: false route_type: type: string description: The route type of the flight. enum: - round_trip - one_way example: round_trip coupon_number: type: - string - 'null' minLength: 1 maxLength: 50 description: Coupon number associated with the leg. example: '15885566' fare_amount: type: - integer - 'null' description: Amount of the ticket, for current leg of the trip, excluding taxes and fees. minimum: 0 maximum: 99999999 example: 100 fee_amount: type: - integer - 'null' description: Fee amount for current leg of the trip. minimum: 0 maximum: 99999999 example: 100 tax_amount: type: - integer - 'null' description: Amount of the taxes for current leg of the trip. minimum: 0 maximum: 99999999 example: 100 departure_tax_amount: type: - integer - 'null' description: 'Departure tax amount charged by a country when a person is leaving the country.' minimum: 0 maximum: 99999999 example: 100 seat_class: type: - string - 'null' minLength: 1 maxLength: 5 description: Indicates seat class (first class, business class, etc.). example: F TransactionCardRequest: title: Card type: object description: Card payment method details to use in a transaction. x-tags: - Request Bodies required: - method - number - expiration_date properties: method: type: string description: '`card`.' example: card enum: - card number: type: string minLength: 13 maxLength: 19 example: '4111111111111111' pattern: ^[0-9]{13,19}$ description: 'The 13-19 digit number for this card as it can be found on the front of the card.' expiration_date: type: string description: The expiration date of the card, formatted `MM/YY`. example: 11/25 pattern: ^\d{2}/\d{2}$ minLength: 5 maxLength: 5 security_code: type: - string - 'null' description: 'The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD.' pattern: ^\d{3,4}$ minLength: 3 maxLength: 4 example: '123' external_identifier: type: - string - 'null' description: An external identifier that can be used to match the card against your own records. This can only be set if the `store` flag is set to `true`. example: card-323444 redirect_url: type: - string - 'null' format: uri description: 'We strongly recommend providing a `redirect_url` either when 3-D Secure is enabled and `three_d_secure_data` is not provided, or when using connections where 3DS is enabled. This value will be appended with both a transaction ID and status (e.g. `https://example.com/callback?gr4vy_transaction_id=123 &gr4vy_transaction_status=capture_succeeded`) after 3-D Secure has completed. For those cases, if the value is not present, the transaction will be marked as failed.' example: https://example.com/callback ApplePayRequest: title: Apple Pay payment method request type: object description: Details for a Apple Pay payment method. x-tags: - Request Bodies required: - method - token properties: method: type: string description: '`applepay`.' example: applepay enum: - applepay token: type: object description: 'The encrypted (opaque) token that was passed to the `onpaymentauthorized` callback by the Apple Pay integration.' card_suffix: type: - string - 'null' description: Last 4 digits of the PAN for identification purposes. example: '1234' card_scheme: type: - string - 'null' description: The scheme/brand of the card. card_type: type: - string - 'null' description: The type of card. example: credit PaymentMethodDetailsCard: title: Card description: A credit or debit card payment method. type: object x-tags: - Payment Methods properties: bin: type: string description: The first 6 digits of the full card number (the BIN). example: '412345' card_type: description: The type of card, one of `credit`, `debit` or `prepaid`. example: credit type: string enum: - credit - debit - prepaid card_issuer_name: type: string description: The name of the card issuer. example: Bank PaymentConnectorResponseTransactionCaptureDeclinedEvent: title: Capture - Declined type: object description: 'This event logs the exact details parsed details for a declined capture as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-capture-declined`. example: payment-connector-response-transaction-capture-declined enum: - payment-connector-response-transaction-capture-declined created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 code: type: - string - 'null' description: A raw response code returned for the failure. example: INVALID DATA raw_response_code: type: - string - 'null' description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip raw_response_description: type: - string - 'null' description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' auth_response_code: description: This is the response description received from the processor. example: '00' type: - string - 'null' avs_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. - `no_match` - neither address or postal code match - `match` - both address and postal code match - `partial_match_address` - address matches but postal code does not - `partial_match_postcode` - postal code matches but address does not - `unavailable ` - AVS is unavailable for card/country The value of this field can be `null` if the payment service did not provide a response.' example: partial_match_address enum: - no_match - match - partial_match_address - partial_match_postcode - unavailable cvv_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. - `no_match` - the CVV does not match the expected value - `match` - the CVV matches the expected value - `unavailable ` - CVV check unavailable for card our country - `not_provided ` - CVV not provided The value of this field can be `null` if the payment service did not provide a response.' example: match enum: - no_match - match - unavailable payment_method_scheme: description: The card scheme sent to the connector. type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null 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' FlowRuleServiceOutcome: title: Payment service outcome type: object description: 'Defines the outcome of a rule in a flow where the result is a list of dictionaries that define the payment service, instrument and transformation to be used to process a transaction.' x-tags: - Flow required: - type - result - version x-internal: true properties: type: type: string description: The type of action outcome for the given rule. example: card-routing enum: - card-routing result: type: array description: Results for a given flow action. items: type: object properties: payment_service_id: type: string description: ID of the payment service to be used when processing the transaction. example: fe26475d-ec3e-4884-9553-f7356683f7f9 format: uuid instrument: type: string description: 'The name of the instrument to be used to process the transaction. For `pan`, if a Payment Service token is available, the API will use that for stored payment methods. ' enum: - network_token - pan example: network_token transformations: type: array description: List of transformations to apply when processing the transaction. items: type: object properties: name: type: string description: Name of the transformation. example: force_mit enum: - force_mit - use_additional_scheme example: - payment_service_id: fe26475d-ec3e-4884-9553-f7356683f7f9 instrument": network_token transformations: [] - payment_service_id: d88aca32-07fb-46cd-a43f-86da02b73c21 instrument: pan transformations: - name: force_mit version: type: integer description: Version of the rule outcome. Current version is `2`. example: 2 enum: - 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 TransactionGiftCardNewRequest: title: Transaction gift card request (New) type: object description: Create a transaction with this gift card. x-tags: - Request Bodies required: - amount - number - pin properties: number: type: string minLength: 16 maxLength: 19 example: '4123455541234561234' pattern: ^[0-9]{16,19}$ description: The 16-19 digit number for this gift card. pin: type: string description: The PIN for this gift card. example: '1234' amount: description: 'The monetary amount to charge for this gift card, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`. All gift card amounts are subtracted from the total transaction amount. The remainder is charged to the provided `payment_method`.' type: integer example: 1299 minimum: 1 maximum: 99999999 Recipient: title: Recipient type: object description: The recipient of an account funding transaction. x-tags: - Transactions properties: first_name: type: - string - 'null' minLength: 1 maxLength: 255 description: The first name(s) or given name for the recipient. example: John last_name: type: - string - 'null' minLength: 1 maxLength: 255 example: Lunn description: The last name, or family name, of the recipient. address: type: - object - 'null' description: The billing address for the recipient. allOf: - $ref: '#/components/schemas/Address' - required: - line1 - city - state - postal_code - country account_number: type: - string - 'null' minLength: 1 maxLength: 255 example: '1234567' description: The destination account number to receive an account funding transaction. date_of_birth: type: - string - 'null' description: The recipient's date of birth. format: date example: '1996-08-31' 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' AntiFraudDecisionSkippedEvent: title: Anti-fraud - Skipped type: object description: This event logs the reason why we skipped getting an anti-fraud decision. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-decision-skipped`. example: anti-fraud-decision-skipped enum: - anti-fraud-decision-skipped created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. reason: type: string description: The reason we could not get the anti-fraud decision. example: Missing billing address silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' 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 Refunds: title: Refunds type: object description: A list of refunds. x-tags: - Transactions properties: items: type: array description: A list of refunds. items: $ref: '#/components/schemas/Refund' 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 TransactionAPIRequest: title: Transaction API Request type: object description: Details related to transaction API request. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `transaction-api-request`. example: transaction-api-request enum: - transaction-api-request created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Event context. properties: url: type: string description: The URL requested. example: https://api.spider.gr4vy.app/transactions method: type: string description: The HTTP method. example: POST request: type: - string - 'null' description: The body of the request. example: '{''foo'': ''bar''}' request_headers: type: object description: The request headers received. example: idempotency-key: 50e4bb08-b5e1-40b4-ac60-ea5f4df385cf auth: type: object description: Details of the JWT used for authentication. properties: token: type: - string - 'null' description: JWT provided on request without signature. header: type: - object - 'null' description: Claims of JWT. example: alg: HS256 typ: JWT payload: type: - object - 'null' description: Payload of JWT. example: sub: '1234567890' Action: title: Action type: object description: An action taken for a transaction. x-tags: - Transactions x-internal: true properties: type: type: string description: The type of this resource. Is always `action`. example: action enum: - action id: type: string description: The identifier for the action. example: route-transaction enum: - decline-early - route-transaction - skip-3ds flow: type: string description: The name of the Flow. example: checkout enum: - checkout - card-transaction - non-card-transaction - redirect-transaction rule_id: type: string description: The unique ID of the rule triggered. example: 8724fd24-5489-4a5d-90fd-0604df7d3b85 format: uuid created_at: type: string format: date-time example: '2012-12-12T10:53:43+00:00' description: The date and time when this action was created. outcome: description: The outcome of the action. oneOf: - $ref: '#/components/schemas/FlowRuleBooleanOutcome' - $ref: '#/components/schemas/FlowRuleMethodOutcome' - $ref: '#/components/schemas/FlowRuleServiceOutcome' - $ref: '#/components/schemas/FlowRuleUUIDsListOutcome' DigitalWalletClickToPayTokenDecrypted: title: Digital wallet Click to Pay token decrypted type: object description: The result after decrypting an Click to Pay token. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `digital-wallet-click-to-pay-token-decrypted`. example: digital-wallet-click-to-pay-token-decrypted enum: - digital-wallet-click-to-pay-token-decrypted created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Click to Pay decrypted token context. properties: correlation_id: type: string description: Correlation ID for transaction. example: ba7a2034-3c9e-4d74-b0e9-d77435fd35d7 merchant_transaction_id: type: string description: Merchant Checkout Transaction Identifier which links the client-side JavaScript calls and server-side API calls for a specific transaction. example: 0a4e0d3.34f4a04b.47ee82c373dd4fd5398f3980b39eb6d648b9687c type: type: string description: The type of payment instrument. enum: - dpan - fpan example: dpan expiration_date: type: string description: Expiration of the card/token. has_cryptogram: type: boolean description: Online payment cryptogram, as defined by 3-D Secure. cardholder_name: type: - string - 'null' description: The cardholder name. card_bin: type: - string - 'null' description: First six digits of underlying card. example: '424242' card_last_four: type: - string - 'null' description: Last four digits of underlying card. card_expiration_date: type: - string - 'null' description: Expiration date of underlying card. card_type: type: - string - 'null' description: Card type. example: CREDIT billing_line1: type: - string - 'null' description: Address line 1. billing_line2: type: - string - 'null' description: Address line 2. billing_city: type: - string - 'null' description: Address city. billing_state: type: - string - 'null' description: Address state. billing_zip: type: - string - 'null' description: Address zip/postal code. billing_country_code: type: - string - 'null' description: ISO 3166-1 alpha 2 address country code. ThreeDSecureSummary: title: 3-D Secure data type: object description: 'The 3-D Secure data that was sent to the payment service for the transaction.' properties: version: type: string description: The version of 3DS used for this transaction. pattern: ^[1-2].?[\d+.?]{0,3}$ example: 2.1.0 status: type: string description: The status of the 3DS challenge for this transaction. enum: - setup_error - error - declined - cancelled - complete method: type: string description: The method used for 3DS authentication for this transaction. enum: - challenge - frictionless error_data: type: - object - 'null' description: 'The error data received from our 3DS server. This will not be populated if the customer failed the authentication with a status code of `N`, `R`, or `U`. To see full details about the 3DS calls in those situations please use our transaction events API.' allOf: - $ref: '#/components/schemas/ThreeDSecureError' response_data: type: - object - 'null' description: 'The 3DS data sent to the payment service for this transaction. This will only be populated if external 3DS data was passed in directly as part of the transaction API call, or if our 3DS server returned a status code of `Y` or `A`. In case of a failure to authenticate (status `N`, `R`, or `U`) this field will not be populated. To see full details about the 3DS calls please use our transaction events API.' x-model-name: ThreeDSecureDataV1V2 oneOf: - $ref: '#/components/schemas/ThreeDSecureDataV1' - $ref: '#/components/schemas/ThreeDSecureV2' 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 ThreeDSecureAuthenticationRequestEvent: title: 3DS - Authentication type: object description: The result and raw data for a 3DS authorization call. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `three-d-secure-authentication-request`. example: three-d-secure-authentication-request enum: - three-d-secure-authentication-request created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: 3DS authentication context. properties: url: type: string description: The URL that was called for this request. example: https://3dserver.example/auth request: type: string description: The request body sent to the `url`. example: '{}' response: type: string description: The response body received from the `url`. example: '{}' response_status_code: type: integer description: The response status code received from the `url`. example: 200 cavv: type: string description: The 3DS CAVV value parsed from the `response`. example: +9YDsoSIbiEgO+PFMdgGSF17Uqk= eci: type: string description: The 3DS ECI value parsed from the `response`. example: '05' directory_response: type: string description: The `transStatus` parsed from the `response`. example: C directory_transaction_id: type: string description: The `dsTransID` parsed from the `response`. example: 8875884a-ac2f-42cb-b3f0-09b3ea3c0042 version: type: string description: The version of 3DS used. example: 2.2.0 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}$ PaymentConnectorResponseTransactionCaptureFailedEvent: title: Capture - Failed type: object description: 'This event logs the exact details parsed details for a failed capture as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-capture-failed`. example: payment-connector-response-transaction-capture-failed enum: - payment-connector-response-transaction-capture-failed created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 code: type: - string - 'null' description: A raw response code returned for the failure. example: INVALID DATA raw_response_code: type: - string - 'null' description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip raw_response_description: type: - string - 'null' description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' auth_response_code: description: This is the response description received from the processor. example: '00' type: - string - 'null' avs_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. - `no_match` - neither address or postal code match - `match` - both address and postal code match - `partial_match_address` - address matches but postal code does not - `partial_match_postcode` - postal code matches but address does not - `unavailable ` - AVS is unavailable for card/country The value of this field can be `null` if the payment service did not provide a response.' example: partial_match_address enum: - no_match - match - partial_match_address - partial_match_postcode - unavailable cvv_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. - `no_match` - the CVV does not match the expected value - `match` - the CVV matches the expected value - `unavailable ` - CVV check unavailable for card our country - `not_provided ` - CVV not provided The value of this field can be `null` if the payment service did not provide a response.' example: match enum: - no_match - match - unavailable payment_method_scheme: description: The card scheme sent to the connector. type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null TransactionNetworkTokenGooglePayRequest: title: Google Pay decrypted token type: object description: Details for a Google Pay decrypted token payment method. x-tags: - Request Bodies required: - method - token - expiration_date - card_source properties: method: type: string description: '`network-token`.' example: network-token enum: - network-token token: type: string description: The value of the decrypted Apple Pay token. expiration_date: type: string description: The expiration date of the network token, formatted `MM/YY`. example: 11/25 pattern: ^\d{2}/\d{2}$ minLength: 5 maxLength: 5 cryptogram: type: - string - 'null' description: The cryptogram of the network token. eci: type: string pattern: ^0?\d$ minLength: 1 maxLength: 2 description: The ecommerce indicator for 3D-Secure. example: '05' card_source: type: string example: google-pay enum: - google-pay card_suffix: type: - string - 'null' example: '1234' maxLength: 4 description: Last four digits of card PAN. card_scheme: type: - string - 'null' description: The scheme/brand of the card. cardholder_name: type: - string - 'null' description: The cardholder name. TokenizedRequest: title: Stored payment method request type: object description: Details for a previously stored payment method. x-tags: - Request Bodies required: - method - id properties: method: type: string description: '`id`.' example: id enum: - id id: type: string description: 'A ID that represents a previously stored payment method. This ID can represent any type of payment method.' example: 46973e9d-88a7-44a6-abfe-be4ff0134ff4 redirect_url: type: string format: uri description: 'This value is mandatory for stored redirect payment methods. For stored cards, we strongly recommend providing a `redirect_url` either when 3-D Secure is enabled and `three_d_secure_data` is not provided, or when using connections where 3DS is enabled. This value will be appended with both a transaction ID and status (e.g. `https://example.com/callback?gr4vy_transaction_id=123 &gr4vy_transaction_status=capture_succeeded`) after 3-D Secure has completed. For those cases, if the value is not present, the transaction will be marked as failed.' example: https://example.com/callback security_code: type: - string - 'null' description: 'The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD. The security code can only be set if the stored payment method represents a card.' pattern: ^\d{3,4}$ minLength: 3 maxLength: 4 example: '123' Error429TooManyRequests: title: Too Many Requests Error type: object description: Too Many Requests Error (HTTP 429). x-tags: - Errors properties: type: type: string description: '`error`.' enum: - error example: error code: type: string description: '`too_many_requests`.' example: too_many_requests enum: - too_many_requests status: type: integer description: '`429`.' example: 429 enum: - 429 message: type: string description: Further details on the field that triggered the error. example: Too many requests 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' Transaction: title: Transaction type: object description: A transaction record. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction`. example: transaction enum: - transaction id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this transaction. format: uuid amount: description: 'The total amount for this transaction across all funding sources including gift cards.' example: 1299 maximum: 99999999 minimum: 0 type: integer additional_identifiers: description: 'A list of additional identifiers that we may keep track of to manage this transaction. This may include the authorization ID, capture ID, and processor ID, as well as an undefined list of additional identifiers.' allOf: - $ref: '#/components/schemas/AdditionalIdentifiers' auth_response_code: description: This is the response description received from the processor. example: '00' type: - string - 'null' authorized_amount: description: 'The amount for this transaction that has been authorized for the `payment_method`. This can be less than the `amount` if gift cards were used.' example: 1299 maximum: 99999999 minimum: 0 type: integer authorized_at: description: 'The date and time when this transaction was authorized in the payment service. Don''t use this field to determine whether the transaction was authorized. A `null` value doesn''t necessarily imply that the transaction wasn''t authorized, it can mean that the payment service doesn''t provide this value, that it didn''t provide it at the time the transaction was authorized or that the transaction was authorized before the introduction of this field.' example: '2013-07-16T19:23:00.000+00:00' format: date-time type: - string - 'null' approval_expires_at: description: 'The date and time when this transaction will be marked as failed if it does not successfully gets captured, authorized or otherwise approved before.' example: '2013-07-16T19:23:00.000+00:00' format: date-time type: - string - 'null' avs_response_code: description: 'The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. - `no_match` - neither address or postal code match - `match` - both address and postal code match - `partial_match_address` - address matches but postal code does not - `partial_match_postcode` - postal code matches but address does not - `unavailable ` - AVS is unavailable for card/country The value of this field can be `null` if the payment service did not provide a response.' enum: - no_match - match - partial_match_address - partial_match_postcode - unavailable example: partial_match_address type: - string - 'null' buyer: allOf: - $ref: '#/components/schemas/Buyer--Snapshot' description: The buyer used for this transaction. captured_amount: description: 'The captured amount for this transaction. This can be the full value of the `authorized_amount` or less.' example: 999 maximum: 99999999 minimum: 0 type: integer captured_at: description: 'The date and time when this transaction was captured in the payment service. Don''t use this field to determine whether the transaction was captured. A `null` value doesn''t necessarily imply that the transaction wasn''t captured, it can mean that the payment service doesn''t provide this value, that it didn''t provide it at the time the transaction was captured or that the transaction was captured before the introduction of this field.' example: '2013-07-16T19:23:00.000+00:00' format: date-time type: - string - 'null' cart_items: description: An array of cart items that represents the line items of a transaction. items: $ref: '#/components/schemas/CartItem' maxLength: 249 type: array checkout_session_id: description: The identifier for the checkout session this transaction is associated with. example: fe26475d-ec3e-4884-9553-f7356683f7f9 format: uuid type: - string - 'null' 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' created_at: description: The date and time when this transaction was created in our system. example: '2013-07-16T19:23:00.000+00:00' format: date-time type: string currency: description: The currency code for this transaction. example: USD type: string cvv_response_code: description: 'The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. - `no_match` - the CVV does not match the expected value - `match` - the CVV matches the expected value - `unavailable ` - CVV check unavailable for card our country - `not_provided ` - CVV not provided The value of this field can be `null` if the payment service did not provide a response.' enum: - no_match - match - unavailable - not_provided example: match type: - string - 'null' error_code: description: This is an error code set by Gr4vy. example: missing_redirect_url type: - string - 'null' external_identifier: description: An external identifier that can be used to match the transaction against your own records. example: user-789123 type: - string - 'null' gift_card_service: allOf: - $ref: '#/components/schemas/GiftCardService--Snapshot' description: The gift card service used for this transaction. gift_card_redemptions: description: The gift cards redeemed for this transaction. items: $ref: '#/components/schemas/GiftCardRedemption' type: array instrument_type: type: - string - 'null' description: 'The name of the instrument used to process the transaction. ' enum: - applepay - card_token - googlepay - network_token - pan - redirect - redirect_token example: network_token intent: description: 'The original `intent` used when the transaction was [created](#operation/authorize-new-transaction).' enum: - authorize - capture example: authorize type: string intent_outcome: description: 'The outcome of the original intent of a transaction. This allows you to understand if the intent of the transaction (e.g. `capture` or `authorize`) has been achieved when dealing with multiple payment instruments. If all payment instruments (`payment_method` and/or `gift_cards`) have succeeded to get an authorization or direct sale **at any point in time** then this will return a `succeeded` value. If any of the payment instruments fails or declines then this will return a `failed` value. If any payment instruments is still in a `pending` or `processing` state then the result will be `pending`. Please note that if any of the payment instruments are voided or refunded after the result reaches a `succeeded` state then the result will remain unchanged.' enum: - pending - succeeded - failed example: pending type: string is_subsequent_payment: default: false description: 'Indicates whether the transaction represents a subsequent payment coming from a setup recurring payment. Please note there are some restrictions on how this flag may be used. The flag can only be `false` (or not set) when the transaction meets one of the following criteria: * It is not `merchant_initiated`. * `payment_source` is set to `card_on_file`. The flag can only be set to `true` when the transaction meets one of the following criteria: * It is not `merchant_initiated`. * `payment_source` is set to `recurring` or `installment` and `merchant_initiated` is set to `true`. * `payment_source` is set to `card_on_file`.' example: true type: boolean merchant_account_id: description: The ID of the merchant account to which this transaction belongs to. example: default maximum: 22 minimum: 1 type: string merchant_initiated: default: false description: 'Indicates whether the transaction was initiated by the merchant (true) or customer (false).' example: true type: boolean metadata: additionalProperties: type: string description: Additional information about the transaction stored as key-value pairs. example: key: value type: object method: type: - string - 'null' example: card enum: - affirm - afterpay - alipay - alipayhk - applepay - bacs - bancontact - banked - becs - bitpay - boleto - boost - card - cashapp - chaseorbital - checkout-session - clearpay - click-to-pay - dana - dcb - dlocal - ebanx - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - googlepay - googlepay_pan_only - gopay - grabpay - id - ideal - kakaopay - kcp - klarna - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - network-token - oney_3x - oney_4x - oney_6x - oney_10x - oney_12x - ovo - oxxo - payid - paymaya - paypal - paypalpaylater - payto - venmo - pix - pse - rabbitlinepay - razorpay - scalapay - sepa - shopeepay - singteldash - smartpay - sofort - spei - stripedd - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - vipps - waave - webpay - wechat - zippay multi_tender: description: 'Defines if this transaction has been split across multiple payment instruments such as a `payment_method` and one or more `gift_cards`, or multiple `gift_cards` without a `payment_method`.' example: true type: boolean payment_method: allOf: - $ref: '#/components/schemas/PaymentMethod--Snapshot' description: The payment method used for this transaction. payment_service: allOf: - $ref: '#/components/schemas/PaymentService--Snapshot' description: The payment service used for this transaction. payment_service_transaction_id: description: The payment service's unique ID for the transaction. example: charge_xYqd43gySMtori type: string payment_source: description: The source of the transaction. Defaults to `ecommerce`. type: string example: recurring enum: - ecommerce - moto - recurring - installment - card_on_file pending_review: description: Whether a manual review is pending. example: true type: boolean anti_fraud_decision: description: 'The mapped decision received from the anti-fraud service. In case of a review decision this field is not updated once the review is resolved.' type: - string - 'null' example: accept enum: - accept - error - exception - reject - review - skipped raw_response_code: description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip type: - string - 'null' raw_response_description: description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' type: - string - 'null' reconciliation_id: description: 'The base62 encoded transaction ID. This represents a shorter version of this transaction''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 transaction against our system. This ID is sent instead of the transaction ID because not all services support 36 digit identifiers.' example: 7jZXl4gBUNl0CnaLEnfXbt type: string refunded_amount: description: 'The refunded amount for this transaction. This can be the full value of the `captured_amount` or less.' example: 100 maximum: 99999999 minimum: 0 type: integer scheme_transaction_id: default: null description: 'An identifier for the transaction used by the scheme itself, when available. e.g. the Visa Transaction Identifier, or Mastercard Trace ID.' example: '123456789012345' type: - string - 'null' shipping_details: allOf: - $ref: '#/components/schemas/ShippingDetail' description: The shipping details associated with the transaction. statement_descriptor: allOf: - $ref: '#/components/schemas/StatementDescriptor' status: description: 'The status of the transaction for the `payment_method`. The status may change over time as asynchronous processing events occur. Please note that the possible statuses returned will depend on the operation performed. For example, a captured transaction will never move to a `authorization_voided` status.' enum: - processing - buyer_approval_pending - authorization_succeeded - authorization_failed - authorization_declined - capture_pending - capture_succeeded - authorization_void_pending - authorization_voided example: processing type: string three_d_secure: $ref: '#/components/schemas/ThreeDSecureSummary' airline: description: Contains information about an airline travel, if applicable. allOf: - $ref: '#/components/schemas/Airline' updated_at: description: Defines when the transaction was last updated. example: '2013-07-16T19:23:00.000+00:00' format: date-time type: string voided_at: description: 'The date and time when this transaction was voided in the payment service. Don''t use this field to determine whether the transaction was voided. A `null` value doesn''t necessarily imply that the transaction wasn''t voided, it can mean that the payment service doesn''t provide this value, that it didn''t provide it at the time the transaction was voided or that the transaction was voided before the introduction of this field.' example: '2013-07-16T19:23:00.000+00:00' format: date-time type: - string - 'null' settled_currency: description: 'The currency of this transaction''s settlement in ISO 4217 three-letter code format.' example: GBP type: - string - 'null' settled_amount: description: The net amount settled for this transaction. example: 1000 type: integer settled: description: Indicates whether this transaction has been settled. example: true type: boolean account_funding_transaction: type: - boolean - 'null' default: false description: Whether or not the transaction is an account funding transaction. example: true recipient: type: - object - 'null' allOf: - $ref: '#/components/schemas/Recipient--Snapshot' description: The recipient of an account funding transaction. merchant_advice_code: type: - string - 'null' description: 'The merchant advice code received from the payment service. This code is used to provide additional information about the card used.' example: '01' GiftCardRefundFailed: title: Gift Cards Refund - Failed type: object description: This event logs the request and response details of HTTP calls made to refund gift cards, in case the call failed. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `gift-card-refund-failed`. example: gift-card-refund-failed enum: - gift-card-refund-failed created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: gift_card_service_id: type: string format: uuid description: The unique ID of the Gift Card service used. gift_card_service_name: type: string description: The name of the Gift Card service used. gift_card_service_definition_id: type: string description: The Gift Card service definition used. url: type: - string - 'null' description: The endpoint for the request, if performed. request: type: - string - 'null' description: The HTTP body sent to the Gift Card provider, if performed. response: type: - string - 'null' description: The HTTP body received from the Gift Card provider, if any. response_status_code: type: - number - 'null' description: The HTTP response status code from the Gift Card provider, if any. reason: type: string description: The reason we could not refund the gift cards. example: Network Error TransactionStatusSummary: title: Transaction type: object description: A transaction record. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction`. example: transaction enum: - transaction id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this transaction. format: uuid status: type: string description: 'The status of the transaction. The status may change over time as asynchronous processing events occur.' example: processing enum: - processing - buyer_approval_pending - authorization_succeeded - authorization_failed - authorization_declined - capture_pending - capture_succeeded - authorization_void_pending - authorization_voided 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. PaymentConnectorResponseTransactionAuthorizationFailedEvent: title: Authorization - Failed type: object description: 'This event logs the exact details parsed details for a failed authorization as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-authorization-failed`. example: payment-connector-response-transaction-authorization-failed enum: - payment-connector-response-transaction-authorization-failed created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 status: type: string enum: - authorization_failed description: 'The new status code for the transaction. This is always set to `authorization_failed`.' example: authorization_failed code: type: - string - 'null' description: A raw response code returned for the failure. example: INVALID DATA instrument_type: type: string example: pan enum: - pan - card_token - redirect - redirect_token - googlepay - applepay - network_token description: The type of instrument used for this transaction. retry_rule: type: - string - 'null' description: "Defines why the transaction might be retried. A retry is not guaranteed because\nthe maximum number of retries might already have been attempted.\n\n* `failure` - the transaction will be retried because of a failure calling\n the payment service.\n* `retriable_decline` - the transaction will be retried because a decline code\n was received that can be retried.\n* `payment_method_replacement` - the transaction will be retried because a\n decline code was received that triggered a payment method replacement." enum: - failure - retriable_decline - payment_method_replacement example: failure raw_response_code: type: - string - 'null' description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip raw_response_description: type: - string - 'null' description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' auth_response_code: description: This is the response description received from the processor. example: '00' type: - string - 'null' avs_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. - `no_match` - neither address or postal code match - `match` - both address and postal code match - `partial_match_address` - address matches but postal code does not - `partial_match_postcode` - postal code matches but address does not - `unavailable ` - AVS is unavailable for card/country The value of this field can be `null` if the payment service did not provide a response.' example: partial_match_address enum: - no_match - match - partial_match_address - partial_match_postcode - unavailable cvv_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. - `no_match` - the CVV does not match the expected value - `match` - the CVV matches the expected value - `unavailable ` - CVV check unavailable for card our country - `not_provided ` - CVV not provided The value of this field can be `null` if the payment service did not provide a response.' example: match enum: - no_match - match - unavailable payment_method_scheme: description: The card scheme sent to the connector. type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null AdditionalIdentifiers: title: Additional transaction identifiers. type: object description: 'A list of additional identifiers that we may keep track of to manage this transaction. This may include the authorization ID, capture ID, and processor ID, as well as an undefined list of additional identifiers.' x-tags: - Transactions example: payment_service_authorization_id: authorization-1234 payment_service_capture_id: null payment_service_processor_id: null another_id: id-1234 properties: payment_service_authorization_id: type: - string - 'null' example: authorization-1234 description: The optional ID for the authorization of this transaction. Availability of this ID will vary per connector used. payment_service_capture_id: type: - string - 'null' example: capture-1234 description: The optional ID for the capture of this transaction. Availability of this ID will vary per connector used. payment_service_processor_id: type: - string - 'null' example: processor-1234 description: The optional ID provided by the processor for this transaction. Availability of this ID will vary per connector used. additionalProperties: type: string DigitalWalletApplePayTokenDecrypted: title: Digital wallet Apple Pay token decrypted type: object description: The result after decrypting an Apple Pay token. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `digital-wallet-apple-pay-token-decrypted`. example: digital-wallet-apple-pay-token-decrypted enum: - digital-wallet-apple-pay-token-decrypted created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Apple Pay decrypted token context. properties: version: type: string description: Version information about the payment token. example: EC_v1 type: type: - string - 'null' description: The type of payment instrument. enum: - dpan - fpan - null example: dpan expiration_date: type: string description: Expiration of the decrypted data. has_cryptogram: type: boolean description: Online payment cryptogram, as defined by 3D Secure. eci: type: - string - 'null' description: ECI indicator, as defined by 3D Secure. application_data: type: - string - 'null' description: Hash of the application data property of the original request. transaction_identifier: type: string description: The unique identifier from Apple Pay. cardholder_name: type: - string - 'null' description: The cardholder name. currency_code: type: string description: ISO 4217 numeric currency code for the transaction. example: '840' transaction_amount: type: integer description: The amount for the transaction. device_manufacturer_identifier: type: string description: Hex-encoded device manufacturer identifier which initiated the transaction. payment_data_type: type: string description: Either "3DSecure" or "EMV". example: 3DSecure merchant_token_identifier: type: - string - 'null' description: For a merchant token request, the provisioned merchant token identifier from the payment network. card_expiration_date: type: - string - 'null' description: Expiration date of card. card_suffix: type: - string - 'null' description: Last four digits of card PAN. TransactionRedirectRequest: title: Redirect type: object description: Redirect payment method details to use in a transaction. x-tags: - Request Bodies required: - method - redirect_url - country - currency properties: method: description: 'The method to use, this can be any of the methods that support redirect requests.' type: string example: paypal enum: - affirm - afterpay - alipay - alipayhk - bacs - bancontact - banked - becs - bitpay - boleto - boost - cashapp - chaseorbital - checkout-session - clearpay - dana - dcb - dlocal - ebanx - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - gopay - grabpay - ideal - kakaopay - kcp - klarna - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - network-token - oney_10x - oney_12x - oney_3x - oney_4x - oney_6x - ovo - oxxo - payid - paymaya - paypal - paypalpaylater - payto - pix - pse - rabbitlinepay - razorpay - scalapay - sepa - shopeepay - singteldash - smartpay - sofort - spei - stripedd - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - venmo - vipps - waave - webpay - wechat - zippay redirect_url: type: string format: uri description: 'The redirect URL to redirect a buyer to after they have authorized their transaction.' example: https://example.com/callback currency: type: string example: USD description: 'The ISO-4217 currency code to use this payment method for. This is used to select the payment service to use.' country: type: string example: US description: 'The 2-letter ISO code of the country to use this payment method for. This is used to select the payment service to use.' external_identifier: type: - string - 'null' description: An external identifier that can be used to match the account against your own records. This can only be set if the `store` flag is set to `true`. example: account-23423423 TransactionCaptureRequest: title: Capture a transaction type: object description: A request to capture a transaction. x-tags: - Request Bodies properties: amount: type: integer description: 'The monetary amount to capture an authorization for, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`. When omitted blank, this will capture the entire amount.' example: 1299 minimum: 1 maximum: 99999999 airline: type: - object - 'null' allOf: - $ref: '#/components/schemas/Airline' description: 'The airline addendum data which describes the airline booking associated with this transaction. When provided, this will override any airline data provided when authorizing the transaction. Only the data on this request will be passed to the payment service, and none of the original data will be sent or kept.' Airline: title: Airline Addendum type: object description: Information about an airline travel. properties: passenger_name_record: type: - string - 'null' minLength: 1 maxLength: 50 description: The Passenger Name Record (PNR) in the airline reservation system. example: JOHN L booking_code: type: - string - 'null' minLength: 1 maxLength: 50 description: The unique identifier of the reservation in the global distribution system. example: X36Q9C ticket_number: type: - string - 'null' minLength: 1 maxLength: 50 description: The airline's unique ticket number. example: 123-1234-151555 ticket_delivery_method: type: - string - 'null' enum: - electronic - other default: electronic description: The delivery method of the ticket. example: other issued_at: type: - string - 'null' format: date-time description: 'The date that the ticket was last issued in the airline reservation system.' example: '2013-07-16T19:23:00.000+00:00' issued_address: type: - string - 'null' minLength: 1 maxLength: 255 description: The address of the place/agency that issued the ticket. example: 123 Broadway, New York travel_agency_code: type: - string - 'null' minLength: 1 maxLength: 50 description: The IATA travel agency code. example: '12345' travel_agency_name: type: - string - 'null' minLength: 1 maxLength: 200 description: The name of the travel agency. example: Agency name travel_agency_invoice_number: type: - string - 'null' minLength: 1 maxLength: 50 description: 'The reference number of the invoice that was issued by the travel agency.' example: EG15555155 travel_agency_plan_name: type: - string - 'null' minLength: 1 maxLength: 200 description: The name of the travel agency plan. example: B733 restricted_ticket: type: - boolean - 'null' description: Indicates whether the ticket is restricted (refundable). example: false issuing_carrier_code: type: - string - 'null' minLength: 2 maxLength: 3 description: 'For airline aggregators, two-character IATA code of the airline issuing the ticket.' example: A3 issuing_carrier_name: type: - string - 'null' minLength: 1 maxLength: 100 description: The name of the airline issuing the ticket. example: Aegean Airlines issuing_iata_designator: type: - string - 'null' minLength: 2 maxLength: 2 description: 2 character IATA code of the airline issuing the ticket. example: A3 issuing_icao_code: type: - string - 'null' minLength: 3 maxLength: 3 description: 3 character ICAO code of the airline issuing the ticket. example: AEE reservation_system: type: - string - 'null' minLength: 1 maxLength: 200 description: The name of the reservation system. example: Amadeus is_cardholder_traveling: type: - boolean - 'null' description: Indicates whether the cardholder is present in the flight. example: false passengers: description: An array of the travelling passengers. items: $ref: '#/components/schemas/AirlinePassenger' maxLength: 20 type: - array - 'null' legs: description: 'An array of separate trip segments. Each leg contains detailed itinerary information.' items: $ref: '#/components/schemas/AirlineLeg' maxLength: 20 type: - array - 'null' ThreeDSecureDataV1: title: 3-D Secure Data Version 1 type: object deprecated: true allOf: - $ref: '#/components/schemas/ThreeDSecureData' - required: - authentication_response - cavv_algorithm - xid properties: authentication_response: type: string maxLength: 1 description: The response for the 3DS authentication call. example: Y cavv_algorithm: type: string maxLength: 1 description: The CAVV algorithm used. xid: type: string description: The transaction identifier. TransactionHistoryEvents: title: Transaction History Events description: A list of transaction history events. type: object x-tags: - Transactions properties: items: type: array description: A list of events related to processing a transaction. items: x-model-name: TransactionHistoryEvent oneOf: - $ref: '#/components/schemas/BINLookupRequest' - $ref: '#/components/schemas/ThreeDSecureAuthenticationRequestEvent' - $ref: '#/components/schemas/ThreeDSecureSuccessEvent' - $ref: '#/components/schemas/ThreeDSecureRequestErrorEvent' - $ref: '#/components/schemas/ThreeDSecurePreparationRequestEvent' - $ref: '#/components/schemas/ThreeDSecureResultRequestEvent' - $ref: '#/components/schemas/AntiFraudDecisionEvent' - $ref: '#/components/schemas/AntiFraudDecisionErrorEvent' - $ref: '#/components/schemas/AntiFraudDecisionSkippedEvent' - $ref: '#/components/schemas/AntiFraudDecisionUpdateEvent' - $ref: '#/components/schemas/AntiFraudDecisionUpdateErrorEvent' - $ref: '#/components/schemas/AntiFraudTransactionStatusUpdateEvent' - $ref: '#/components/schemas/AntiFraudTransactionStatusUpdateErrorEvent' - $ref: '#/components/schemas/AntiFraudWebhookEvent' - $ref: '#/components/schemas/DigitalWalletApplePayTokenDecrypted' - $ref: '#/components/schemas/DigitalWalletClickToPayTokenDecrypted' - $ref: '#/components/schemas/DigitalWalletGooglePayTokenDecrypted' - $ref: '#/components/schemas/GiftCardRedemptionFailed' - $ref: '#/components/schemas/GiftCardRedemptionSucceeded' - $ref: '#/components/schemas/GiftCardRefundFailed' - $ref: '#/components/schemas/GiftCardRefundSucceeded' - $ref: '#/components/schemas/NetworkTokenCryptogramProvisionFailed' - $ref: '#/components/schemas/NetworkTokenCryptogramProvisionSucceeded' - $ref: '#/components/schemas/NetworkTokenProvisionFailed' - $ref: '#/components/schemas/NetworkTokenProvisionSucceeded' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionAuthorizationSucceededEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionDeclinedEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionAuthorizationFailedEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionCaptureDeclinedEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionCaptureFailedEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionCaptureSucceededEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionSync' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionVoidDeclinedEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionVoidFailedEvent' - $ref: '#/components/schemas/PaymentConnectorResponseTransactionVoidSucceededEvent' - $ref: '#/components/schemas/PaymentConnectorExternalTransactionRequest' - $ref: '#/components/schemas/PaymentConnectorReportTransactionSettled' - $ref: '#/components/schemas/RealTimeAccountUpdate' - $ref: '#/components/schemas/TransactionAPIRequest' - $ref: '#/components/schemas/TransactionAPIResponse' 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: 500 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 NetworkTokenCryptogramProvisionSucceeded: title: Network Token Cryptogram Provision - Succeeded type: object description: This event logs the request and response details of HTTP calls made to provision a cryptogram for a network token, in case the call succeeded. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `network-token-cryptogram-provision-succeeded`. example: network-token-cryptogram-provision-succeeded enum: - network-token-cryptogram-provision-succeeded created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: url: type: string description: The endpoint for the request. request: type: string description: The HTTP body sent to the Network Token provider. response: type: string description: The HTTP body received from the Network Token provider. response_status_code: type: number description: The HTTP response status code from the Network Token provider. DigitalWalletGooglePayTokenDecrypted: title: Digital wallet Google Pay token decrypted type: object description: The result after decrypting an Google Pay token. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `digital-wallet-google-pay-token-decrypted`. example: digital-wallet-google-pay-token-decrypted enum: - digital-wallet-google-pay-token-decrypted created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Google Pay decrypted token context. properties: version: type: string description: Version information about the payment token. example: ECv2 type: type: - string - 'null' description: The type of payment instrument. enum: - dpan - fpan - null example: dpan expiration_date: type: string description: Expiration of the decrypted data. has_cryptogram: type: boolean description: Online payment cryptogram, as defined by 3D Secure. eci: type: - string - 'null' description: ECI indicator, as defined by 3D Secure. message_expiration: type: string description: Date and time at which the message expires as UTC milliseconds since epoch. message_id: type: string description: A unique ID that identifies the message in case it needs to be revoked or located at a later time. payment_method: type: string description: The type of the payment credential. example: CARD TransactionNetworkTokenApplePayRequest: title: Apple Pay decrypted token type: object description: Details for an Apple Pay decrypted token payment method. x-tags: - Request Bodies required: - method - token - expiration_date - card_source properties: method: type: string description: '`network-token`.' example: network-token enum: - network-token token: type: string description: The value of the decrypted Apple Pay token. expiration_date: type: string description: The expiration date of the network token, formatted `MM/YY`. example: 11/25 pattern: ^\d{2}/\d{2}$ minLength: 5 maxLength: 5 cryptogram: type: - string - 'null' description: The cryptogram of the network token. eci: type: string pattern: ^0?\d$ minLength: 1 maxLength: 2 description: The ecommerce indicator for 3D-Secure. example: '05' card_source: type: string example: apple-pay enum: - apple-pay card_suffix: type: - string - 'null' example: '1234' maxLength: 4 description: Last four digits of card PAN. card_scheme: type: - string - 'null' description: The scheme/brand of the card. cardholder_name: type: - string - 'null' description: The cardholder name. Actions: title: Actions description: A list of actions. type: object x-tags: - Transactions x-internal: true properties: items: type: array description: A list of actions. items: $ref: '#/components/schemas/Action' ThreeDSecureDataV2: title: 3-D Secure Data Version 2 type: object allOf: - $ref: '#/components/schemas/ThreeDSecureData' - required: - directory_transaction_id properties: authentication_response: type: - string - 'null' maxLength: 1 description: 'The transaction status after a the 3DS challenge. This will be null in case of a frictionless 3DS flow.' example: Y enum: - Y - A - N - R - U directory_response: type: string maxLength: 1 description: The transaction status received as part of the authentication request. example: C enum: - C - Y - A - N - R - U directory_transaction_id: type: string description: The transaction identifier. example: c4e59ceb-a382-4d6a-bc87-385d591fa09d PaymentConnectorResponseTransactionDeclinedEvent: title: Authorization - Declined type: object description: 'This event logs the exact details parsed details for a declined transaction as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-declined`. example: payment-connector-response-transaction-declined enum: - payment-connector-response-transaction-declined created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 status: type: string enum: - authorization_declined description: 'The new status code for the transaction. This is always set to `authorization_declined`.' example: authorization_declined code: type: - string - 'null' description: A raw response code returned for the decline. example: INVALID DATA instrument_type: type: string example: pan enum: - pan - card_token - redirect - redirect_token - googlepay - applepay - network_token description: The type of instrument used for this transaction. retry_rule: type: - string - 'null' description: "Defines why the transaction might be retried. A retry is not guaranteed because\nthe maximum number of retries might already have been attempted.\n\n* `failure` - the transaction will be retried because of a failure calling\n the payment service.\n* `retriable_decline` - the transaction will be retried because a decline code\n was received that can be retried.\n* `payment_method_replacement` - the transaction will be retried because a\n decline code was received that triggered a payment method replacement." enum: - failure - retriable_decline - payment_method_replacement example: failure raw_response_code: type: - string - 'null' description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip raw_response_description: type: - string - 'null' description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' auth_response_code: description: This is the response description received from the processor. example: '00' type: - string - 'null' avs_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. - `no_match` - neither address or postal code match - `match` - both address and postal code match - `partial_match_address` - address matches but postal code does not - `partial_match_postcode` - postal code matches but address does not - `unavailable ` - AVS is unavailable for card/country The value of this field can be `null` if the payment service did not provide a response.' example: partial_match_address enum: - no_match - match - partial_match_address - partial_match_postcode - unavailable cvv_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. - `no_match` - the CVV does not match the expected value - `match` - the CVV matches the expected value - `unavailable ` - CVV check unavailable for card our country - `not_provided ` - CVV not provided The value of this field can be `null` if the payment service did not provide a response.' example: match enum: - no_match - match - unavailable payment_method_scheme: description: The card scheme sent to the connector. type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null TransactionRefundRequest: title: Transaction Refund Request type: object description: A request to refund a transaction. x-tags: - Request Bodies properties: amount: type: integer description: 'The amount requested to refund. If omitted, a full refund will be requested for the main payment method. When set, the amount must be lower than or equal to the remaining balance in the associated transaction. Negative and zero-amount refunds are not supported.' minimum: 1 maximum: 99999999 example: 1299 target_type: type: - string - 'null' description: 'The target type to refund for. This can be used to target a gift card to refund to instead of the main payment method.' example: gift-card-redemption default: payment-method enum: - payment-method - gift-card-redemption target_id: type: - string - 'null' format: uuid description: 'The optional ID of the instrument to refund for. This is only required when the `target_type` is set to `gift-card-redemption`.' example: c23ea83f-1b1c-4584-a0e8-78ef8c041949 reason: type: - string - 'null' description: An optional reason to attach extra context to the refund request. example: Refund due to user request maxLength: 100 external_identifier: type: - string - 'null' description: 'An external identifier that can be used to match the refund against your own records.' example: refund-789123 minLength: 1 maxLength: 300 PaymentConnectorResponseTransactionVoidSucceededEvent: title: Void - Succeeded type: object description: 'This event logs the exact details parsed details for a succeeded void as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-void-succeeded`. example: payment-connector-response-transaction-void-succeeded enum: - payment-connector-response-transaction-void-succeeded created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 voided_at: type: string description: The date and time when this transaction was voided. format: date-time example: '2013-07-16T19:23:00.000+00:00' AntiFraudWebhookEvent: title: Anti-fraud - Webhook type: object description: This event logs the webhook received when an anti-fraud decision is updated. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-webhook`. example: anti-fraud-webhook enum: - anti-fraud-webhook created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. anti_fraud_service_check_id: type: string description: The external ID of the decision that's being updated. example: decision-1234 content: type: string description: The raw payload sent as a webhook. example: '{ "decision": "ACCEPT", "id": "decision-1234", "reason": "Manually verified" }' content_type: type: string description: The content type of the payload sent as a webhook. example: application/json decision: type: string description: The parsed decision response from the anti-fraud provider webhook. example: ACCEPT comment: type: string description: Any comment that may have come with the webhook event. example: Manually verified silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' PaymentConnectorResponseTransactionVoidDeclinedEvent: title: Void - Declined type: object description: 'This event logs the exact details parsed details for a declined void as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-void-declined`. example: payment-connector-response-transaction-void-declined enum: - payment-connector-response-transaction-void-declined created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 code: type: - string - 'null' description: A raw response code returned for the failure. example: INVALID DATA AirlinePassenger: title: Airline Addendum Passenger type: object description: Information of the travelling passenger. properties: title: type: - string - 'null' minLength: 1 maxLength: 50 description: Title of the passenger. example: Mr. first_name: type: - string - 'null' minLength: 1 maxLength: 255 description: The first name(s) or given name of the passenger. example: John last_name: type: - string - 'null' minLength: 1 maxLength: 255 description: The last name, or family name, of the passenger. example: Lunn email_address: type: - string - 'null' minLength: 1 maxLength: 320 description: The email address of the passenger. 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 passenger. This number is formatted according to the [E164 number standard](https://www.twilio.com/docs/glossary/what-e164).' example: '+1234567890' passport_number: type: - string - 'null' minLength: 1 maxLength: 50 description: The passenger's unique passport number. example: '7700225' ticket_number: type: - string - 'null' minLength: 1 maxLength: 50 description: The ticket number for a flight. example: LH1236699999 frequent_flyer_number: type: - string - 'null' minLength: 5 maxLength: 50 description: The passenger's frequent flyer number. example: '15885566' date_of_birth: type: - string - 'null' description: The passenger's date of birth. format: date example: '2013-07-16' age_group: type: - string - 'null' enum: - adult - infant example: adult NetworkTokenProvisionSucceeded: title: Network Token Provision - Succeeded type: object description: This event logs the request and response details of HTTP calls made to provision a network token, in case the call succeeded. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `network-token-provision-succeeded`. example: network-token-provision-succeeded enum: - network-token-provision-succeeded created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: url: type: string description: The endpoint for the request. request: type: string description: The HTTP body sent to the Network Token provider. response: type: string description: The HTTP body received from the Network Token provider. response_status_code: type: number description: The HTTP response status code from the Network Token provider. Settlement: title: Settlement type: object description: A settlement record. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `settlement`. example: settlement enum: - settlement id: type: string format: uuid description: The unique identifier for this settlement. example: fe26475d-ec3e-4884-9553-f7356683f7f9 merchant_account_id: type: string description: The ID of the merchant account to which this settlement belongs to. example: default created_at: type: string format: date-time description: The date and time when this settlement was created in our system. example: '2024-04-01T19:23:00.000+00:00' updated_at: type: string format: date-time description: The date and time when this settlement was last updated. example: '2024-04-01T19:23:00.000+00:00' posted_at: type: string format: date-time description: The date and time when this settlement occurred. example: '2024-03-30T10:25:00.000+00:00' ingested_at: type: string format: date-time description: 'The date and time when information about this settlement was ingested into our system.' example: '2013-04-01T01:01:00.000+00:00' currency: type: string description: 'The currency code of this settlement in ISO 4217 three-letter code format.' example: USD amount: type: integer description: The net amount of this settlement. example: 1299 exchange_rate: type: - number - 'null' description: 'The exchange rate used to convert amounts from the processing currency to the settlement currency.' example: 0.95 commission: type: integer description: The total commission of this settlement, expressed in `currency`. example: 5 interchange: type: - integer - 'null' description: The interchange fee of this settlement, expressed in `currency`. example: 5 markup: type: - integer - 'null' description: The markup of this settlement by the acquirer, expressed in `currency`. example: 10 scheme_fee: type: - integer - 'null' description: The scheme fee of this settlement, expressed in `currency`. example: 5 payment_service_report_id: type: string format: uuid description: 'The ID of the payment service report containing this settlement.' example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 payment_service_report_file_ids: type: array items: type: string format: uuid description: 'The list of payment service report file IDs that make up the payment service report containing this settlement.' example: - 0302e601-d2c3-42b2-9825-9457145331ae - 7deec061-71a5-435f-beae-40f35820ca67 transaction_id: type: string format: uuid description: The ID of the transaction associated with this settlement. example: fe26475d-ec3e-4884-9553-f7356683f7f9 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 ThreeDSecureResultRequestEvent: title: 3DS - Post-authentication type: object description: The result and raw data for a 3DS post-authorization call. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `three-d-secure-result-request`. example: three-d-secure-result-request enum: - three-d-secure-result-request created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: 3DS post-authentication context. properties: url: type: string description: The URL that was called for this request. example: https://3dserver.example/auth request: type: string description: The request body sent to the `url`. example: '{}' response: type: string description: The response body received from the `url`. example: '{}' response_status_code: type: integer description: The response status code received from the `url`. example: 200 cavv: type: string description: The 3DS CAVV value parsed from the `response`. example: +9YDsoSIbiEgO+PFMdgGSF17Uqk= eci: type: string description: The 3DS ECI value parsed from the `response`. example: '05' authentication_response: type: string description: The `transStatus` parsed from the post-authorization `response`. example: C directory_response: type: string description: The `transStatus` parsed from the authorization `response`. example: C directory_transaction_id: type: string description: The `dsTransID` parsed from the `response`. example: 8875884a-ac2f-42cb-b3f0-09b3ea3c0042 is_challenge_cancelled: type: boolean description: Flag to indicate whether the buyer cancelled 3DS authentication. example: false PaymentService--Snapshot: title: A payment service type: object description: An active, configured payment service. x-tags: - Payment Services properties: type: type: string description: The type of this resource. example: payment-service enum: - payment-service id: type: string description: The ID of this payment service. example: stripe-card-faaad066-30b4-4997-a438-242b0752d7e1 minLength: 1 maxLength: 200 display_name: description: The custom name set for this service. example: Stripe (Main) maxLength: 50 minLength: 1 type: string method: description: The payment method that this services handles. type: string example: card enum: - affirm - afterpay - alipay - alipayhk - applepay - bacs - bancontact - banked - becs - bitpay - boleto - boost - card - cashapp - chaseorbital - checkout-session - clearpay - click-to-pay - dana - dcb - dlocal - ebanx - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - googlepay - googlepay_pan_only - gopay - grabpay - id - ideal - kakaopay - kcp - klarna - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - network-token - oney_3x - oney_4x - oney_6x - oney_10x - oney_12x - ovo - oxxo - payid - paymaya - paypal - paypalpaylater - payto - venmo - pix - pse - rabbitlinepay - razorpay - scalapay - sepa - shopeepay - singteldash - smartpay - sofort - spei - stripedd - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - vipps - waave - webpay - wechat - zippay payment_service_definition_id: description: 'The ID of the payment service definition used to create this service. ' example: stripe-card maxLength: 50 minLength: 1 type: string PaymentConnectorExternalTransactionRequest: title: External Transaction Request type: object description: 'This event logs the exact details parsed details for an external transaction request.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-external-transaction-request`. example: payment-connector-external-transaction-request enum: - payment-connector-external-transaction-request created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for the transaction. properties: connector_request_id: type: string description: The connector request id. example: 76f5ed52-8675-491f-b52d-731ca894ed80 request: type: - string - 'null' description: The request. example: '' response: type: - string - 'null' description: The response. payment_service_definition_id: type: - string - 'null' description: The payment service definition id. success: type: - boolean - 'null' description: Whether the transaction was successful. payment_service_id: type: - string - 'null' description: The payment service id. response_status_code: type: - string - 'null' description: The response status code. payment_service_display_name: type: - string - 'null' description: The payment service display name. method: type: - string - 'null' description: The HTTP method. url: type: - string - 'null' description: The endpoint for the request. refund_id: type: - string - 'null' description: The ID of the refund, in case this links to a refund. refund_xid: type: - string - 'null' description: The external ID of the refund. PaymentConnectorResponseTransactionAuthorizationSucceededEvent: title: Authorization type: object description: 'This event logs the exact details parsed details for a succeeded authorization as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `payment-connector-response-transaction-authorization-succeeded`. example: payment-connector-response-transaction-authorization-succeeded enum: - payment-connector-response-transaction-authorization-succeeded created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 status: type: string enum: - authorization_succeeded description: 'The new status code for the transaction. This is always set to `authorization_succeeded`.' example: authorization_succeeded instrument_type: type: string example: pan enum: - pan - card_token - redirect - redirect_token - googlepay - applepay - network_token description: The type of instrument used for this transaction. retry_rule: type: - string - 'null' description: This will always be `null` because the transaction succeeded. example: null deprecated: true raw_response_code: type: - string - 'null' description: 'This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.' example: incorrect-zip raw_response_description: type: - string - 'null' description: 'This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' example: 'The card''s postal code is incorrect. Check the card''s postal code or use a different card.' auth_response_code: description: This is the response description received from the processor. example: '00' type: - string - 'null' avs_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. - `no_match` - neither address or postal code match - `match` - both address and postal code match - `partial_match_address` - address matches but postal code does not - `partial_match_postcode` - postal code matches but address does not - `unavailable ` - AVS is unavailable for card/country The value of this field can be `null` if the payment service did not provide a response.' example: partial_match_address enum: - no_match - match - partial_match_address - partial_match_postcode - unavailable cvv_response_code: type: - string - 'null' description: 'The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. - `no_match` - the CVV does not match the expected value - `match` - the CVV matches the expected value - `unavailable ` - CVV check unavailable for card our country - `not_provided ` - CVV not provided The value of this field can be `null` if the payment service did not provide a response.' example: match enum: - no_match - match - unavailable payment_method_scheme: description: The card scheme sent to the connector. type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null Settlements: title: Settlements description: A list of settlements. type: object x-tags: - Transactions properties: items: type: array description: A list of settlements. items: $ref: '#/components/schemas/Settlement' BrowserInfo: title: Browser info type: object required: - java_enabled - javascript_enabled - language - color_depth - screen_height - screen_width - time_zone_offset - user_device - user_agent properties: java_enabled: type: boolean description: Indicates whether the client browser supports Java. example: true javascript_enabled: type: boolean description: Indicates whether the client browser supports JavaScript. example: true language: type: string description: 'The preferred language of the buyer, usually the language of the browser UI.' example: en-GB color_depth: type: number description: The color depth of the screen. example: 32 screen_height: type: number description: The height of the screen in pixels. example: 1080 screen_width: type: number description: The width of the screen in pixels. example: 1920 time_zone_offset: type: number description: Time-zone offset in minutes between UTC and buyer location. example: 60 user_device: type: string description: The platform that is being used to access the website. example: desktop enum: - desktop - mobile user_agent: type: string description: The user agent string for the current browser. example: 'Mozilla/5.0 (darwin) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/16.7.0' accept_header: type: string description: The `Accept` header of the request from the buyer's browser. example: '*/*' TransactionCheckoutSessionRequest: title: Checkout Session type: object description: Checkout Session payment method details to use in a transaction. x-tags: - Request Bodies required: - method - id properties: method: type: string description: '`checkout-session`.' example: checkout-session enum: - checkout-session id: type: string format: uuid description: The ID of the Checkout Session. example: 8d3fe99b-1422-42e6-bbb3-932d95ae5f79 external_identifier: type: - string - 'null' description: An external identifier that can be used to match the card against your own records. This can only be set if the `store` flag is set to `true`. example: card-323444 redirect_url: type: - string - 'null' format: uri description: 'We strongly recommend providing a `redirect_url` either when 3-D Secure is enabled and `three_d_secure_data` is not provided, or when using connections where 3DS is enabled. This value will be appended with both a transaction ID and status (e.g. `https://example.com/callback?gr4vy_transaction_id=123 &gr4vy_transaction_status=capture_succeeded`) after 3-D Secure has completed. For those cases, if the value is not present, the transaction will be marked as failed.' example: https://example.com/callback GiftCard--Snapshot: title: Gift card (Snapshot) type: object description: A snapshot of a gift card used in a transaction. x-tags: - Gift Cards properties: type: type: string description: The type of this resource. example: gift-card enum: - gift-card id: type: - string - 'null' format: uuid description: 'The ID of this gift card. This may be `null` if the gift card is not stored.' example: e6cdf979-87e2-4796-8ff6-9784d5aed893 bin: type: string description: The first 6 digits of the full gift card number. example: '412345' sub_bin: type: string description: The 3 digits after the `bin` of the full gift card number. example: '554' last4: type: string description: The last 4 digits for the gift card. example: '1234' FlowRuleUUIDsListOutcome: title: UUIDs list outcome type: object description: 'Defines the outcome of a rule in a flow where the result is a list of UUIDs. Depending on the flow and action where this outcome is used, the UUIDs may have an important meaning like the ID of a payment service to be used (this is the case for `redirect-transaction` flow and `route-transaction` action).' x-tags: - Flow required: - type - result x-internal: true properties: type: type: string description: The type of action outcome for the given rule. example: list enum: - list result: type: array description: Results for a given flow action. items: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 format: uuid example: - fe26475d-ec3e-4884-9553-f7356683f7f9 - d88aca32-07fb-46cd-a43f-86da02b73c21 TransactionRefundAllRequest: title: Transaction Refund All Request type: object description: A request to fully refund a transaction. x-tags: - Request Bodies properties: reason: type: - string - 'null' description: 'The reason to refund for. This can be used to attach a written reason to the refund request.' example: Refund due to user request maxLength: 100 external_identifier: type: - string - 'null' description: 'An external identifier that can be used to match the refund against your own records.' example: refund-789123 minLength: 1 maxLength: 300 GiftCardRedemptionSucceeded: title: Gift Cards Redemption - Succeeded type: object description: This event logs the request and response details of HTTP calls made to redeem gift cards, in case the call succeeded. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `gift-card-redemption-succeeded`. example: gift-card-redemption-succeeded enum: - gift-card-redemption-succeeded created_at: type: string description: The date and time when this event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: gift_card_service_id: type: string format: uuid description: The unique ID of the Gift Card service used. gift_card_service_name: type: string description: The name of the Gift Card service used. gift_card_service_definition_id: type: string description: The Gift Card service definition used. url: type: - string - 'null' description: The endpoint for the request. request: type: string description: The HTTP body sent to the Gift Card provider. response: type: string description: The HTTP body received from the Gift Card provider. response_status_code: type: number description: The HTTP response status code from the Gift Card provider. AntiFraudDecisionUpdateEvent: title: Anti-fraud - Decision update sent type: object description: This event logs the request and response details of HTTP calls made to an anti-fraud provider to update a pending decision. For example, when an anti-fraud review has been rejected. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-decision-update`. example: anti-fraud-decision-update enum: - anti-fraud-decision-update created_at: type: string description: The date and time when this transaction event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. anti_fraud_service_check_id: type: string description: The external ID of the decision. example: decision-1234 decision: type: string description: The updated decision sent to the anti-fraud provider. example: ACCEPT request: type: string description: The HTTP body sent to fetch a decision. response: type: string description: The HTTP body received from the anti-fraud provider. response_status_code: type: number description: The HTTP response status code from the anti-fraud provider. silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' Refund: title: Refund type: object description: 'A refund record. A refund is always associated with a single transaction, while a transaction can potentially have several refunds.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `refund`. enum: - refund example: refund id: type: string description: The unique ID of the refund. format: uuid example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 transaction_id: type: string description: The ID of the transaction associated with this refund. format: uuid example: fe26475d-ec3e-4884-9553-f7356683f7f9 payment_service_refund_id: type: string description: The payment service's unique ID for the refund. example: refund_xYqd43gySMtori status: type: string description: 'The status of the refund. It may change over time as asynchronous processing events occur. - `processing` - The refund is being processed. - `succeeded` - The refund was successful. - `declined` - The refund was declined by the underlying PSP. - `failed` - The refund could not proceed due to a technical issue.' enum: - processing - succeeded - declined - failed example: processing currency: type: string description: 'The currency code for this refund. Will always match that of the associated transaction.' example: USD amount: type: integer description: The amount requested for this refund. minimum: 0 maximum: 99999999 example: 1299 reason: type: - string - 'null' maximum: 100 description: 'The reason for this refund. Could be a multiline string.' example: Refund due to user request default: null maxLength: 100 created_at: type: string description: The date and time when this refund was created. format: date-time example: '2013-07-16T19:23:00.000+00:00' updated_at: type: string description: The date and time when this refund was last updated. format: date-time example: '2013-07-16T19:23:00.000+00:00' target_type: type: string description: The type of the instrument that was refunded. example: payment-method enum: - payment-method - gift-card-redemption target_id: type: - string - 'null' description: 'The optional ID of the instrument that was refunded. This may be `null` if the instrument was not stored.' example: c23ea83f-1b1c-4584-a0e8-78ef8c041949 external_identifier: type: - string - 'null' description: 'An external identifier that can be used to match the refund against your own records.' example: refund-789123 minLength: 1 maxLength: 300 reconciliation_id: description: 'The base62 encoded refund ID. This represents a shorter version of this refund''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 refund against our system.' example: 7jZXl4gBUNl0CnaLEnfXbt type: string transaction_external_identifier: type: - string - 'null' description: The external identifier of the related transaction. example: transaction-789123 transaction_reconciliation_id: description: 'The base62 encoded transaction ID. This represents a shorter version of the related transaction''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 transaction against our system.' example: 7jZXl4gBUNl0CnaLEnfXbt type: string RealTimeAccountUpdate: title: Real time account update type: object description: The result from a real time account updater request. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `real-time-account-update`. example: real-time-account-update enum: - real-time-account-update created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Real time account updater request context. properties: payment_method_id: type: string format: uuid description: The unique identifier for the payment method. example: 8724fd24-5489-4a5d-90fd-0604df7d3b83 card_bin: type: string description: The existing card BIN. example: '424242' card_suffix: type: string description: The existing last 4 digits for the card. example: '4242' card_expiration_date: type: string description: The existing expiration date for the card. example: 01/30 new_card_bin: type: - string - 'null' description: The new card BIN. example: '424242' new_card_suffix: type: - string - 'null' description: The new last 4 digits for the card. example: '4242' new_card_expiration_date: type: - string - 'null' description: The new expiration date for the card. example: 01/30 latency: type: - number - 'null' description: The latency in milliseconds of the request. example: 123 response_code: type: - string - 'null' description: The response code/result for the update request. example: updated enum: - account_closed - contact_cardholder - unchanged - updated error_code: type: - string - 'null' description: The reason code for a failed request. example: client_error enum: - client_error - issuer_error - request_timeout ThreeDSecurePreparationRequestEvent: title: 3DS - Pre-authentication type: object description: The result and raw data for a 3DS pre-authorization call. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `three-d-secure-preparation-request`. example: three-d-secure-preparation-request enum: - three-d-secure-preparation-request created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: 3DS pre-authentication context. properties: url: type: string description: The URL that was called for this request. example: https://3dserver.example/auth request: type: string description: The request body sent to the `url`. example: '{}' response: type: string description: The response body received from the `url`. example: '{}' response_status_code: type: integer description: The response status code received from the `url`. example: 200 is_enrolled: type: boolean description: If the card is enrolled for 3DS. example: true version: type: string description: The version of 3DS extracted from the `response. example: 2.2.0 ThreeDSecureV2: title: 3-D Secure Data Version 2 type: object properties: cavv: type: - string - 'null' description: The cardholder authentication value or AAV. example: 3q2+78r+ur7erb7vyv66vv8= eci: type: - string - 'null' pattern: ^0?\d$ minLength: 1 maxLength: 2 description: The ecommerce indicator for the 3DS transaction. example: '05' version: type: string pattern: ^[1-2].?[\d+.?]{0,3}$ description: The version of 3-D Secure that was used. authentication_response: type: - string - 'null' maxLength: 1 description: 'The transaction status after a the 3DS challenge. This will be null in case of a frictionless 3DS flow.' example: Y enum: - Y - A - N - R - U directory_response: type: - string - 'null' maxLength: 1 description: The transaction status received as part of the authentication request. example: C enum: - C - Y - A - N - R - U directory_transaction_id: type: - string - 'null' description: The transaction identifier. example: c4e59ceb-a382-4d6a-bc87-385d591fa09d transaction_reason: type: - string - 'null' description: The reason identifier for a declined transaction. example: '05' AntiFraudTransactionStatusUpdateErrorEvent: title: Anti-fraud - Transaction update failed type: object description: This event logs the reason why we were unable to update an anti-fraud transaction. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-transaction-status-update-error`. example: anti-fraud-transaction-status-update-error enum: - anti-fraud-transaction-status-update-error created_at: type: string description: The date and time when this transaction event was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. reason: type: string description: The reason we could not get the anti-fraud decision. example: Network Error request: type: - string - 'null' description: The HTTP body sent to fetch a decision. response: type: - string - 'null' description: The HTTP body received from the anti-fraud provider. response_status_code: type: - number - 'null' description: The HTTP response status code from the anti-fraud provider. silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' 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' BINLookupRequest: title: BIN Lookup Request type: object description: The result and raw data for a card BIN lookup. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `bin-lookup-request`. example: bin-lookup-request enum: - bin-lookup-request created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: BIN lookup request context. properties: response: type: - string - 'null' description: The response body received from the `url`. example: '{}' response_status_code: type: integer description: The response status code received from the `url`. example: 200 success: type: boolean description: Whether the BIN lookup was successful or not. bin: type: - string - 'null' description: The value used to lookup BIN details. instrument: type: - string - 'null' description: The instrument type used to lookup BIN details. example: pan type: type: - string - 'null' description: The type of card, i.e. credit or debit, from the lookup response. scheme: description: The card scheme result from the lookup response. type: - string - 'null' example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null additional_schemes: type: - array - 'null' items: type: string example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null description: The card additional schemes from the lookup response. country_code: type: - string - 'null' description: The card country code result from the lookup response. supports_network_tokens: type: - boolean - 'null' description: Whether the issuing bank supports network tokenization for this card. FlowRuleMethodOutcome: title: Payment method outcome type: object description: 'Defines the outcome of a rule in a flow where the result is a list of payment types.' x-tags: - Flow required: - type - result x-internal: true properties: type: type: string description: The type of action outcome for the given rule. example: list enum: - list result: type: array description: Results for a given flow action. items: type: string example: card enum: - affirm - afterpay - alipay - alipayhk - applepay - bacs - bancontact - banked - becs - bitpay - boleto - boost - card - cashapp - chaseorbital - checkout-session - clearpay - click-to-pay - dana - dcb - dlocal - ebanx - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - googlepay - googlepay_pan_only - gopay - grabpay - id - ideal - kakaopay - kcp - klarna - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - network-token - oney_3x - oney_4x - oney_6x - oney_10x - oney_12x - ovo - oxxo - payid - paymaya - paypal - paypalpaylater - payto - venmo - pix - pse - rabbitlinepay - razorpay - scalapay - sepa - shopeepay - singteldash - smartpay - sofort - spei - stripedd - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - vipps - waave - webpay - wechat - zippay example: - card - paypal 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. FlowRuleBooleanOutcome: title: Boolean outcome type: object description: 'Defines the outcome of a rule in a flow where the result is a boolean.' x-tags: - Flow required: - type - result x-internal: true properties: type: type: string description: The type of action outcome for the given rule. example: boolean enum: - boolean result: type: boolean description: Results for a given flow action. enum: - true PaymentConnectorResponseTransactionSync: title: Transaction Sync type: object description: 'This event logs the exact parsed details for a transaction sync / refresh as reported by our connector.' x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `transaction-sync-event`. example: transaction-sync-event enum: - transaction-sync-event created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2025-01-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: payment_service_id: type: string format: uuid description: The unique ID of the payment service used. payment_service_display_name: type: string description: The display name of the payment service used. payment_service_definition_id: type: string description: The payment service definition used. payment_service_transaction_id: type: - string - 'null' description: The external ID of the transaction as set by the payment service. example: transaction-1234 amount: type: number description: The transaction amount. example: 123 captured_amount: type: number description: The amount captured for the transaction. example: 123 currency: type: string description: The currency for the transaction. example: EUR status: type: string description: The latest status code for the transaction. example: capture_succeeded previous_status: type: string description: The previous status code for the transaction. example: capture_succeeded AntiFraudDecisionEvent: title: Anti-fraud - Decision type: object description: This event logs the request and response details of HTTP calls made to an anti-fraud provider. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `anti-fraud-decision`. example: anti-fraud-decision enum: - anti-fraud-decision created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: Additional context for this event. properties: anti_fraud_service_id: type: string format: uuid description: The unique ID of the anti-fraud service used. anti_fraud_service_name: type: string description: The name of the anti-fraud service used. anti_fraud_service_definition_id: type: string description: The anti-fraud service definition used. anti_fraud_service_check_id: type: string description: The external ID of the decision. example: decision-1234 request: type: string description: The HTTP body sent to fetch a decision. response: type: string description: The HTTP body received from the anti-fraud provider. response_status_code: type: number description: The HTTP response status code from the anti-fraud provider. decision: type: string description: The parsed decision response from the anti-fraud provider response. example: ACCEPT silent: type: boolean example: false description: 'Defines if this service is currently running in silent mode. In silent mode, a service''s decisions will be created but ignored when processing a transaction, allowing for warm-up and comparison of new services against the active service.' GiftCardRedemption: title: Gift card redemption type: object description: A redemption of a gift card used in a transaction. x-tags: - Gift Cards properties: type: type: string description: The type of this resource. example: gift-card-redemption enum: - gift-card-redemption id: type: - string - 'null' format: uuid description: 'The ID of this gift card redemption. This may be `null` if the no redemption happened.' example: bc3f0d5a-3529-4d31-b2b4-848d14926bbc status: type: string description: The status of the gift card redemption for the `payment_method`. example: succeeded enum: - created - succeeded - failed - skipped amount: type: integer description: The amount redeemed for this gift card. example: 1299 minimum: 1 maximum: 99999999 refunded_amount: type: integer description: 'The amount refunded for this gift card. This can not be larger than `amount`.' example: 1299 minimum: 1 maximum: 99999999 gift_card_service_redemption_id: type: - string - 'null' description: The gift card service's unique ID for the redemption. example: xYqd43gySMtori error_code: description: 'If this gift card redemption resulted in an error, this will contain the internal code for the error.' example: expired_card type: - string - 'null' enum: - expired_card - inactive_card - incorrect_currency - insufficient_funds - invalid_amount - invalid_gift_card - invalid_service_configuration - invalid_service_credentials - operation_canceled - service_error - service_network_error - unknown_error raw_error_code: type: - string - 'null' description: 'If this gift card redemption resulted in an error, this will contain the raw error code received from the gift card provider.' example: '10001' raw_error_message: type: - string - 'null' description: 'If this gift card redemption resulted in an error, this will contain the raw error message received from the gift card provider.' example: Card expired. gift_card: $ref: '#/components/schemas/GiftCard--Snapshot' ThreeDSecureData: title: 3-D Secure Data type: object required: - cavv - eci - version - directory_response properties: cavv: type: string description: The cardholder authentication value or AAV. example: 3q2+78r+ur7erb7vyv66vv8= eci: type: string pattern: ^0?\d$ minLength: 1 maxLength: 2 description: The ecommerce indicator for the 3DS transaction. example: '05' version: type: string pattern: ^[1-2].?[\d+.?]{0,3}$ description: The version of 3-D Secure that was used. directory_response: type: string maxLength: 1 description: For 3-D Secure version 1, the enrolment response. For 3-D Secure version , the transaction status from the `ARes`. example: C scheme: type: - string - 'null' description: The scheme/brand of the card that is used for 3-D Secure. example: visa enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - rupay - star - uatp - unionpay - visa - null ThreeDSecureSuccessEvent: title: 3DS - Authentication (Deprecated) type: object description: Details related to 3DS processing. x-tags: - Transactions properties: type: type: string description: The type of this resource. Is always `transaction-event`. example: transaction-event enum: - transaction-event id: type: string example: fe26475d-ec3e-4884-9553-f7356683f7f9 description: The unique identifier for this event. format: uuid name: type: string description: The name of this resource. Is always `three-d-secure-success`. example: three-d-secure-success enum: - three-d-secure-success created_at: type: string description: The date and time when this transaction was created in our system. format: date-time example: '2013-07-16T19:23:00.000+00:00' context: type: object description: 3DS context. properties: eci: type: string pattern: ^0?\d$ minLength: 1 maxLength: 2 description: The ecommerce indicator for the 3DS transaction. example: '05' cavv: type: string description: The cardholder authentication value or AAV. example: 3q2+78r+ur7erb7vyv66vv8= version: type: string pattern: ^[1-2].?[\d+.?]{0,3}$ description: The version of 3-D Secure that was used. directory_response: type: string maxLength: 1 description: For 3-D Secure version 1, the enrolment response. For 3-D Secure version , the transaction status from the `ARes`. example: C authentication_response: type: - string - 'null' maxLength: 1 description: The transaction status from the challenge result (not required for frictionless). example: Y directory_transaction_id: type: - string - 'null' description: The transaction identifier. example: c4e59ceb-a382-4d6a-bc87-385d591fa09d cavv_algorithm: type: - string - 'null' maxLength: 1 description: The CAVV Algorithm used. method: type: - string - 'null' description: The method used for 3DS authentication for this transaction. enum: - challenge - frictionless GooglePayRequest: title: Google Pay payment method request type: object description: Details for a Google Pay payment method. x-tags: - Request Bodies required: - method - token properties: method: type: string description: '`googlepay`.' example: googlepay enum: - googlepay token: type: string description: 'The encrypted (opaque) token returned by the Google Pay API that represents a payment method.' card_suffix: type: - string - 'null' description: Last 4 digits of the PAN for identification purposes. example: '1234' card_scheme: type: - string - 'null' description: The scheme/brand of the card. card_type: type: - string - 'null' description: The type of card. example: credit assurance_details: type: - object - 'null' description: Information about the validation performed on the payment data. (See https://developers.google.com/pay/api/web/reference/response-objects#assurance-details-specifications). properties: account_verified: type: - boolean - 'null' example: false description: Indicates that card holder possession validation has been performed. card_holder_authenticated: type: - boolean - 'null' example: false description: Indicates that identification and verifications was performed. cardholder_name: type: - string - 'null' description: Name of the card holder. redirect_url: type: - string - 'null' format: uri description: 'We strongly recommend providing a `redirect_url` either when 3-D Secure is enabled and `three_d_secure_data` is not provided, or when using connections where 3DS is enabled. This value will be appended with both a transaction ID and status (e.g. `https://example.com/callback?gr4vy_transaction_id=123 &gr4vy_transaction_status=capture_succeeded`) after 3-D Secure has completed. For those cases, if the value is not present, the transaction will be marked as failed.' example: https://example.com/callback GiftCardServiceProvider: type: string enum: - mock-gift-card - qwikcilver-gift-card - valuelink-gift-card title: GiftCardServiceProvider 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 ApplePayPaymentMethodCreate: properties: buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The external identifier of the buyer to create a payment for. examples: - buyer-12345 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to retrieve billing details for. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 cardholder_name: anyOf: - type: string maxLength: 200 minLength: 0 - type: 'null' title: Cardholder Name description: The card holder name associated to the original card for the token. examples: - John Luhn redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com card_suffix: anyOf: - type: string maxLength: 4 minLength: 4 - type: 'null' title: Card Suffix description: The last 4 digits of the original card used to generate the token. examples: - '1234' card_scheme: anyOf: - type: string - type: 'null' title: Card Scheme description: The original card scheme for which the token was generated. examples: - visa card_type: anyOf: - type: string - type: 'null' title: Card Type description: The payment scheme of the card. examples: - credit method: type: string const: applepay title: Method description: Always `applepay` examples: - applepay token: additionalProperties: true type: object title: Token description: The opaque token as received from the Apple Pay JS library. This format may change between JS library versions. examples: - paymentData: data: fU2SY4yjz/F8YkFMPjlbsY5uuIK3glAb3bJw2PZOSMld41CDqbGwBIXw6rVIPIzSvPtGoDwmWvzOT1AG8iOxPknMpaZmg4OKis/CtNpTNIbLR8VwuRzK3O7iffLiA17rnV8osXycxZPQrwSJIQl8XSMHfaU4bJW/X6hAlMiHJv5g22F7kFKNQyAkL3yX1F9Q4pZK8T9JW/jXoho30njRllrI+swinZ7Hyk4KaYw65HeAiPSWbPqWQZcjJX074CSk8y41nfTyCu+WoQnOpgMruRZS2AoxRc/cgk1/1tjwqDT4dyPRxZLZjyn7lHGTbIxZjrQ8kvSFcY6V4BxgMJqgEoZrxljS8cY7BBmUadGK7tkTp4oGCPvQ8RxPxPIfEU+7LAg8t1BBP+8yEVGOHGlBVRuiav/JYYq1xgIc/PFHTYw= header: ephemeralPublicKey: MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgu7sidxY7MBgu5TPZdLJk4as3VnQ8IAD+qX0KLemH0rP+Nw0O9CdiNjAlYdtIvyfAgj7Lo7cB5ZQvjR3HsOR1w== publicKeyHash: lfaT/5QFZe4Cnb1T4j3hsgLJJdtVvMhfB/4EBx9rOQI= transactionId: bf84ca75845426f3faa1bdb30d07db9ef1cf68bdff766c57b44e45e0780d0b83 signature: MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJKoZIhvcNAQcBAACggDCCA+QwggOLoAMCAQICCFnYobyq9OPNMAoGCCqGSM49BAMCMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0yMTA0MjAxOTM3MDBaFw0yNjA0MTkxOTM2NTlaMGIxKDAmBgNVBAMMH2VjYy1zbXAtYnJva2VyLXNpZ25fVUM0LVNBTkRCT1gxFDASBgNVBAsMC2lPUyBTeXN0ZW1zMRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABIIw/avDnPdeICxQ2ZtFEuY34qkB3Wyz4LHNS1JnmPjPTr3oGiWowh5MM93OjiqWwvavoZMDRcToekQmzpUbEpWjggIRMIICDTAMBgNVHRMBAf8EAjAAMB8GA1UdIwQYMBaAFCPyScRPk+TvJ+bE9ihsP6K7/S5LMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMB0GA1UdDgQWBBQCJDALmu7tRjGXpKZaKZ5CcYIcRTAOBgNVHQ8BAf8EBAMCB4AwDwYJKoZIhvdjZAYdBAIFADAKBggqhkjOPQQDAgNHADBEAiB0obMk20JJQw3TJ0xQdMSAjZofSA46hcXBNiVmMl+8owIgaTaQU6v1C1pS+fYATcWKrWxQp9YIaDeQ4Kc60B5K2YEwggLuMIICdaADAgECAghJbS+/OpjalzAKBggqhkjOPQQDAjBnMRswGQYDVQQDDBJBcHBsZSBSb290IENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDA1MDYyMzQ2MzBaFw0yOTA1MDYyMzQ2MzBaMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABPAXEYQZ12SF1RpeJYEHduiAou/ee65N4I38S5PhM1bVZls1riLQl3YNIk57ugj9dhfOiMt2u2ZwvsjoKYT/VEWjgfcwgfQwRgYIKwYBBQUHAQEEOjA4MDYGCCsGAQUFBzABhipodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlcm9vdGNhZzMwHQYDVR0OBBYEFCPyScRPk+TvJ+bE9ihsP6K7/S5LMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUu7DeoVgziJqkipnevr3rr9rLJKswNwYDVR0fBDAwLjAsoCqgKIYmaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVyb290Y2FnMy5jcmwwDgYDVR0PAQH/BAQDAgEGMBAGCiqGSIb3Y2QGAg4EAgUAMAoGCCqGSM49BAMCA2cAMGQCMDrPcoNRFpmxhvs1w1bKYr/0F+3ZD3VNoo6+8ZyBXkK3ifiY95tZn5jVQQ2PnenC/gIwMi3VRCGwowV3bF3zODuQZ/0XfCwhbZZPxnJpghJvVPh6fRuZy5sJiSFhBpkPCZIdAAAxggGJMIIBhQIBATCBhjB6MS4wLAYDVQQDDCVBcHBsZSBBcHBsaWNhdGlvbiBJbnRlZ3JhdGlvbiBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMCCFnYobyq9OPNMAsGCWCGSAFlAwQCAaCBkzAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0yNTA0MDExMzQyMDlaMCgGCSqGSIb3DQEJNDEbMBkwCwYJYIZIAWUDBAIBoQoGCCqGSM49BAMCMC8GCSqGSIb3DQEJBDEiBCAj19NXaH9dIlnGZE2eRBi8ZPb6PtUF3wGPm66tjfROGjAKBggqhkjOPQQDAgRIMEYCIQDO0qfGETOUHRJNDO86J12oucqVeEOap6shJ5iGsAeupgIhAPO8YJKyYYdPFxU+VFkLAlMdbIxgOuDV54SdLCSQ/xI0AAAAAAAA version: EC_v1 paymentMethod: displayName: Visa 0224 network: Visa type: debit transactionIdentifier: bf84ca75845426f3faa1bdb30d07db9ef1cf68bdff766c57b44e45e0780d0b83 additionalProperties: false type: object required: - method - token title: ApplePayPaymentMethodCreate description: Create an Apple Pay transaction with a device or merchant token. 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 CardWithUrlPaymentMethodCreate: properties: expiration_date: type: string maxLength: 5 minLength: 5 pattern: ^\d{2}/\d{2}$ title: Expiration Date description: The expiration date of the card, formatted `MM/YY`. examples: - 12/30 number: type: string maxLength: 19 minLength: 13 pattern: ^\d+$ title: Number description: The 13-19 digit number for this card. examples: - '4111111111111111' buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The external identifier of the buyer to attach the method to. examples: - buyer-12345 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to attach the method to. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant reference for this payment method. examples: - payment-method-12345 card_type: anyOf: - $ref: '#/components/schemas/CardType' - type: 'null' description: The type of the card used examples: - credit method: type: string const: card title: Method description: Always `card` default: card examples: - card security_code: anyOf: - type: string maxLength: 4 minLength: 3 pattern: ^\d+$ - type: 'null' title: Security Code description: The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD. examples: - '123' redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com additionalProperties: false type: object required: - expiration_date - number title: CardWithUrlPaymentMethodCreate description: Create a transaction with raw card details 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 PlaidPaymentMethodCreate: properties: method: type: string const: plaid title: Method description: Always `plaid`. default: plaid examples: - plaid token: type: string title: Token description: The public token obtained after using Plaid Link. examples: - public-sandbox-7147ceee-816c-4272-a7f4-544f5c3d4d16 account_id: anyOf: - type: string - type: 'null' title: Account Id description: The Plaid account ID corresponding to the end-user account. If not provided will be fetched from Plaid API expecting to only have one. examples: - 5BpEdV8iZNBBvN9yw8pGfLbnqo5QWbF5lgzPe payment_service_id: anyOf: - type: string format: uuid - type: 'null' title: Payment Service Id description: The ID of the Plaid payment service related to the provided public token. If not provided will be fetched from the currently active expecting to have a single one. examples: - fffd152a-9532-4087-9a4f-de58754210f0 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to attach the method to. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The merchant reference for this payment method. examples: - payment-method-12345 external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant identifier for this payment method. examples: - payment-method-12345 additionalProperties: false type: object required: - token title: PlaidPaymentMethodCreate description: 'Plaid Payment Method Plaid Payment Method to use in a transaction.' 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 TransactionCancel: properties: type: type: string const: transaction-cancel title: Type description: Always `transaction-cancel`. default: transaction-cancel examples: - transaction-cancel status: $ref: '#/components/schemas/CancelStatus' description: The status of the cancel call. examples: - succeeded code: anyOf: - type: string - type: 'null' title: Code description: The standardized error code set by Gr4vy. examples: - service_error raw_response_code: anyOf: - type: string - type: 'null' title: Raw Response Code description: This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - E104 raw_response_description: anyOf: - type: string - type: 'null' title: Raw Response Description description: This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - Internal error transaction: $ref: '#/components/schemas/Transaction_2' description: The transaction associated to this cancel. additionalProperties: false type: object required: - status - code - raw_response_code - raw_response_description - transaction title: TransactionCancel 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 TransactionEventContext: properties: {} additionalProperties: true type: object title: TransactionEventContext 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 CVVResponseCode: type: string enum: - match - no_match - unavailable - not_provided title: CVVResponseCode 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 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 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 TransactionSummary_2: properties: type: type: string const: transaction title: Type description: Always `transaction`. default: transaction examples: - transaction id: type: string format: uuid title: Id description: The ID for the transaction. examples: - 7099948d-7286-47e4-aad8-b68f7eb44591 reconciliation_id: type: string title: Reconciliation Id description: The base62 encoded transaction ID. This represents a shorter version of this transaction'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 transaction against our system. This ID is sent instead of the transaction ID because not all services support 36 digit identifiers. examples: - default merchant_account_id: type: string title: Merchant Account Id description: The ID of the merchant account this transaction belongs to. examples: - default currency: type: string pattern: ^[A-Z]{3}$ title: Currency description: The currency code for this transaction. examples: - EUR - GBP - USD amount: type: integer title: Amount description: The total amount for this transaction across all funding sources including gift cards. examples: - 1299 status: $ref: '#/components/schemas/TransactionStatus' description: The status of the transaction for the `payment_method`. The status may change over time as asynchronous processing events occur. examples: - authorization_succeeded authorized_amount: type: integer title: Authorized Amount description: The amount for this transaction that has been authorized for the `payment_method`. This can be less than the `amount` if gift cards were used. examples: - 1299 captured_amount: type: integer title: Captured Amount description: The total amount captured for this transaction, in the smallest currency unit (for example, cents or pence). This can be the full value of the `authorized_amount` or less. examples: - 1299 refunded_amount: type: integer title: Refunded Amount description: The total amount refunded for this transaction, in the smallest currency unit (for example, cents or pence). This can be the full value of the `captured_amount` or less. examples: - 1299 settled_currency: anyOf: - type: string pattern: ^[A-Z]{3}$ examples: - EUR - GBP - USD - type: 'null' title: Settled Currency description: The ISO 4217 currency code of this transaction's settlement. examples: - USD settled_amount: type: integer title: Settled Amount description: The net amount settled for this transaction, in the smallest currency unit (for example, cents or pence). examples: - 1100 settled: type: boolean title: Settled description: Indicates whether this transaction has been settled. examples: - true country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Country description: The 2-letter ISO 3166-1 alpha-2 country code for the transaction. Used to filter payment services for processing. examples: - US external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: An external identifier that can be used to match the transaction against your own records. examples: - transaction-12345 intent: $ref: '#/components/schemas/TransactionIntent' description: The original `intent` used when the transaction was created. examples: - capture payment_method: anyOf: - $ref: '#/components/schemas/TransactionPaymentMethod' - type: 'null' description: The payment method used for this transaction. method: anyOf: - $ref: '#/components/schemas/Method' - type: 'null' description: The method used for the transaction. examples: - card instrument_type: anyOf: - $ref: '#/components/schemas/InstrumentType' - type: 'null' description: The name of the instrument used to process the transaction. examples: - pan error_code: anyOf: - type: string - type: 'null' title: Error Code description: The standardized error code set by Gr4vy. examples: - missing_redirect_url payment_service: anyOf: - $ref: '#/components/schemas/TransactionPaymentService' - type: 'null' description: The payment service used for this transaction. pending_review: type: boolean title: Pending Review description: Whether a manual anti fraud review is pending with an anti fraud service. default: false examples: - false buyer: anyOf: - $ref: '#/components/schemas/TransactionBuyer' - type: 'null' description: The buyer used for this transaction. raw_response_code: anyOf: - type: string - type: 'null' title: Raw Response Code description: This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - E104 raw_response_description: anyOf: - type: string - type: 'null' title: Raw Response Description description: ' This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' examples: - Missing redirect URL shipping_details: anyOf: - $ref: '#/components/schemas/ShippingDetails' - type: 'null' description: The shipping details associated with the transaction. checkout_session_id: anyOf: - type: string format: uuid - type: 'null' title: Checkout Session Id description: The identifier for the checkout session this transaction is associated with. examples: - 4137b1cf-39ac-42a8-bad6-1c680d5dab6b gift_card_redemptions: items: $ref: '#/components/schemas/GiftCardRedemption_2' type: array title: Gift Card Redemptions description: The gift cards redeemed for this transaction. gift_card_service: anyOf: - $ref: '#/components/schemas/GiftCardService' - type: 'null' description: The gift card service used for this transaction. created_at: type: string format: date-time title: Created At description: The date and time when the transaction was created, in ISO 8601 format. examples: - '2013-07-16T19:23:00.000+00:00' updated_at: type: string format: date-time title: Updated At description: The date and time when the transaction was last updated, in ISO 8601 format. examples: - '2013-07-16T19:23:00.000+00:00' disputed: type: boolean title: Disputed description: Indicates whether this transaction has been disputed. examples: - true reauthorized_from_transaction_id: anyOf: - type: string format: uuid - type: 'null' title: Reauthorized From Transaction Id description: The identifier of the transaction from which this transaction was reauthorized. examples: - 4137b1cf-39ac-42a8-bad6-1c680d5dab6b additionalProperties: false type: object required: - id - reconciliation_id - merchant_account_id - currency - amount - status - authorized_amount - captured_amount - refunded_amount - settled_amount - settled - intent - gift_card_redemptions - created_at - updated_at - disputed title: TransactionSummary description: A transaction, summarised 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 GiftCardErrorCode: type: string enum: - invalid_gift_card - expired_card - inactive_card - invalid_service_credentials - invalid_amount - incorrect_currency - insufficient_funds - invalid_service_configuration - operation_canceled - service_error - service_network_error - unknown_error - max_gift_cards_reached - suspected_fraud - canceled_payment_method - duplicate_transaction - unexpected_state title: GiftCardErrorCode description: 'Gift card error codes. Gr4vy normalised gift card error codes. Keep the naming and style in line with those in the connectors framework. If new codes are added, append them at the end or amend public simulator documentation: https://docs.gr4vy.com/guides/features/gift-cards/simulator' 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 ThreeDSecureMethod: type: string enum: - challenge - frictionless title: ThreeDSecureMethod 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 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 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 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 TransactionCreate: properties: amount: type: integer maximum: 99999999.0 minimum: 0.0 title: Amount description: The monetary amount for this transaction, in the smallest currency unit for the given currency, for example `1299` cents to create an authorization for `$12.99`. If the `intent` is set to `capture`, an amount greater than zero must be supplied. All gift card amounts are subtracted from this amount before the remainder is charged to the provided `payment_method`. examples: - 1299 currency: type: string pattern: ^[A-Z]{3}$ title: Currency description: A supported ISO 4217 currency code. For redirect requests, this value must match the one specified for `currency` in `payment_method`. examples: - EUR - GBP - USD country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Country description: The 2-letter ISO code of the country where the transaction is processed. This is also used to filter the payment services that can process the transaction. If this value is provided for redirect requests and it's not `null`, it must match the one specified for `country` in `payment_method`. Otherwise, the value specified for `country` in `payment_method` will be assumed implicitly. examples: - US payment_method: anyOf: - $ref: '#/components/schemas/CardWithUrlPaymentMethodCreate' - $ref: '#/components/schemas/RedirectPaymentMethodCreate' - $ref: '#/components/schemas/TokenPaymentMethodCreate' - $ref: '#/components/schemas/ApplePayPaymentMethodCreate' - $ref: '#/components/schemas/ClickToPayPaymentMethodCreate' - $ref: '#/components/schemas/ClickToPayFPANPaymentMethodCreate' - $ref: '#/components/schemas/GooglePayPaymentMethodCreate' - $ref: '#/components/schemas/GooglePayFPANPaymentMethodCreate' - $ref: '#/components/schemas/PazePaymentMethodCreate' - $ref: '#/components/schemas/NetworkTokenPaymentMethodCreate' - $ref: '#/components/schemas/PlaidPaymentMethodCreate' - $ref: '#/components/schemas/BaseBankPaymentMethodCreate' - $ref: '#/components/schemas/CheckoutSessionWithUrlPaymentMethodCreate' - type: 'null' title: Payment Method description: The optional payment method to use for this transaction. This field is required if no `gift_cards` have been added. buyer: anyOf: - $ref: '#/components/schemas/GuestBuyer' - type: 'null' description: Guest buyer details provided inline rather than creating a buyer resource beforehand and using the `buyer_id` or `buyer_external_identifier` keys. No buyer resource will be created on Gr4vy when used. buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to associate this payment method to. If this field is provided then the `buyer_external_identifier` field needs to be unset. If a stored payment method or gift card is provided, then the buyer for that payment method needs to match the buyer for this field. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The `external_identifier` of the buyer to associate this payment method to. If this field is provided then the `buyer_id` field needs to be unset. If a stored payment method or gift card is provided, then the buyer for that payment method needs to match the buyer for this field. examples: - buyer-12345 gift_cards: anyOf: - items: anyOf: - $ref: '#/components/schemas/GiftCardTransactionCreate' - $ref: '#/components/schemas/GiftCardTokenTransactionCreate' type: array - type: 'null' title: Gift Cards description: The optional gift card(s) to use for this transaction. At least one gift card is required if no other `payment_method` has been added. By default, only a maximum limit of 10 gift cards may be used in a single transaction. Please contact our team to change this limit. external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: An external identifier that can be used to match the transaction against your own records. examples: - transaction-12345 intent: $ref: '#/components/schemas/TransactionIntent' description: 'Defines the intent of this API call. This determines the desired initial state of the transaction. * `authorize` - (Default) Optionally approves and then authorizes a transaction but does not capture the funds. * `capture` - Optionally approves and then authorizes and captures the funds of the transaction.' default: authorize examples: - authorize store: type: boolean title: Store description: ' Whether or not to also try and store the payment method with us so that it can be used again for future use. This is only supported for payment methods that support this feature. There are also a few restrictions on how the flag may be set: * The flag has to be set to `true` when the `payment_source` is set to `recurring` or `installment`, and `merchant_initiated` is set to `false`. * The flag has to be set to `false` (or not set) when using a previously vaulted payment method.' default: false examples: - true three_d_secure_data: anyOf: - $ref: '#/components/schemas/ThreeDSecureDataV1_2' - $ref: '#/components/schemas/ThreeDSecureDataV2_2' - type: 'null' title: Three D Secure Data description: Pass through 3-D Secure data to support external 3-D Secure authorisation. If using an external 3-D Secure provider, you should not pass a `redirect_url` in the `payment_method` object for a transaction. three_d_secure: anyOf: - $ref: '#/components/schemas/ThreeDSecure' - type: 'null' description: Optional 3-D Secure values to use during the authentication flow. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it. examples: - cohort: cohort-12345 order: order-12345 is_subsequent_payment: type: boolean title: Is Subsequent Payment description: 'Indicates whether the transaction represents a subsequent payment coming from a setup recurring payment. Please note there are some restrictions on how this flag may be used. The flag can only be `false` (or not set) when the transaction meets one of the following criteria: * It is not `merchant_initiated`. * `payment_source` is set to `card_on_file`. The flag can only be set to `true` when the transaction meets one of the following criteria: * It is not `merchant_initiated`. * `payment_source` is set to `recurring` or `installment` and `merchant_initiated` is set to `true`. * `payment_source` is set to `card_on_file`.' default: false examples: - true merchant_initiated: type: boolean title: Merchant Initiated description: Indicates whether the transaction was initiated by the merchant (true) or customer (false). default: false examples: - true payment_source: $ref: '#/components/schemas/TransactionPaymentSource' description: The use-case for the the transaction. default: ecommerce examples: - ecommerce airline: anyOf: - $ref: '#/components/schemas/Airline_2' - type: 'null' description: The airline addendum data which describes the airline booking associated with this transaction. description: anyOf: - type: string - type: 'null' title: Description description: An optional description for the transaction. Forwarded to the payment processor where supported. Unlike `statement_descriptor`, this field has no character limit and does not appear on the buyer's bank statement. examples: - subscription-abc-123 cart_items: anyOf: - items: $ref: '#/components/schemas/CartItem_2' type: array - type: 'null' title: Cart Items description: An array of cart items that represents the line items of a transaction. statement_descriptor: anyOf: - $ref: '#/components/schemas/StatementDescriptor_2' - type: 'null' description: Details about the payment and the merchant which may end up on the (bank) statement for the payment. previous_scheme_transaction_id: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Previous Scheme Transaction Id description: A scheme's transaction identifier to use in connecting a merchant initiated transaction to a previous customer initiated transaction. If not provided, and a qualifying customer initiated transaction has been previously made with the stored payment method, then Gr4vy will populate this value with the identifier returned for that transaction. This field is also know as the Visa Transaction Identifier, or Mastercard Trace ID. examples: - '123456789012345' previous_transaction_link_id: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Previous Transaction Link Id description: A scheme's transaction link identifier to use in connecting a merchant initiated transaction to a previous customer initiated transaction. If not provided, and a qualifying customer initiated transaction has been previously made with the stored payment method, then Gr4vy will populate this value with the identifier returned for that transaction. This field is also know as the Mastercard Transaction Link ID (TLID). examples: - '123456789012345' browser_info: anyOf: - $ref: '#/components/schemas/BrowserInfo_2' - type: 'null' description: Information about the browser used by the buyer. This can be used by anti-fraud services. shipping_details_id: anyOf: - type: string format: uuid - type: 'null' title: Shipping Details Id description: The unique identifier of a set of shipping details stored for the buyer. If provided, the created transaction will include a copy of the details at the point of transaction creation; i.e. it will not be affected by later changes to the detail in the database. examples: - bf8c36ad-02d9-4904-b0f9-a230b149e341 connection_options: anyOf: - $ref: '#/components/schemas/TransactionConnectionOptions' - type: 'null' title: Connection Options 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. async_capture: type: boolean title: Async Capture description: 'Whether to capture the transaction asynchronously when an authorization-capture split occurs. This flag is only used if the transaction flow is split between authorization and capture. The split itself is not controlled by this flag and depends on other conditions, including delayed capture support, direct capture support, card scheme, gift cards, and anti-fraud decision. - When `async_capture` is `false` (default) and applicable, the capture is attempted in the same request. - When `async_capture` is `true` and applicable, the capture is performed outside the context of this request. Redirect transactions are not affected by this flag. This flag can only be set to `true` when `intent` is set to `capture`. Please check the public documentation for full authorization-capture split behavior details.' default: false examples: - true x-gr4vy-docs-ignore: true anti_fraud_fingerprint: anyOf: - type: string - type: 'null' title: Anti Fraud Fingerprint description: This field represents the fingerprint data to be passed to the active anti-fraud service. examples: - yGeBAFYgFmM= payment_service_id: anyOf: - type: string format: uuid - type: 'null' title: Payment Service Id description: The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped. examples: - fffd152a-9532-4087-9a4f-de58754210f0 account_funding_transaction: type: boolean title: Account Funding Transaction description: Marks the transaction as an AFT. Requires the payment service to support this feature, and might `recipient` and `buyer` data default: false examples: - true allow_partial_authorization: type: boolean title: Allow Partial Authorization description: Defines if the transaction will allow for a partial authorization. default: false recipient: anyOf: - $ref: '#/components/schemas/Recipient_2' - type: 'null' description: The recipient of any account to account funding. For use with AFTs. 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. tax_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Tax Amount description: The sales tax amount for this transaction, 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 merchant_tax_id: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Merchant Tax Id description: Merchant tax ID (for example, EIN or VAT number). purchase_order_number: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Purchase Order Number description: Invoice number or Purchase Order number. customer_reference_number: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Customer Reference Number description: Customer code or reference. amount_includes_tax: anyOf: - type: boolean - type: 'null' title: Amount Includes Tax description: Whether the tax is included in the amount. examples: - false supplier_order_number: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Supplier Order Number description: The merchant's unique identifier for the sales order or invoice. duty_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Duty Amount description: Total charges for import/export duties. examples: - 1299 shipping_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Shipping Amount description: Total shipping amount. examples: - 1299 integration_client: anyOf: - $ref: '#/components/schemas/IntegrationClient' - type: 'null' description: Defines the client where the session for this transaction is going to be used. Please refer to the connections documentation for more guidance. examples: - web approval_expires_at: anyOf: - type: string format: date-time - type: 'null' title: Approval Expires At description: The date and time when the buyer's approval window for this transaction expires. If not provided, this is automatically computed from the connector's default expiration time. The value cannot exceed the connector's maximum approval window. examples: - '2026-04-01T12:00:00+00:00' additionalProperties: false type: object required: - amount - currency title: TransactionCreate 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 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 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 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 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 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 TokenPaymentMethodCreate: properties: id: type: string format: uuid title: Id description: The ID for the payment method. examples: - ef9496d8-53a5-4aad-8ca2-00eb68334389 method: type: string const: id title: Method description: Always `id`. default: id examples: - id security_code: anyOf: - type: string maxLength: 4 minLength: 3 pattern: ^\d+$ - type: 'null' title: Security Code description: The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD. examples: - '123' redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after they approve the transaction in the browser. examples: - https://example.com additionalProperties: false type: object required: - id title: TokenPaymentMethodCreate description: Create a transaction with the ID (token) of a stored payment method (and an optional URL for approval) 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 CardScheme: type: string enum: - accel - amex - bancontact - carte-bancaire - cirrus - culiance - dankort - diners-club - discover - eftpos-australia - elo - hipercard - jcb - maestro - mastercard - mir - nyce - other - pulse - qcard - rupay - star - uatp - unionpay - visa title: CardScheme ThreeDSecureError_2: properties: code: anyOf: - type: string maxLength: 3 minLength: 3 - type: 'null' title: Code description: The error code. examples: - '305' description: anyOf: - type: string maxLength: 2048 - type: 'null' title: Description description: The error description. examples: - Invalid ThreeDSCompInd detail: anyOf: - type: string maxLength: 2048 - type: 'null' title: Detail description: Detail about the 3DS error. examples: - The threeDSCompInd must be 'Y' when successful component: anyOf: - type: string maxLength: 1 minLength: 1 - type: 'null' title: Component description: Code indicating the 3-D Secure component that identified the error. examples: - C additionalProperties: false type: object title: ThreeDSecureError TransactionAuthorizationIncrementCreate: properties: amount: type: integer maximum: 99999999.0 minimum: 0.0 title: Amount description: The amount by which to increment the authorization, in the smallest currency unit of the transaction's currency. For example, `1299` cents to increment the authorization by `$12.99`. examples: - 1299 additionalProperties: false type: object required: - amount title: TransactionAuthorizationIncrementCreate 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 AirlineLeg_2: properties: arrival_airport: anyOf: - type: string maxLength: 3 minLength: 3 - type: 'null' title: Arrival Airport description: Arrival airport code of leg. 3-letter ISO code according to IATA official directory. examples: - LAX arrival_at: anyOf: - type: string format: date-time - type: 'null' title: Arrival At description: The date and time of travel in local time at the arrival airport. examples: - '2013-07-16T19:23:00.000+00:00' arrival_city: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Arrival City description: Arrival city name. examples: - Los Angeles arrival_country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Arrival Country description: Arrival country code in ISO 3166 format. examples: - US carrier_code: anyOf: - type: string maxLength: 3 minLength: 2 - type: 'null' title: Carrier Code description: 3 character airline code as set by IATA. examples: - '649' carrier_name: anyOf: - type: string minLength: 1 - type: 'null' title: Carrier Name description: Name of the airline. examples: - Air Transat A.T. Inc iata_designator: anyOf: - type: string maxLength: 2 minLength: 2 - type: 'null' title: Iata Designator description: Two-character IATA code of the airline. examples: - TS icao_code: anyOf: - type: string maxLength: 3 minLength: 3 - type: 'null' title: Icao Code description: Three-character ICAO code of the airline. examples: - TSC coupon_number: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Coupon Number description: Coupon number associated with the leg. examples: - '15885566' departure_airport: anyOf: - type: string maxLength: 3 minLength: 3 - type: 'null' title: Departure Airport description: Departure airport code of leg. 3-letter ISO code according to IATA official directory. examples: - LHR departure_at: anyOf: - type: string format: date-time - type: 'null' title: Departure At description: The date and time of travel in local time at the departure airport. examples: - '2013-07-16T19:23:00.000+00:00' departure_city: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Departure City description: Departure city name. examples: - London departure_country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Departure Country description: Departure airport code of leg. 3-letter ISO code according to IATA official directory. examples: - GB departure_tax_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Departure Tax Amount description: Departure tax amount charged by a country when a person is leaving the country. examples: - 1200 fare_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Fare Amount description: Amount of the ticket, for current leg of the trip, excluding taxes and fees. examples: - 129900 fare_basis_code: anyOf: - type: string maxLength: 8 minLength: 1 - type: 'null' title: Fare Basis Code description: The alphanumeric code for the booking class of a ticket. examples: - FY fee_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Fee Amount description: Fee amount for current leg of the trip. examples: - 1200 flight_class: anyOf: - type: string maxLength: 5 minLength: 1 - type: 'null' title: Flight Class description: Indicates service class (first class, business class, etc.). examples: - E flight_number: anyOf: - type: string maxLength: 6 minLength: 3 - type: 'null' title: Flight Number description: Unique identifier of the flight number. examples: - '101' route_type: anyOf: - type: string enum: - round_trip - one_way - type: 'null' title: Route Type description: The route type of the flight. examples: - round_trip seat_class: anyOf: - type: string maxLength: 5 minLength: 1 - type: 'null' title: Seat Class description: Indicates seat class (first class, business class, etc.). examples: - F stop_over: anyOf: - type: boolean - type: 'null' title: Stop Over description: Indicates whether a stopover is allowed on this ticket. examples: - false tax_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Tax Amount description: Amount of the taxes for current leg of the trip. examples: - 1200 additionalProperties: false type: object title: AirlineLeg TransactionPaymentSource: type: string enum: - ecommerce - moto - recurring - installment - card_on_file title: TransactionPaymentSource description: The way payment method information made it to this transaction. CaptureStatus: type: string enum: - succeeded - pending - declined - failed title: CaptureStatus 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 Method: type: string enum: - abitab - affirm - afterpay - alipay - alipayhk - applepay - arcuspaynetwork - bacs - bancontact - bank - bcp - becs - bitpay - blik - ach - boleto - boost - breb - capitec - card - cashapp - cashappafterpay - chaseorbital - clearpay - click-to-pay - custom_push - custom_redirect - custom_tokenize - dana - dcb - dlocal - duitnow - ebanx - eckoh - efecty - eps - everydaypay - gcash - gem - gemds - gift-card - giropay - givingblock - gocardless - googlepay - googlepay_pan_only - gopay - grabpay - ideal - interac - kakaopay - kcp - khipu - klarna - konbini - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - nequi - netbanking - network-token - nupay - oney_10x - oney_12x - oney_3x - oney_4x - oney_6x - onlinebankingcz - onelink - ovo - oxxo - p24 - pagoefectivo - paybybank - payid - paymaya - paysquad - paypal - paypaldirectorder - paypalpaylater - paypay - payto - payvalida - paze - picpay - pix - plaid - pse - rabbitlinepay - razorpay - rapipago - redpagos - scalapay - sepa - servipag - seveneleven - sezzle - shopeepay - singteldash - smartpay - sofort - spei - stitch - swish - stripe - stripedd - stripetoken - tapi - tapifintechs - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - venmo - vipps - waave - webpay - wechat - wero - yape - zippay title: Method TransactionPaymentMethod: properties: type: type: string const: payment-method title: Type description: Always `payment-method`. default: payment-method examples: - payment-method approval_url: anyOf: - type: string - type: 'null' title: Approval Url description: The optional URL that the buyer needs to be redirected to to further authorize their payment. examples: - https://gr4vy.app/redirect/12345 country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Country description: The 2-letter ISO code of the country this payment method can be used for. If this value is null the payment method may be used in multiple countries. examples: - US currency: anyOf: - type: string pattern: ^[A-Z]{3}$ examples: - EUR - GBP - USD - type: 'null' title: Currency description: The ISO-4217 currency code that this payment method can be used for. If this value is null the payment method may be used for multiple currencies. examples: - USD details: anyOf: - $ref: '#/components/schemas/PaymentMethodDetailsCard_2' - type: 'null' description: Details for credit or debit card payment method. expiration_date: anyOf: - type: string maxLength: 5 minLength: 5 pattern: ^\d{2}/\d{2}$ - type: 'null' title: Expiration Date description: The expiration date for the payment method. examples: - 12/30 fingerprint: anyOf: - type: string - type: 'null' title: Fingerprint description: The unique hash derived from the payment method identifier (e.g. card number). examples: - 20eb353620155d2b5fc864cc46a73ea77cb92c725238650839da1813fa987a17 label: anyOf: - type: string maxLength: 320 minLength: 0 - type: 'null' title: Label description: A label for the card or the account. For a paypal payment method this is the user's email address. For a card it is the last 4 digits of the card. examples: - '1234' last_replaced_at: anyOf: - type: string format: date-time - type: 'null' title: Last Replaced At description: The date and time when this card was last replaced by the account updater. examples: - '2013-07-16T19:23:00.000+00:00' method: $ref: '#/components/schemas/Method' description: The type of this payment method. examples: - card mode: anyOf: - $ref: '#/components/schemas/Mode' - type: 'null' description: The mode to use with this payment method. examples: - card scheme: anyOf: - $ref: '#/components/schemas/CardScheme' - type: 'null' description: The scheme of the card. Only applies to card payments. examples: - visa id: anyOf: - type: string format: uuid - type: 'null' title: Id description: The ID of the payment method. examples: - 852b951c-d7ea-4c98-b09e-4a1c9e97c077 approval_target: anyOf: - $ref: '#/components/schemas/ApprovalTarget' - type: 'null' description: The browser target that an approval URL must be opened in. If any or null, then there is no specific requirement. examples: - any external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: An external identifier that can be used to match the payment method against your own records. examples: - card-12345 payment_account_reference: anyOf: - type: string - type: 'null' title: Payment Account Reference description: The payment account reference (PAR) returned by the card scheme. This is a unique reference to the underlying account that has been used to fund this payment method. examples: - V0010014629724763377327521982 additionalProperties: false type: object required: - method title: TransactionPaymentMethod 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 PaymentMethodDetailsCard_2: properties: bin: anyOf: - type: string maxLength: 8 minLength: 6 pattern: ^\d+$ - type: 'null' title: Bin card_type: anyOf: - $ref: '#/components/schemas/CardType' - type: 'null' card_issuer_name: anyOf: - type: string - type: 'null' title: Card Issuer Name additionalProperties: false type: object title: PaymentMethodDetailsCard WpayPaytoResourceOptions: additionalProperties: false properties: simulation: anyOf: - $ref: '#/components/schemas/WpayPaytoSimulationOptions' - type: 'null' default: null description: Simulate responses for this resource. title: WpayPaytoResourceOptions type: object VoidStatus: type: string enum: - succeeded - pending - declined - failed title: VoidStatus 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 TransactionStatus: type: string enum: - processing - authorization_succeeded - authorization_declined - authorization_failed - authorization_voided - authorization_void_pending - capture_succeeded - capture_pending - buyer_approval_pending title: TransactionStatus 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 ApprovalTarget: type: string enum: - new_window - any title: ApprovalTarget GiftCardService: properties: type: type: string const: gift-card-service title: Type description: Always `gift-card-service`. default: gift-card-service examples: - gift-card-service id: type: string format: uuid title: Id description: The ID for the gift card service. examples: - 35b60feec-a7c7-4844-b503-f39b09192d81 gift_card_service_definition_id: $ref: '#/components/schemas/GiftCardServiceProvider' description: The ID of the definition for this service. examples: - qwikcilver-gift-card display_name: type: string maxLength: 200 minLength: 1 title: Display Name description: The display name for the gift card service. examples: - Qwikcilver USA additionalProperties: false type: object required: - id - gift_card_service_definition_id - display_name title: GiftCardService 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 IntegrationClient: type: string enum: - redirect - web - android - ios title: IntegrationClient 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 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 Recipient_2: properties: first_name: type: string title: First Name description: The first name of the recipient. examples: - '' last_name: type: string title: Last Name description: The last name of the recipient. examples: - '' address: anyOf: - $ref: '#/components/schemas/Address_2' - type: 'null' description: The recipient of the fund's address. account_number: anyOf: - type: string - type: 'null' title: Account Number description: The account number of the recipient. Depending on the type of funds transfer, this could be a wallet ID, bank accoutn number, or email address. examples: - act12345 date_of_birth: anyOf: - type: string format: date - type: 'null' title: Date Of Birth description: The date of birth of the recipient. examples: - '1995-12-23' additionalProperties: false type: object required: - first_name - last_name title: Recipient description: Recipient of an account funding transaction TransactionPaymentService: properties: type: type: string const: payment-service title: Type description: Always `payment-service`. default: payment-service examples: - payment-service id: type: string format: uuid title: Id description: The ID for the payment-service. examples: - 824ff064-7f4b-430b-9801-59aff90d013e payment_service_definition_id: type: string maxLength: 50 minLength: 1 title: Payment Service Definition Id description: The definition ID of the service used to process this payment. examples: - stripe-card method: $ref: '#/components/schemas/Method' description: The payment method that this service handles. examples: - card display_name: type: string title: Display Name description: The display name for the payment service. examples: - Stripe USA additionalProperties: false type: object required: - id - payment_service_definition_id - method - display_name title: TransactionPaymentService 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 CancelStatus: type: string enum: - succeeded - pending - failed title: CancelStatus 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 PazePaymentMethodCreate: properties: buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The external identifier of the buyer to create a payment for. examples: - buyer-12345 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to retrieve billing details for. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 cardholder_name: anyOf: - type: string maxLength: 200 minLength: 0 - type: 'null' title: Cardholder Name description: The card holder name associated to the original card for the token. examples: - John Luhn redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com card_suffix: anyOf: - type: string maxLength: 4 minLength: 4 - type: 'null' title: Card Suffix description: The last 4 digits of the original card used to generate the token. examples: - '1234' card_scheme: anyOf: - type: string - type: 'null' title: Card Scheme description: The original card scheme for which the token was generated. examples: - visa card_type: anyOf: - type: string - type: 'null' title: Card Type description: The payment scheme of the card. examples: - credit method: type: string const: paze title: Method description: Always `paze` examples: - paze token: type: string title: Token description: The opaque token as received from the Paze complete response. checkout_token: anyOf: - type: string - type: 'null' title: Checkout Token description: The signed checkout JWS as received from the Paze checkout response. additionalProperties: false type: object required: - method - token title: PazePaymentMethodCreate description: Create a Paze transaction with a device token. BaseBankPaymentMethodCreate: properties: method: type: string const: bank title: Method description: Always `bank`. default: bank examples: - bank account_holder: $ref: '#/components/schemas/BankAccountHolder' description: The account holder for this bank account buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to attach the method to. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The merchant reference for this payment method. examples: - payment-method-12345 external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant identifier for this payment method. examples: - payment-method-12345 additionalProperties: false type: object required: - account_holder title: BaseBankPaymentMethodCreate description: Base class for Bank Payment Methods. RedirectPaymentMethodCreate: properties: method: type: string enum: - abitab - affirm - afterpay - alipay - alipayhk - arcuspaynetwork - bacs - bancontact - bcp - becs - bitpay - blik - boleto - boost - breb - ach - capitec - cashapp - cashappafterpay - clearpay - custom_push - custom_redirect - custom_tokenize - dana - dcb - dlocal - duitnow - ebanx - eckoh - efecty - eps - everydaypay - gcash - gem - gemds - giropay - givingblock - gocardless - gopay - grabpay - ideal - interac - kakaopay - kcp - khipu - klarna - konbini - latitude - latitudeds - laybuy - linepay - linkaja - maybankqrpay - mercadopago - multibanco - multipago - netbanking - nupay - nequi - oney_10x - oney_12x - oney_3x - oney_4x - oney_6x - onlinebankingcz - onelink - ovo - oxxo - p24 - pagoefectivo - paybybank - payid - paymaya - paysquad - paypal - paypaldirectorder - paypalpaylater - paypay - payto - payvalida - picpay - pix - pse - rabbitlinepay - rapipago - razorpay - redpagos - scalapay - sepa - servipag - seveneleven - sezzle - shopeepay - singteldash - smartpay - sofort - spei - stitch - swish - stripe - stripedd - stripetoken - tapi - tapifintechs - thaiqr - touchngo - truemoney - trustly - trustlyeurope - upi - venmo - vipps - waave - webpay - wechat - wero - yape - zippay title: Method description: The method to use, this can be any of the methods that support redirect requests. examples: - paypal - zippay buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The `id` of a stored buyer to use Use this instead of the `buyer_external_identifier`. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The `external_identifier` of a stored buyer to use. Use this instead of the `buyer_id`. examples: - buyer-12345 country: type: string pattern: ^[A-Z]{2}$ title: Country description: The 2-letter ISO code of the country to use this payment method for. This is used to select the payment service to use. examples: - DE - GB - US currency: type: string pattern: ^[A-Z]{3}$ title: Currency description: The ISO-4217 currency code to use this payment method for. This is used to select the payment service to use. examples: - EUR - GBP - USD redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= title: Redirect Url description: The redirect URL to redirect a buyer to after they have authorized the payment method. examples: - https://example.com/callback external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant identifier for this payment method. examples: - payment-method-12345 additionalProperties: false type: object required: - method - country - currency - redirect_url title: RedirectPaymentMethodCreate description: Create a transaction for an APM/LPM that requires a redirect. 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 BankAccountHolder: properties: first_name: anyOf: - type: string - type: 'null' title: First Name description: The account holder's first name examples: - John last_name: anyOf: - type: string - type: 'null' title: Last Name description: The account holder's last name examples: - Doe company_name: anyOf: - type: string - type: 'null' title: Company Name description: The account holder's company name examples: - Gr4vy additionalProperties: false type: object title: BankAccountHolder GiftCardRedemptionStatus: type: string enum: - created - succeeded - failed - skipped title: GiftCardRedemptionStatus TransactionCapture: properties: type: type: string const: transaction-capture title: Type description: Always `transaction-capture`. default: transaction-capture examples: - transaction-capture status: $ref: '#/components/schemas/CaptureStatus' description: The status of the capture call. examples: - succeeded code: anyOf: - type: string - type: 'null' title: Code description: The standardized error code set by Gr4vy. examples: - service_error raw_response_code: anyOf: - type: string - type: 'null' title: Raw Response Code description: This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - E104 raw_response_description: anyOf: - type: string - type: 'null' title: Raw Response Description description: This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - Internal error transaction: $ref: '#/components/schemas/Transaction_2' description: The transaction associated to this capture. capture_id: anyOf: - type: string format: uuid - type: 'null' title: Capture Id description: The ID of the capture resource created for this capture. examples: - 77a76f7e-d2de-4bbc-ada9-d6a0015e6bd5 payment_service_capture_id: anyOf: - type: string - type: 'null' title: Payment Service Capture Id description: The payment service's unique ID for the capture. examples: - capture-12345 external_identifier: anyOf: - type: string - type: 'null' title: External Identifier description: The external identifier for the capture. examples: - capture-12345 billing_details: anyOf: - $ref: '#/components/schemas/BillingDetails_2' - type: 'null' description: The billing details associated with the capture. shipping_details: anyOf: - $ref: '#/components/schemas/ShippingDetails' - type: 'null' description: The shipping details associated with the catpure. tracking: anyOf: - items: $ref: '#/components/schemas/Tracking' type: array - type: 'null' title: Tracking description: The shipment tracking details associated with the capture. additionalProperties: false type: object required: - status - code - raw_response_code - raw_response_description - transaction title: TransactionCapture ForterAntiFraudOptionsCartItemBeneficiaryPhone: additionalProperties: false properties: phone: description: The phone number of the beneficiary. title: Phone type: string required: - phone title: ForterAntiFraudOptionsCartItemBeneficiaryPhone type: object GiftCardTransactionCreate: properties: number: type: string maxLength: 19 minLength: 16 pattern: ^\d+$ title: Number description: The 16-19 digit number for the gift card. examples: - '4123455541234561234' pin: type: string minLength: 1 title: Pin description: The PIN for this gift card. examples: - '1234' amount: type: integer title: Amount description: The monetary amount for this transaction to charge against the gift card, in the smallest currency unit (for example, cents or pence). examples: - 1299 additionalProperties: false type: object required: - number - pin - amount title: GiftCardTransactionCreate description: Create a charge against a gift card 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 ThreeDSecure: properties: amount: anyOf: - type: integer - type: 'null' title: Amount description: The amount to be used for 3DS authentication. Optionally set this value to authenticate a greater amount than the transaction amount. additionalProperties: false type: object title: ThreeDSecure 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 TransactionAuthorizationIncrement: properties: type: type: string const: transaction-authorization-increment title: Type description: Always `transaction-authorization-increment`. default: transaction-authorization-increment examples: - transaction-authorization-increment status: $ref: '#/components/schemas/IncrementalAuthorizationStatus' description: The status of the incremental authorization. examples: - succeeded code: anyOf: - type: string - type: 'null' title: Code description: The standardized error code set by Gr4vy. examples: - service_error raw_response_code: anyOf: - type: string - type: 'null' title: Raw Response Code description: This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - E104 raw_response_description: anyOf: - type: string - type: 'null' title: Raw Response Description description: This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - Internal error transaction: $ref: '#/components/schemas/Transaction_2' description: The transaction associated to this incremental authorization. additionalProperties: false type: object required: - status - code - raw_response_code - raw_response_description - transaction title: TransactionAuthorizationIncrement AdyenAutoRescueSepaScenariosEnum: enum: - AutoRescueSuccessfulFirst - AutoRescueSuccessfulSecond - AutoRescueFailed title: AdyenAutoRescueSepaScenariosEnum type: string AntiFraudDecision: type: string enum: - accept - error - exception - reject - review - skipped - pending title: AntiFraudDecision Transaction_2: properties: type: type: string const: transaction title: Type description: Always `transaction`. default: transaction examples: - transaction id: type: string format: uuid title: Id description: The ID for the transaction. examples: - 7099948d-7286-47e4-aad8-b68f7eb44591 reconciliation_id: type: string title: Reconciliation Id description: The base62 encoded transaction ID. This represents a shorter version of this transaction'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 transaction against our system. This ID is sent instead of the transaction ID because not all services support 36 digit identifiers. examples: - default merchant_account_id: type: string title: Merchant Account Id description: The ID of the merchant account this transaction belongs to. examples: - default currency: type: string pattern: ^[A-Z]{3}$ title: Currency description: The currency code for this transaction. examples: - EUR - GBP - USD amount: type: integer title: Amount description: The total amount for this transaction across all funding sources including gift cards. examples: - 1299 status: $ref: '#/components/schemas/TransactionStatus' description: The status of the transaction for the `payment_method`. The status may change over time as asynchronous processing events occur. examples: - authorization_succeeded authorized_amount: type: integer title: Authorized Amount description: The amount for this transaction that has been authorized for the `payment_method`. This can be less than the `amount` if gift cards were used. examples: - 1299 captured_amount: type: integer title: Captured Amount description: The total amount captured for this transaction, in the smallest currency unit (for example, cents or pence). This can be the full value of the `authorized_amount` or less. examples: - 1299 refunded_amount: type: integer title: Refunded Amount description: The total amount refunded for this transaction, in the smallest currency unit (for example, cents or pence). This can be the full value of the `captured_amount` or less. examples: - 1299 settled_currency: anyOf: - type: string pattern: ^[A-Z]{3}$ examples: - EUR - GBP - USD - type: 'null' title: Settled Currency description: The ISO 4217 currency code of this transaction's settlement. examples: - USD settled_amount: type: integer title: Settled Amount description: The net amount settled for this transaction, in the smallest currency unit (for example, cents or pence). examples: - 1100 settled: type: boolean title: Settled description: Indicates whether this transaction has been settled. examples: - true country: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Country description: The 2-letter ISO 3166-1 alpha-2 country code for the transaction. Used to filter payment services for processing. examples: - US external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: An external identifier that can be used to match the transaction against your own records. examples: - transaction-12345 intent: $ref: '#/components/schemas/TransactionIntent' description: The original `intent` used when the transaction was created. examples: - capture payment_method: anyOf: - $ref: '#/components/schemas/TransactionPaymentMethod' - type: 'null' description: The payment method used for this transaction. method: anyOf: - $ref: '#/components/schemas/Method' - type: 'null' description: The method used for the transaction. examples: - card instrument_type: anyOf: - $ref: '#/components/schemas/InstrumentType' - type: 'null' description: The name of the instrument used to process the transaction. examples: - pan error_code: anyOf: - type: string - type: 'null' title: Error Code description: The standardized error code set by Gr4vy. examples: - missing_redirect_url payment_service: anyOf: - $ref: '#/components/schemas/TransactionPaymentService' - type: 'null' description: The payment service used for this transaction. pending_review: type: boolean title: Pending Review description: Whether a manual anti fraud review is pending with an anti fraud service. default: false examples: - false buyer: anyOf: - $ref: '#/components/schemas/TransactionBuyer' - type: 'null' description: The buyer used for this transaction. raw_response_code: anyOf: - type: string - type: 'null' title: Raw Response Code description: This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - E104 raw_response_description: anyOf: - type: string - type: 'null' title: Raw Response Description description: ' This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.' examples: - Missing redirect URL shipping_details: anyOf: - $ref: '#/components/schemas/ShippingDetails' - type: 'null' description: The shipping details associated with the transaction. checkout_session_id: anyOf: - type: string format: uuid - type: 'null' title: Checkout Session Id description: The identifier for the checkout session this transaction is associated with. examples: - 4137b1cf-39ac-42a8-bad6-1c680d5dab6b gift_card_redemptions: items: $ref: '#/components/schemas/GiftCardRedemption_2' type: array title: Gift Card Redemptions description: The gift cards redeemed for this transaction. gift_card_service: anyOf: - $ref: '#/components/schemas/GiftCardService' - type: 'null' description: The gift card service used for this transaction. created_at: type: string format: date-time title: Created At description: The date and time when the transaction was created, in ISO 8601 format. examples: - '2013-07-16T19:23:00.000+00:00' updated_at: type: string format: date-time title: Updated At description: The date and time when the transaction was last updated, in ISO 8601 format. examples: - '2013-07-16T19:23:00.000+00:00' disputed: type: boolean title: Disputed description: Indicates whether this transaction has been disputed. examples: - true reauthorized_from_transaction_id: anyOf: - type: string format: uuid - type: 'null' title: Reauthorized From Transaction Id description: The identifier of the transaction from which this transaction was reauthorized. examples: - 4137b1cf-39ac-42a8-bad6-1c680d5dab6b airline: anyOf: - $ref: '#/components/schemas/Airline_2' - type: 'null' description: Contains information about an airline travel, if applicable. auth_response_code: anyOf: - type: string - type: 'null' title: Auth Response Code description: This is the response description received from the processor. examples: - '00' avs_response_code: anyOf: - $ref: '#/components/schemas/AVSResponseCode' - type: 'null' description: The response code received from the payment service for the Address Verification Check (AVS). This code is mapped to a standardized Gr4vy AVS response code. examples: - match cvv_response_code: anyOf: - $ref: '#/components/schemas/CVVResponseCode' - type: 'null' description: The response code received from the payment service for the Card Verification Value (CVV). This code is mapped to a standardized Gr4vy CVV response code. examples: - match anti_fraud_decision: anyOf: - $ref: '#/components/schemas/AntiFraudDecision' - type: 'null' description: The mapped decision received from the anti-fraud service. In case of a review decision this field is not updated once the review is resolved. examples: - accept payment_source: $ref: '#/components/schemas/TransactionPaymentSource' description: The source of the transaction. examples: - ecommerce merchant_initiated: type: boolean title: Merchant Initiated description: Indicates whether the transaction was initiated by the merchant or the customer. examples: - true is_subsequent_payment: type: boolean title: Is Subsequent Payment description: Indicates whether the transaction represents a subsequent payment or an initial one. examples: - false cart_items: anyOf: - items: $ref: '#/components/schemas/CartItem_2' type: array - type: 'null' title: Cart Items description: An array of cart items that represents the line items of a transaction. statement_descriptor: anyOf: - $ref: '#/components/schemas/StatementDescriptor_2' - type: 'null' description: The statement descriptor is the text to be shown on the buyer's statements. scheme_transaction_id: anyOf: - type: string - type: 'null' title: Scheme Transaction Id description: An identifier for the transaction used by the scheme itself, when available. examples: - '123456789012345' transaction_link_id: anyOf: - type: string - type: 'null' title: Transaction Link Id description: A transaction link identifier for the transaction used by the scheme itself, when available. examples: - '123456789012345' three_d_secure: anyOf: - $ref: '#/components/schemas/TransactionThreeDSecureSummary' - type: 'null' description: The 3-D Secure data that was sent to the payment service for the transaction. payment_service_transaction_id: anyOf: - type: string - type: 'null' title: Payment Service Transaction Id description: The payment service's unique ID for the transaction. examples: - tx-12345 additional_identifiers: additionalProperties: anyOf: - type: string - type: 'null' type: object title: Additional Identifiers description: A list of additional identifiers that we may keep track of to manage this transaction. This may include the authorization ID, capture ID, and processor ID, as well as an undefined list of additional identifiers. examples: - payment_service_authorization_id: auth-12345 payment_service_capture_id: capture-12345 metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: Additional information about the transaction stored as key-value pairs. examples: - cohort: cohort-12345 order: order-12345 authorized_at: anyOf: - type: string format: date-time - type: 'null' title: Authorized At description: The date this transaction was authorized at. examples: - '2013-07-16T19:23:00.000+00:00' captured_at: anyOf: - type: string format: date-time - type: 'null' title: Captured At description: The date this transaction was captured at. examples: - '2013-07-16T19:23:00.000+00:00' voided_at: anyOf: - type: string format: date-time - type: 'null' title: Voided At description: The date this transaction was voided at. examples: - '2013-07-16T19:23:00.000+00:00' canceled_at: anyOf: - type: string format: date-time - type: 'null' title: Canceled At description: The date this transaction was canceled at. examples: - '2013-07-16T19:23:00.000+00:00' approval_expires_at: anyOf: - type: string format: date-time - type: 'null' title: Approval Expires At description: The date this transaction's approval URL will expire at. examples: - '2013-07-16T19:23:00.000+00:00' buyer_approval_timedout_at: anyOf: - type: string format: date-time - type: 'null' title: Buyer Approval Timedout At description: The date this transaction's approval timed out at. examples: - '2013-07-16T19:23:00.000+00:00' intent_outcome: $ref: '#/components/schemas/TransactionIntentOutcome' description: The outcome of the original intent of a transaction. This allows you to understand if the intent of the transaction (e.g. `capture` or `authorize`) has been achieved when dealing with multiple payment instruments. examples: - succeeded multi_tender: type: boolean title: Multi Tender description: The outcome of the original intent of a transaction. This allows you to understand if the intent of the transaction (e.g. `capture` or `authorize`) has been achieved when dealing with multiple payment instruments. examples: - true account_funding_transaction: type: boolean title: Account Funding Transaction description: Marks the transaction as an AFT. Requires the payment service to support this feature, and might `recipient` and `buyer` data examples: - true recipient: anyOf: - $ref: '#/components/schemas/Recipient_2' - type: 'null' description: The recipient of any account to account funding. For use with AFTs. merchant_advice_code: anyOf: - type: string - type: 'null' title: Merchant Advice Code description: An optional merchant advice code which provides insight into the type of transaction or reason why the payment failed. examples: - '02' - '21' installment_count: anyOf: - type: integer - type: 'null' title: Installment Count description: The number of installments for this transaction, if applicable. examples: - 3 session_token: anyOf: - type: string - type: 'null' title: Session Token description: A session token that can be used to fetch session data for direct client integrations. examples: - j3CZf9Eg6nUygMAVA6PXsVWGHiccj tax_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Tax Amount description: The sales tax amount for this transaction, 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 merchant_tax_id: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Merchant Tax Id description: Merchant tax ID (for example, EIN or VAT number). purchase_order_number: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Purchase Order Number description: Invoice number or Purchase Order number. customer_reference_number: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Customer Reference Number description: Customer code or reference. amount_includes_tax: anyOf: - type: boolean - type: 'null' title: Amount Includes Tax description: Whether the tax is included in the amount. examples: - false supplier_order_number: anyOf: - type: string maxLength: 100 minLength: 1 - type: 'null' title: Supplier Order Number description: The merchant's unique identifier for the sales order or invoice. duty_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Duty Amount description: Total charges for import/export duties. examples: - 1299 shipping_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Shipping Amount description: Total shipping amount. examples: - 1299 iso_response_code: anyOf: - type: string - type: 'null' title: Iso Response Code description: This is the ISO8583 response code code received from the payment service. examples: - '0110' additionalProperties: false type: object required: - id - reconciliation_id - merchant_account_id - currency - amount - status - authorized_amount - captured_amount - refunded_amount - settled_amount - settled - intent - gift_card_redemptions - created_at - updated_at - disputed - payment_source - merchant_initiated - is_subsequent_payment - intent_outcome - multi_tender - account_funding_transaction title: Transaction description: A full transaction resource. 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 TransactionCaptureCreate: properties: amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Amount description: The amount to capture, in the smallest currency unit (e.g., cents). This must be less than or equal to the authorized amount, unless over-capture is available. examples: - 1299 airline: anyOf: - $ref: '#/components/schemas/Airline_2' - type: 'null' description: The airline data to submit to the payment service during the capture call. cart_items: anyOf: - items: $ref: '#/components/schemas/CartItem_2' type: array - type: 'null' title: Cart Items description: An array of cart items that represents the line items of this capture. tracking: anyOf: - items: $ref: '#/components/schemas/Tracking' type: array maxItems: 5 - type: 'null' title: Tracking description: An array of shipment tracking details for this capture. final: type: boolean title: Final description: Whether this is marked as the final capture for the associated transaction. Must be `true` or omitted when multi-capture is not enabled; a value of `false` is only valid when multi-capture is available on the connection. default: true examples: - true external_identifier: anyOf: - type: string maxLength: 300 minLength: 1 - type: 'null' title: External Identifier description: An external identifier that can be used to match the capture against your own records. examples: - capture-12345 reauthorize_if_authorization_expired: type: boolean title: Reauthorize If Authorization Expired description: Whether this capture request should re-authorize the transaction if it has expired. default: false examples: - true - false additionalProperties: false type: object title: TransactionCaptureCreate description: Request body for capturing an authorized transaction. 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 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 TransactionVoid: properties: type: type: string const: transaction-void title: Type description: Always `transaction-void`. default: transaction-void examples: - transaction-void status: $ref: '#/components/schemas/VoidStatus' description: The status of the void call. examples: - succeeded code: anyOf: - type: string - type: 'null' title: Code description: The standardized error code set by Gr4vy. examples: - service_error raw_response_code: anyOf: - type: string - type: 'null' title: Raw Response Code description: This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - E104 raw_response_description: anyOf: - type: string - type: 'null' title: Raw Response Description description: This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services. examples: - Internal error transaction: $ref: '#/components/schemas/Transaction_2' description: The transaction associated to this void. additionalProperties: false type: object required: - status - code - raw_response_code - raw_response_description - transaction title: TransactionVoid 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 Airline_2: properties: booking_code: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Booking Code description: The unique identifier of the reservation in the global distribution system. examples: - X36Q9C is_cardholder_traveling: anyOf: - type: boolean - type: 'null' title: Is Cardholder Traveling description: Indicates whether the cardholder is traveling. examples: - true issued_address: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Issued Address description: The address of the place/agency that issued the ticket. examples: - 123 Broadway, New York issued_at: anyOf: - type: string format: date-time - type: 'null' title: Issued At description: The date that the ticket was last issued in the airline reservation system. examples: - '2013-07-16T19:23:00.000+00:00' issuing_carrier_code: anyOf: - type: string maxLength: 3 minLength: 2 - type: 'null' title: Issuing Carrier Code description: For airline aggregators, three-character IATA code of the airline issuing the ticket. examples: - '649' issuing_carrier_name: anyOf: - type: string minLength: 1 - type: 'null' title: Issuing Carrier Name description: For airline aggregators, name of the airline issuing the ticket. examples: - Air Transat A.T. Inc issuing_iata_designator: anyOf: - type: string maxLength: 2 minLength: 2 - type: 'null' title: Issuing Iata Designator description: For airline aggregators, two-character IATA code of the airline issuing the ticket. examples: - TS issuing_icao_code: anyOf: - type: string maxLength: 3 minLength: 3 - type: 'null' title: Issuing Icao Code description: For airline aggregators, three-character ICAO code of the airline issuing the ticket. examples: - TSC legs: anyOf: - items: $ref: '#/components/schemas/AirlineLeg_2' type: array maxItems: 20 - type: 'null' title: Legs description: An array of separate trip segments. Each leg contains detailed itinerary information. passenger_name_record: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Passenger Name Record description: The Passenger Name Record (PNR) in the airline reservation system. examples: - JOHN L passengers: anyOf: - items: $ref: '#/components/schemas/AirlinePassenger_2' type: array maxItems: 20 - type: 'null' title: Passengers description: An array of the travelling passengers. reservation_system: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Reservation System description: The name of the reservation system. examples: - Amadeus restricted_ticket: anyOf: - type: boolean - type: 'null' title: Restricted Ticket description: Indicates whether the ticket is restricted (refundable). examples: - false ticket_delivery_method: anyOf: - type: string enum: - electronic - other - type: 'null' title: Ticket Delivery Method description: The delivery method of the ticket. default: electronic examples: - electronic ticket_number: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Ticket Number description: The airline's unique ticket number. examples: - 123-1234-151555 travel_agency_code: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Travel Agency Code description: The IATA travel agency code. examples: - '12345' travel_agency_invoice_number: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Travel Agency Invoice Number description: The reference number of the invoice that was issued by the travel agency. examples: - EG15555155 travel_agency_name: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Travel Agency Name description: The name of the travel agency. examples: - ACME Agency travel_agency_plan_name: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Travel Agency Plan Name description: The name of the travel agency plan. examples: - B733 additionalProperties: false type: object title: Airline description: Information about an airline travel. TransactionIntentOutcome: type: string enum: - pending - succeeded - failed title: TransactionIntentOutcome ThreeDSecureDataV1_2: properties: cavv: type: string title: Cavv description: The cardholder authentication value or AAV. examples: - 3q2+78r+ur7erb7vyv66vv8= eci: type: string maxLength: 2 minLength: 1 pattern: ^0?\d$ title: Eci description: The ecommerce indicator for the 3DS transaction. examples: - '05' version: type: string pattern: ^[12](\.\d+){0,2}$ title: Version description: The version of 3-D Secure that was used. examples: - 2.1.0 directory_response: type: string maxLength: 1 title: Directory Response description: For 3-D Secure version 1, the enrolment response. For 3-D Secure version 2 and above, the transaction status from the `ARes`. examples: - C scheme: anyOf: - $ref: '#/components/schemas/CardScheme' - type: 'null' description: The scheme/brand of the card that is used for 3-D Secure. examples: - visa authentication_response: type: string maxLength: 1 title: Authentication Response description: ' The response for the 3DS authentication call.' examples: - Y cavv_algorithm: type: string maxLength: 1 title: Cavv Algorithm description: The CAVV algorithm used. examples: - A xid: type: string title: Xid description: The transaction identifier. examples: - '12345' additionalProperties: false type: object required: - cavv - eci - version - directory_response - authentication_response - cavv_algorithm - xid title: ThreeDSecureDataV1 AVSResponseCode: type: string enum: - match - no_match - partial_match_address - partial_match_postcode - partial_match_name - unavailable title: AVSResponseCode 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 TransactionSummaries: properties: items: items: $ref: '#/components/schemas/TransactionSummary_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: TransactionSummaries 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 CheckoutSessionWithUrlPaymentMethodCreate: properties: method: type: string const: checkout-session title: Method description: Always `checkout-session` default: checkout-session examples: - checkout-session id: type: string format: uuid title: Id description: The ID for the checkout session. examples: - 4137b1cf-39ac-42a8-bad6-1c680d5dab6b external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant reference that can be used to match the payment method against your own records. examples: - card-12345 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The `id` of a stored buyer to use Use this instead of the `buyer_external_identifier`. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The `external_identifier` of a stored buyer to use. Use this instead of the `buyer_id`. examples: - buyer-12345 redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com additionalProperties: false type: object required: - id title: CheckoutSessionWithUrlPaymentMethodCreate description: Create a payment with a checkout session ID (and an optional URL for 3DS). 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 ThreeDSecureDataV2_2: properties: cavv: type: string title: Cavv description: The cardholder authentication value or AAV. examples: - 3q2+78r+ur7erb7vyv66vv8= eci: type: string maxLength: 2 minLength: 1 pattern: ^0?\d$ title: Eci description: The ecommerce indicator for the 3DS transaction. examples: - '05' version: type: string pattern: ^[12](\.\d+){0,2}$ title: Version description: The version of 3-D Secure that was used. examples: - 2.1.0 directory_response: type: string maxLength: 1 title: Directory Response description: For 3-D Secure version 1, the enrolment response. For 3-D Secure version 2 and above, the transaction status from the `ARes`. examples: - C scheme: anyOf: - $ref: '#/components/schemas/CardScheme' - type: 'null' description: The scheme/brand of the card that is used for 3-D Secure. examples: - visa authentication_response: anyOf: - type: string maxLength: 1 - type: 'null' title: Authentication Response description: The transaction status after a the 3DS challenge. This will be null in case of a frictionless 3DS flow. examples: - Y directory_transaction_id: type: string title: Directory Transaction Id description: The transaction identifier. examples: - c4e59ceb-a382-4d6a-bc87-385d591fa09d additionalProperties: false type: object required: - cavv - eci - version - directory_response - directory_transaction_id title: ThreeDSecureDataV2 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 GooglePayAssuranceDetails: properties: account_verified: anyOf: - type: boolean - type: 'null' title: Account Verified description: Defines if an account was verified. examples: - true card_holder_authenticated: anyOf: - type: boolean - type: 'null' title: Card Holder Authenticated description: Defines if the card holder was authenticated. examples: - true additionalProperties: false type: object title: GooglePayAssuranceDetails description: The assurance details provided by Google Pay 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 ClickToPayPaymentMethodCreate: properties: method: type: string const: click-to-pay title: Method description: Aways `click-to-pay`. examples: - click-to-pay token: type: string title: Token description: The device token. examples: - '4111123456789012' cryptogram: type: string title: Cryptogram description: The payment cryptogram for the device token. examples: - A3F9C2D47E1B56A9 expiration_date: type: string maxLength: 5 minLength: 5 pattern: ^\d{2}/\d{2}$ title: Expiration Date description: The expiration date of the device token. examples: - 12/30 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: ' The ID of the buyer to associate this transaction to.' examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The external identifier of the buyer to create a transaction for. examples: - buyer-12345 external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The external identifier of the payment method to filter by. examples: - payment-method-12345 redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com additionalProperties: false type: object required: - method - token - cryptogram - expiration_date title: ClickToPayPaymentMethodCreate description: 'Create a Click to Pay payment with a decrypted token and cryptogram. This is mainly used internally but can be used by anyone with their own C2P integration.' 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 Mode: type: string enum: - card - redirect - applepay - googlepay - checkout-session - click-to-pay - gift-card - bank - paze title: Mode AirlinePassenger_2: properties: age_group: anyOf: - type: string enum: - adult - infant - type: 'null' title: Age Group description: The age group for the passenger. examples: - adult date_of_birth: anyOf: - type: string format: date - type: 'null' title: Date Of Birth description: The passenger's date of birth in YYYY-MM-YY format. examples: - '2013-07-16' email_address: anyOf: - type: string maxLength: 320 minLength: 1 - type: 'null' title: Email Address description: The email address of the passenger. examples: - john@example.com first_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: First Name description: The first name(s) or given name of the passenger. examples: - John frequent_flyer_number: anyOf: - type: string maxLength: 50 minLength: 5 - type: 'null' title: Frequent Flyer Number description: The passenger's frequent flyer number. examples: - '15885566' last_name: anyOf: - type: string maxLength: 255 minLength: 1 - type: 'null' title: Last Name description: The last name, or family name, of the passenger. examples: - Luhn passport_number: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Passport Number description: The passenger's unique passport number. examples: - '11117700225' phone_number: anyOf: - type: string pattern: ^\+[1-9]\d{1,14}$ examples: - '+14155552671' - '+442071838750' - type: 'null' title: Phone Number description: The phone number of the passenger. This number is formatted according to the E164 number standard. examples: - '+1234567890' ticket_number: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Ticket Number description: The ticket number for a flight. examples: - BA1236699999 title: anyOf: - type: string maxLength: 50 minLength: 1 - type: 'null' title: Title description: Title of the passenger. examples: - Mr. country_code: anyOf: - type: string pattern: ^[A-Z]{2}$ examples: - DE - GB - US - type: 'null' title: Country Code description: The country of residence of the passenger examples: - US additionalProperties: false type: object title: AirlinePassenger 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 TransactionGiftCard: properties: type: type: string const: gift-card title: Type description: Always `gift-card`. default: gift-card examples: - gift-card id: anyOf: - type: string format: uuid - type: 'null' title: Id description: The ID for the gift card. examples: - 356d56e5-fe16-42ae-97ee-8d55d846ae2e bin: type: string title: Bin description: The first 6 digits of the full gift card number. examples: - '412345' sub_bin: type: string title: Sub Bin description: The 3 digits after the `bin` of the full gift card number. examples: - '554' last4: type: string title: Last4 description: The last 4 digits for the gift card. examples: - '1234' additionalProperties: false type: object required: - bin - sub_bin - last4 title: TransactionGiftCard 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 BrowserInfo_2: properties: javascript_enabled: type: boolean title: Javascript Enabled java_enabled: type: boolean title: Java Enabled language: type: string title: Language color_depth: type: integer title: Color Depth screen_height: type: integer title: Screen Height screen_width: type: integer title: Screen Width time_zone_offset: type: integer title: Time Zone Offset user_agent: type: string title: User Agent description: Exact content of the HTTP user-agent header. examples: - Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 user_device: type: string enum: - desktop - mobile title: User Device description: The platform that is being used to access the website. examples: - desktop accept_header: anyOf: - type: string - type: 'null' title: Accept Header description: The Accept header of the request from the buyer's browser. examples: - '*/*' additionalProperties: false type: object required: - javascript_enabled - java_enabled - language - color_depth - screen_height - screen_width - time_zone_offset - user_agent - user_device title: BrowserInfo description: Merchant provided browser info TransactionIntent: type: string enum: - authorize - capture title: TransactionIntent TransactionThreeDSecureSummary: properties: version: anyOf: - type: string pattern: ^[12](\.\d+){0,2}$ - type: 'null' title: Version description: The version of 3DS used for this transaction. examples: - 2.2.0 status: anyOf: - $ref: '#/components/schemas/ThreeDSecureStatus' - type: 'null' description: The status of the 3DS challenge for this transaction. examples: - complete method: anyOf: - $ref: '#/components/schemas/ThreeDSecureMethod' - type: 'null' description: The method used for 3DS authentication for this transaction. examples: - challenge response_data: anyOf: - $ref: '#/components/schemas/ThreeDSecureDataV1_2' - $ref: '#/components/schemas/ThreeDSecureV2_2' - type: 'null' title: Response Data description: The 3DS data sent to the payment service for this transaction. This will only be populated if external 3DS data was passed in directly as part of the transaction API call, or if our 3DS server returned a status code of `Y` or `A`. In case of a failure to authenticate (status `N`, `R`, or `U`) this field will not be populated. To see full details about the 3DS calls please use our transaction events API. error_data: anyOf: - $ref: '#/components/schemas/ThreeDSecureError_2' - type: 'null' description: The error data received from our 3DS server. This will not be populated if the customer failed the authentication with a status code of `N`, `R`, or `U`. To see full details about the 3DS calls in those situations please use our transaction events API. amount: anyOf: - type: integer - type: 'null' title: Amount description: The amount used for 3DS authentication. additionalProperties: false type: object title: TransactionThreeDSecureSummary Tracking: properties: number: type: string maxLength: 255 minLength: 1 title: Number description: The tracking number for the shipment. examples: - 1Z999AA10123456784 carrier: $ref: '#/components/schemas/ShippingCarrier' description: The carrier handling the shipment. examples: - ups url: anyOf: - type: string - type: 'null' title: Url description: The URL to track the shipment. examples: - https://www.ups.com/track?tracknum=1Z999AA10123456784 additionalProperties: false type: object required: - number - carrier title: Tracking 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 ShippingCarrier: type: string enum: - amazon - bpost - brt - canada_post - ceska_posta - dhl - doordash - dpd - evri - fedex - gls - inpost - jt_express - landmark_global - lasership - packeta - ppl - purolator - rr_donnelley - sda - ups - usps - veho - other title: ShippingCarrier GiftCardTokenTransactionCreate: properties: id: type: string format: uuid title: Id description: The ID for the gift card to charge. examples: - 356d56e5-fe16-42ae-97ee-8d55d846ae2e amount: type: integer maximum: 99999999.0 minimum: 0.0 title: Amount description: The monetary amount for this transaction to charge against the gift card, in the smallest currency unit (for example, cents or pence). examples: - 1299 additionalProperties: false type: object required: - id - amount title: GiftCardTokenTransactionCreate 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 ThreeDSecureStatus: type: string enum: - setup_error - error - declined - cancelled - complete title: ThreeDSecureStatus InstrumentType: type: string enum: - pan - card_token - redirect - redirect_token - googlepay - applepay - network_token - plaid - bank title: InstrumentType 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 GooglePayPaymentMethodCreate: properties: buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The external identifier of the buyer to create a payment for. examples: - buyer-12345 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to retrieve billing details for. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 cardholder_name: anyOf: - type: string maxLength: 200 minLength: 0 - type: 'null' title: Cardholder Name description: The card holder name associated to the original card for the token. examples: - John Luhn redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com card_suffix: anyOf: - type: string maxLength: 4 minLength: 4 - type: 'null' title: Card Suffix description: The last 4 digits of the original card used to generate the token. examples: - '1234' card_scheme: anyOf: - type: string - type: 'null' title: Card Scheme description: The original card scheme for which the token was generated. examples: - visa card_type: anyOf: - type: string - type: 'null' title: Card Type description: The payment scheme of the card. examples: - credit method: type: string const: googlepay title: Method description: Always `googlepay` examples: - googlepay token: anyOf: - type: string - additionalProperties: true type: object title: Token description: The opaque token as received from the Google Pay JS library. This format may change between JS library versions. examples: - '{"signature":"MEUCIEg4a4A+pu+AUjgVjBpfz9msLqQOkT5kz7htz...' assurance_details: anyOf: - $ref: '#/components/schemas/GooglePayAssuranceDetails' - type: 'null' description: The assurance details provided by Google Pay additionalProperties: false type: object required: - method - token title: GooglePayPaymentMethodCreate description: Create a Google Pay transaction with a device token. ThreeDSecureV2_2: properties: version: type: string pattern: ^[12](\.\d+){0,2}$ title: Version authentication_response: anyOf: - type: string - type: 'null' title: Authentication Response directory_response: anyOf: - type: string - type: 'null' title: Directory Response directory_transaction_id: anyOf: - type: string - type: 'null' title: Directory Transaction Id transaction_reason: anyOf: - type: string - type: 'null' title: Transaction Reason cavv: anyOf: - type: string - type: 'null' title: Cavv eci: anyOf: - type: string maxLength: 2 minLength: 1 pattern: ^0?\d$ - type: 'null' title: Eci cardholder_info: anyOf: - type: string - type: 'null' title: Cardholder Info additionalProperties: false type: object required: - version title: ThreeDSecureV2 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 TransactionEvents: properties: items: items: $ref: '#/components/schemas/TransactionEvent' 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: TransactionEvents 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 IncrementalAuthorizationStatus: type: string enum: - succeeded - failed title: IncrementalAuthorizationStatus 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 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 CardType: type: string enum: - credit - debit - prepaid title: CardType 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 GiftCardRedemption_2: properties: type: type: string const: gift-card-redemption title: Type description: Always `gift-card-redemption`. default: gift-card-redemption examples: - gift-card-redemption id: type: string format: uuid title: Id description: The ID for the gift card redemption. examples: - 31e65fb1-9c67-432e-9c06-83300b9d4059 status: $ref: '#/components/schemas/GiftCardRedemptionStatus' description: The status of the gift card redemption for the `payment_method`. examples: - succeeded amount: type: integer title: Amount description: The amount redeemed for this gift card. examples: - 100 refunded_amount: type: integer title: Refunded Amount description: The amount refunded for this gift card. This can not be larger than `amount`. examples: - 50 gift_card_service_redemption_id: anyOf: - type: string - type: 'null' title: Gift Card Service Redemption Id description: The gift card service's unique ID for the redemption. examples: - xYqd43gySMtori error_code: anyOf: - $ref: '#/components/schemas/GiftCardErrorCode' - type: 'null' description: If this gift card redemption resulted in an error, this will contain the internal code for the error. examples: - expired_card raw_error_code: anyOf: - type: string - type: 'null' title: Raw Error Code description: If this gift card redemption resulted in an error, this will contain the raw error code received from the gift card provider. examples: - '10001' raw_error_message: anyOf: - type: string - type: 'null' title: Raw Error Message description: If this gift card redemption resulted in an error, this will contain the raw error message received from the gift card provider. examples: - Card expired gift_card: $ref: '#/components/schemas/TransactionGiftCard' description: The gift card used for this redemption additionalProperties: false type: object required: - id - status - amount - refunded_amount - gift_card title: GiftCardRedemption GooglePayFPANPaymentMethodCreate: properties: expiration_date: type: string maxLength: 5 minLength: 5 pattern: ^\d{2}/\d{2}$ title: Expiration Date description: The expiration date of the card, formatted `MM/YY`. examples: - 12/30 number: type: string maxLength: 19 minLength: 13 pattern: ^\d+$ title: Number description: The 13-19 digit number for this card. examples: - '4111111111111111' buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The external identifier of the buyer to attach the method to. examples: - buyer-12345 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to attach the method to. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant reference for this payment method. examples: - payment-method-12345 card_type: anyOf: - $ref: '#/components/schemas/CardType' - type: 'null' description: The type of the card used examples: - credit method: type: string const: googlepay_pan_only title: Method description: Aways `googlepay_pan_only`. examples: - googlepay_pan_only redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com security_code: type: 'null' title: Security Code description: The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD. examples: - '123' message_expiration: anyOf: - type: string - type: 'null' title: Message Expiration description: Expiry of the Google Pay token the PAN was decrypted from, as milliseconds since the epoch. examples: - '1759309000000' additionalProperties: false type: object required: - expiration_date - number - method title: GooglePayFPANPaymentMethodCreate description: Create a Google Pay payment with an FPAN. 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 TransactionEvent: properties: type: type: string const: transaction-event title: Type description: Always `transaction-event`. default: transaction-event examples: - transaction-event id: type: string format: uuid title: Id description: The ID for the event. examples: - f133a3b7-e67e-4d83-bcd3-3e438fedf348 name: type: string enum: - transaction-updated-status - transaction-sync-event - transaction-sync-failed-event - transaction-modified-event - transaction-api-request - transaction-api-response - bin-lookup-request - three-d-secure-success - three-d-secure-request-error - three-d-secure-preparation-request - three-d-secure-authentication-request - three-d-secure-result-request - anti-fraud-decision - anti-fraud-decision-error - anti-fraud-decision-skipped - anti-fraud-webhook - anti-fraud-transaction-status-update - anti-fraud-transaction-status-update-error - anti-fraud-decision-update - anti-fraud-decision-update-error - gift-card-redemption-succeeded - gift-card-redemption-failed - gift-card-refund-succeeded - gift-card-refund-failed - gift-card-reversal-succeeded - reauthorization-attempted - reauthorization-created - payment-connector-response-transaction-authorization-succeeded - payment-connector-response-transaction-capture-succeeded - payment-connector-response-transaction-authorization-failed - payment-connector-response-transaction-declined - payment-connector-response-transaction-capture-failed - payment-connector-response-transaction-capture-declined - payment-connector-response-transaction-cancel-succeeded - payment-connector-response-transaction-cancel-pending - payment-connector-response-transaction-cancel-failed - payment-connector-response-transaction-void-succeeded - payment-connector-response-transaction-authorization-increment-succeeded - payment-connector-response-transaction-authorization-increment-failed - payment-connector-response-transaction-void-declined - payment-connector-response-transaction-void-failed - payment-connector-external-transaction-request - payment-connector-report-transaction-settled - payment-connector-report-refund-settled - payment-connector-report-chargeback-posted - payment-connector-report-chargeback-reversal-posted - payment-connector-transaction-webhook-processed - digital-wallet-apple-pay-token-decrypted - digital-wallet-google-pay-token-decrypted - digital-wallet-click-to-pay-token-decrypted - digital-wallet-paze-token-decrypted - network-token-provision-succeeded - network-token-provision-failed - network-token-cryptogram-provision-succeeded - network-token-cryptogram-provision-failed - the-giving-block-transaction-conversion-succeeded - real-time-account-update - plaid-request-event title: Name description: The specific event name. examples: - transaction-api-request created_at: type: string format: date-time title: Created At description: The date this event was created at. examples: - '2013-07-16T19:23:00.000+00:00' context: $ref: '#/components/schemas/TransactionEventContext' description: An untyped dictionary with all the additional context for this event. additionalProperties: false type: object required: - id - name - created_at - context title: TransactionEvent 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 TransactionUpdate: properties: status: anyOf: - $ref: '#/components/schemas/TransactionStatus' - type: 'null' description: The status of the transaction for the `payment_method`. The status may change over time as asynchronous processing events occur. examples: - authorization_succeeded x-gr4vy-docs-ignore: true x-speakeasy-ignore: true amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Amount description: The total amount for this transaction across all funding sources including gift cards. examples: - 1299 x-gr4vy-docs-ignore: true x-speakeasy-ignore: true authorized_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Authorized Amount description: The amount for this transaction that has been authorized for the `payment_method`. This can be less than the `amount` if gift cards were used. examples: - 1299 x-gr4vy-docs-ignore: true x-speakeasy-ignore: true captured_amount: anyOf: - type: integer maximum: 99999999.0 minimum: 0.0 - type: 'null' title: Captured Amount description: The captured amount for this transaction. This can be the full value of the `authorized_amount` or less. examples: - 1299 x-gr4vy-docs-ignore: true x-speakeasy-ignore: true payment_service_transaction_id: anyOf: - type: string - type: 'null' title: Payment Service Transaction Id description: The payment service's unique ID for the transaction. examples: - tx-12345 x-gr4vy-docs-ignore: true x-speakeasy-ignore: true external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: An external identifier that can be used to match the transaction against your own records. examples: - transaction-12345 metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: Additional information about the transaction stored as key-value pairs. If provided, the whole value will be overridden. examples: - cohort: cohort-12345 order: order-12345 connection_options: anyOf: - $ref: '#/components/schemas/TransactionConnectionOptions' - type: 'null' title: Connection Options 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. If provided, the whole value will be overridden. additionalProperties: false type: object title: TransactionUpdate 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 ClickToPayFPANPaymentMethodCreate: properties: expiration_date: type: string maxLength: 5 minLength: 5 pattern: ^\d{2}/\d{2}$ title: Expiration Date description: The expiration date of the card, formatted `MM/YY`. examples: - 12/30 number: type: string maxLength: 19 minLength: 13 pattern: ^\d+$ title: Number description: The 13-19 digit number for this card. examples: - '4111111111111111' buyer_external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: Buyer External Identifier description: The external identifier of the buyer to attach the method to. examples: - buyer-12345 buyer_id: anyOf: - type: string format: uuid - type: 'null' title: Buyer Id description: The ID of the buyer to attach the method to. examples: - fe26475d-ec3e-4884-9553-f7356683f7f9 external_identifier: anyOf: - type: string maxLength: 200 minLength: 1 - type: 'null' title: External Identifier description: The merchant reference for this payment method. examples: - payment-method-12345 card_type: anyOf: - $ref: '#/components/schemas/CardType' - type: 'null' description: The type of the card used examples: - credit method: type: string const: click-to-pay title: Method description: Aways `click-to-pay`. examples: - click-to-pay redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com security_code: type: 'null' title: Security Code description: The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD. examples: - '123' additionalProperties: false type: object required: - expiration_date - number - method title: ClickToPayFPANPaymentMethodCreate description: Create a Click to Pay payment with an FPAN or virtual PAN 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 NetworkTokenPaymentMethodCreate: properties: method: type: string const: network-token title: Method description: Always `network-token`. examples: - network-token token: type: string title: Token description: The scheme token. examples: - '4111123456789012' expiration_date: type: string maxLength: 5 minLength: 5 pattern: ^\d{2}/\d{2}$ title: Expiration Date description: The expiration date of the token. examples: - 12/30 cryptogram: anyOf: - type: string - type: 'null' title: Cryptogram description: The payment cryptogram for the network token. examples: - A3F9C2D47E1B56A9 redirect_url: anyOf: - type: string - type: string pattern: ^data:application/json;base64,.*$ examples: - data:application/json;base64,eyJ0YXJnZXQiOiAib3BlbmVyIiwgImNoYW5uZWwiOiAiY2hhbm5lbCIsICJvcmlnaW5fdXJsIjogImh0dHBzOi8vZ3I0dnkuYXBwIn0= - type: 'null' title: Redirect Url description: The URL to redirect a user back to after the complete 3DS in browser. examples: - https://example.com card_source: anyOf: - type: string enum: - apple-pay - google-pay - type: 'null' title: Card Source description: The optional source of the decrypted device token. examples: - apple-pay card_scheme: anyOf: - $ref: '#/components/schemas/CardScheme' - type: 'null' description: The original card scheme for which the token was generated. examples: - visa card_suffix: anyOf: - type: string maxLength: 4 - type: 'null' title: Card Suffix description: The last 4 digits of the original card used to generate the token. examples: - '1234' cardholder_name: anyOf: - type: string - type: 'null' title: Cardholder Name description: The card holder name associated to the original card for the token. examples: - John Luhn eci: anyOf: - type: string maxLength: 2 minLength: 1 pattern: ^0?\d$ - type: 'null' title: Eci description: The ecommerce indicator for the token. examples: - '05' additionalProperties: false type: object required: - method - token - expiration_date title: NetworkTokenPaymentMethodCreate 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