--- updatedAt: 2026-08-15T02:25:41.000Z agentTools: projectIndex: https://docs.frisbii.com/llms.txt --- # Import Stripe SEPA payment method from an existing mandate in the merchant's Stripe account # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "API", "description": "REST API to manage Frisbii resources", "contact": { "email": "support@frisbii.com" }, "version": "1" }, "servers": [ { "url": "https://api.frisbii.com" } ], "paths": { "/v1/payment_method/import_stripe_sepa": { "post": { "tags": [ "payment_method" ], "summary": "Import Stripe SEPA payment method from an existing mandate in the merchant's Stripe account", "operationId": "importStripeSepaPaymentMethod", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStripeSepaPaymentMethodRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodV2" } } } }, "400": { "description": "Invalid request, see error codes at https://api.frisbii.com/v1/error_codes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "None or invalid credentials provided in access to secured resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Not authorized to perform resource operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal service error, error is reported automatically to Frisbii", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "basicAuth": [] } ] } } }, "components": { "schemas": { "ErrorResponse": { "required": [ "code", "error", "http_reason", "http_status", "path", "request_id", "timestamp" ], "type": "object", "properties": { "code": { "type": "integer", "description": "Frisbii API [error codes](https://api.frisbii.com/v1/error_codes)", "format": "int32", "example": 12 }, "error": { "type": "string", "description": "Short error message", "example": "Subscription not found" }, "message": { "type": "string", "description": "Optional clarifying error message" }, "path": { "type": "string", "description": "The path generating the error response", "example": "/v1/subscription/sub0019" }, "timestamp": { "type": "string", "description": "Timestamp for the error response in ISO-8601 extended offset date-time format", "format": "date-time" }, "http_status": { "type": "integer", "description": "HTTP status code of the error", "format": "int32", "example": 404 }, "http_reason": { "type": "string", "description": "HTTP reason of the error", "example": "Not Found" }, "request_id": { "type": "string", "description": "Request-Id for the failed request", "example": "f1988fc2374b4a26a51ebd876b478428" }, "transaction_error": { "type": "string", "description": "Optional transaction error in the case the request involved a transaction processing. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors).", "example": "credit_card_expired" } }, "description": "Generic error response" }, "CreateCustomer": { "type": "object", "properties": { "email": { "type": "string", "description": "Customer email. Validated against RFC 822.", "example": "carl@leone.com" }, "title": { "type": "string", "description": "Customer title", "example": "Mr" }, "address": { "type": "string", "description": "Customer address", "example": "Grove Street 12" }, "address2": { "type": "string", "description": "Customer address2", "example": "Ganton" }, "city": { "type": "string", "description": "Customer city", "example": "Los Santos" }, "country": { "type": "string", "description": "Customer country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). E.g. US.", "example": "US" }, "phone": { "type": "string", "description": "Customer phone number", "example": "555-gotcars" }, "company": { "type": "string", "description": "Customer company", "example": "Leones Cars" }, "vat": { "type": "string", "description": "Customer vat number", "example": "US123456789" }, "language": { "type": "string", "description": "Customer language", "example": "en" }, "handle": { "pattern": "^[a-zA-Z0-9_\\.\\-@]*$", "type": "string", "description": "Per account unique handle for the customer. Max length 255 with allowable characters [a-zA-Z0-9_.-@]. Must be provided if generate_handle is not defined.", "example": "customer006" }, "test": { "type": "boolean", "description": "Test flag. If given it will be verified that the account state matches the intended create state.", "example": true }, "metadata": { "type": "object", "additionalProperties": { "type": "object", "description": "Custom metadata.", "example": { "key": "value" } }, "description": "Custom metadata.", "example": { "key": "value" } }, "invoice_email": { "type": "string", "description": "Optional email address where invoices will be sent to in addition to the primary email address. Validated against RFC 822.", "example": "carl@leone.com" }, "dunning_email": { "type": "string", "description": "Optional email address where dunning notices will be sent to in addition to the primary email address. Validated against RFC 822.", "example": "carl@leone.com" }, "first_name": { "type": "string", "description": "Customer first name", "example": "Carl" }, "last_name": { "type": "string", "description": "Customer last name", "example": "Johnson" }, "date_of_birth": { "type": "string", "description": "Customer date of birth", "example": "1990-05-15" }, "postal_code": { "type": "string", "description": "Customer postal code", "example": "4531" }, "debtor_id": { "type": "integer", "description": "Debtor identifier for this customer. If set this is unique and cannot be changed anymore.", "format": "int64", "example": 10001 }, "sales_rep_id": { "type": "string", "description": "Sales representative identifier", "example": "sales-rep-001" }, "order_id": { "type": "string", "description": "Order identifier", "example": "order-12345" }, "shipping_first_name": { "type": "string", "description": "Shipping address first name", "example": "Carl" }, "shipping_last_name": { "type": "string", "description": "Shipping address last name", "example": "Johnson" }, "shipping_company": { "type": "string", "description": "Shipping address company", "example": "Leones Cars" }, "shipping_vat": { "type": "string", "description": "Shipping address vat number", "example": "US123456789" }, "shipping_attention": { "type": "string", "description": "Shipping address attention line", "example": "Receiving dept." }, "shipping_address": { "type": "string", "description": "Shipping address", "example": "Grove Street 12" }, "shipping_address2": { "type": "string", "description": "Shipping address2", "example": "Ganton" }, "shipping_city": { "type": "string", "description": "Shipping city", "example": "Los Santos" }, "shipping_state_or_province": { "type": "string", "description": "Shipping state or province", "example": "SA" }, "shipping_postal_code": { "type": "string", "description": "Shipping postal code", "example": "4531" }, "shipping_country": { "type": "string", "description": "Shipping country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). E.g. US.", "example": "US" }, "shipping_email": { "type": "string", "description": "Shipping address email. Validated against RFC 822.", "example": "receiving@leone.com" }, "shipping_phone": { "type": "string", "description": "Shipping phone number", "example": "555-gotcars" }, "fiscal_unity": { "type": "boolean", "description": "Whether this customer is domestically related to the merchant (Organschaft / VAT group)" }, "generate_handle": { "type": "boolean", "description": "Auto generate handle on the form cust-[sequence_number]", "example": true } }, "description": "Create customer object" }, "CardV2": { "required": [ "card_agreement", "card_type", "gateway", "gw_ref" ], "type": "object", "properties": { "gateway": { "minLength": 1, "type": "string", "description": "Card gateway tied to card", "example": "nets" }, "fingerprint": { "type": "string", "description": "Uniquely identifies this particular card number", "example": "cst_64e8a26cc0e85bc3f5ce7c5b366b4096" }, "reactivated": { "type": "string", "description": "Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format.", "format": "date-time", "example": "2015-05-14T00:00:00Z" }, "gw_ref": { "minLength": 1, "type": "string", "description": "Card gateway reference id", "example": "657e86162633415a9e6b715248c84da4" }, "card_type": { "minLength": 1, "type": "string", "description": "Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay`", "example": "visa_dk", "enum": [ "unknown", "visa", "mc", "dankort", "visa_dk", "ffk", "visa_elec", "maestro", "laser", "amex", "diners", "discover", "jcb", "china_union_pay" ] }, "transaction_card_type": { "type": "string", "description": "Card type used in authentication and the card type used for subsequent MIT transactions. Will differ from `card_type` if co-branded card. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay`", "example": "visa", "enum": [ "unknown", "visa", "mc", "dankort", "visa_dk", "ffk", "visa_elec", "maestro", "laser", "amex", "diners", "discover", "jcb", "china_union_pay" ] }, "card_agreement": { "minLength": 1, "type": "string", "description": "Card agreement id", "example": "2b18c5d1f4dc640d9ff91bfbb2cbcce0" }, "exp_date": { "type": "string", "description": "Card expire date on form MM-YY ", "example": "09-18" }, "masked_card": { "type": "string", "description": "Masked card number", "example": "457111XXXXXX3777" }, "last_success": { "type": "string", "description": "Date and time of last successful use of the card. In ISO-8601 extended offset date-time format.", "format": "date-time", "example": "2015-05-14T00:00:00Z" }, "last_failed": { "type": "string", "description": "Date and time of last failed use of the card. In ISO-8601 extended offset date-time format.", "format": "date-time", "example": "2015-05-14T00:00:00Z" }, "first_fail": { "type": "string", "description": "Date and time of first successful use of the card. In ISO-8601 extended offset date-time format.", "format": "date-time", "example": "2015-05-14T00:00:00Z" }, "error_code": { "type": "string", "description": "An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors).", "example": "credit_card_expired" }, "error_state": { "type": "string", "description": "Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error`", "example": "hard_declined", "enum": [ "pending", "soft_declined", "hard_declined", "processing_error" ] }, "declined_count": { "type": "integer", "description": "Number of soft and hard declined attempts for the card since created or since last successful transaction", "format": "int32", "example": 2 }, "strong_authentication_status": { "type": "string", "description": "Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated", "example": "secured_by_nets", "enum": [ "threed_secure", "threed_secure_not_enrolled", "secured_by_nets" ] }, "three_d_secure_status": { "type": "string", "description": "If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers.", "example": "Y" }, "risk_rule": { "type": "string", "description": "If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up." }, "card_country": { "type": "string", "description": "Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)", "example": "US" }, "token_state": { "type": "string", "description": "State of tokenization for card `active`, `suspended` or `deleted`", "example": "active", "enum": [ "active", "suspended", "deleted" ] }, "cardholder_name": { "type": "string", "description": "Cardholder name if provided when entering credit card details", "example": "Jane Doe" }, "ani_result": { "type": "string", "description": "The result of the Account Name Inquiry (cardholder name verification) performed when the card was added. Only relevant if cardholder name was provided at card creation.", "enum": [ "match", "partial_match", "no_match", "unverified", "not_supported" ] }, "googlepay_pan_type": { "type": "string", "description": "Google Pay PAN type: `pan`, `token` or `emv_token`. Only present for Google Pay payment methods.", "enum": [ "pan", "token", "emv_token" ] } }, "description": "Card object in case of Google Pay payment method" }, "KlarnaMandate": { "type": "object", "description": "Klarna mandate object in case of Klarna payment method" }, "MpsSubscriptionV2": { "type": "object", "properties": { "external_id": { "type": "string", "description": "Optional external id at MobilePay defined when creating the subscription", "example": "mps_sub_001" } }, "description": "MPS subscription object in case of MPS payment method" }, "OfflineMandate": { "required": [ "offline_agreement_handle" ], "type": "object", "properties": { "offline_agreement_handle": { "type": "string", "description": "Offline agreement handle" }, "offline_agreement_name": { "type": "string", "description": "Optional offline agreement name" } }, "description": "Offline mandate object in case of Offline payment method" }, "PaymentMethodV2": { "required": [ "created", "customer", "id", "payment_type", "state" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Unique id for payment method", "example": "ca_fcfac2016614418f969fa5697383e47c" }, "state": { "minLength": 1, "type": "string", "description": "State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted`", "example": "active", "enum": [ "active", "inactivated", "failed", "pending", "deleted" ] }, "customer": { "minLength": 1, "type": "string", "description": "Customer by handle", "example": "customer00069" }, "reference": { "type": "string", "description": "Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method.", "example": "cs_6be90a4babc3c57ef7e6e477ac97ed3b" }, "failed": { "type": "string", "description": "Date when the payment method failed. In ISO-8601 extended offset date-time format.", "format": "date-time", "example": "2015-06-04T12:40:56.656Z" }, "created": { "type": "string", "description": "Date when the payment method was created. In ISO-8601 extended offset date-time format.", "format": "date-time", "example": "2015-04-04T12:40:56.656Z" }, "card": { "$ref": "#/components/schemas/CardV2" }, "applepay": { "$ref": "#/components/schemas/CardV2" }, "googlepay": { "$ref": "#/components/schemas/CardV2" }, "payment_type": { "type": "string", "description": "Payment type for saved payment method, either: `card`, `emv_token`, `vipps_recurring`, `applepay`, `googlepay`, `mobilepay_subscriptions`, `sepa`, `sepa_ebics`, `stripe_sepa`, `offline_cash`, `offline_bank_transfer` or `offline_other`", "example": "card", "enum": [ "card", "emv_token", "vipps_recurring", "applepay", "googlepay", "mobilepay_subscriptions", "sepa", "sepa_ebics", "stripe_sepa", "offline_cash", "offline_bank_transfer", "offline_other" ] }, "mps_subscription": { "$ref": "#/components/schemas/MpsSubscriptionV2" }, "vipps_recurring_mandate": { "$ref": "#/components/schemas/VippsRecurringMandate" }, "sepa_mandate": { "$ref": "#/components/schemas/SepaMandate" }, "twint_mandate": { "$ref": "#/components/schemas/TwintMandate" }, "offline_mandate": { "$ref": "#/components/schemas/OfflineMandate" }, "paypal_mandate": { "$ref": "#/components/schemas/PaypalMandate" }, "sepa_ebics_mandate": { "$ref": "#/components/schemas/SepaEbicsMandate" }, "stripe_mandate": { "$ref": "#/components/schemas/StripeMandate" }, "klarna_mandate": { "$ref": "#/components/schemas/KlarnaMandate" } } }, "PaypalMandate": { "type": "object", "properties": { "email": { "type": "string", "description": "Payer email" }, "first_name": { "type": "string", "description": "Payer first name" }, "last_name": { "type": "string", "description": "Payer last name" }, "payer_id": { "type": "string", "description": "PayPal payer id" }, "phone_number": { "type": "string", "description": "Payer phone number" } }, "description": "PayPal mandate object in case of PayPal payment method" }, "SepaEbicsMandate": { "required": [ "iban", "sepa_mandate_bank_reference" ], "type": "object", "properties": { "iban": { "type": "string", "description": "Mandate IBAN", "example": "DE89370400440532013000" }, "sepa_mandate_bank_reference": { "type": "string", "description": "Bank reference", "example": "se-39ef3e95179640db01aa382e0b117e8a" } }, "description": "SEPA EBICS mandate object in case of SEPA EBICS payment method" }, "SepaMandate": { "required": [ "sepa_mandate_bank_reference" ], "type": "object", "properties": { "iban": { "type": "string", "description": "Mandate IBAN", "example": "DE89370400440532013000" }, "sepa_mandate_bank_reference": { "type": "string", "description": "Bank reference", "example": "sr-39ef3e95179640db01aa382e0b117e8a" } }, "description": "SEPA mandate object in case of SEPA payment method" }, "StripeMandate": { "type": "object", "properties": { "bic": { "type": "string", "description": "Bank BIC/SWIFT code", "example": "DEUTDEDB" }, "sepa_last4": { "type": "string", "description": "Last 4 digits of SEPA IBAN", "example": "3000" } }, "description": "Stripe mandate object in case of Stripe payment method" }, "TwintMandate": { "type": "object", "description": "Twint mandate object in case of Twint payment method" }, "VippsRecurringMandate": { "type": "object", "description": "Vipps Recurring mandate object in case of Vipps Recurring payment method" }, "ImportStripeSepaPaymentMethodRequest": { "required": [ "stripe_customer_id", "stripe_mandate_id", "stripe_payment_method_id" ], "type": "object", "properties": { "reference": { "pattern": "^[a-zA-Z0-9_\\.\\-@]*$", "type": "string", "description": "Optional reference given to the created payment method. Max length 64 with allowable characters [a-zA-Z0-9_.-@].", "example": "cs_6be90a4babc3c57ef7e6e477ac97ed3b" }, "customer": { "$ref": "#/components/schemas/CreateCustomer" }, "bic": { "pattern": "^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$", "type": "string", "description": "Debtor BIC. Optional, and only obtainable from the merchant as Stripe does not expose it", "example": "BANKDEBLXXX" }, "customer_handle": { "pattern": "^[a-zA-Z0-9_\\.\\-@]*$", "type": "string", "description": "Customer reference to an existing customer. Either this argument or `customer` must be provided.", "example": "cust-0022" }, "stripe_customer_id": { "minLength": 1, "type": "string", "description": "Stripe customer id holding the payment method", "example": "cus_NffrFeUfNV2Hib" }, "stripe_payment_method_id": { "minLength": 1, "type": "string", "description": "Stripe payment method id for the SEPA account, must be attached to the customer", "example": "pm_1MqLiJLkdIwHu7ixUEgbFdYF" }, "stripe_mandate_id": { "minLength": 1, "type": "string", "description": "Stripe mandate id, must be active and reusable for future payments", "example": "mandate_1MqLiJLkdIwHu7ixUEgbFdYF" } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } } } ```