--- title: "GET /v3/invoice/{handle}" method: GET path: "/v3/invoice/{handle}" tags: ["invoice"] --- # GET /v3/invoice/{handle} `GET /v3/invoice/{handle}` ## Request - Base URL: `https://customer-portal-api.frisbii.com` - URL: `https://customer-portal-api.frisbii.com/v3/invoice/{handle}` - Auth: none declared Get invoice details ## Path parameters - `handle` string, required ## Response `200` Successful operation - InvoiceDetailsV3 - `id` string: Autogenerated Id - `handle` string: Per account unique handle. Provided at on-demand invoice/charge creation or set to `inv-` for automatically created subscription invoices - `state` 'created' | 'pending' | 'dunning' | 'settled' | 'authorized' | 'cancelled' | 'failed': The invoice state one of the following: `created`, `pending`, `dunning`, `settled`, `cancelled`, `authorized`, `failed` - `amount` integer: The invoice amount including VAT - `currency` string: Currency for the account in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `created` string, date-time: When the invoice was created, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `customer` string, required: Customer handle - `subscription` string: Subscription handle, will be null for a one-time customer invoice - `plan` string: Subscription plan handle for the plan used to automatically create the invoice or the case that an on-demand subscription invoice has been created that should include a plan order line - `processing` boolean: For asynchronous payment methods, e.g. MobilePay subscriptions, this flag indicates that an invoice transaction is in state processing and is awaiting result. - `type` 's' | 'so' | 'soi' | 'co' | 'ch', required: The type of invoice: `s` - subscription recurring, `so` - subscription one-time, `soi` - subscription one-time instant, `co` - customer one-time, `ch` - charge - `number` integer: Sequential invoice number. Only present for subscription and customer invoices. - `due` string, date-time, required: When is the invoice due, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `failed` string, date-time: When the invoice failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `settled` string, date-time: When the invoice settled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `cancelled` string, date-time: When the invoice was cancelled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `authorized` string, date-time: When the invoice was authorized, if the invoice went through an authorize and settle flow, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `credits` CreditInvoice[], required: Credits applied to invoice - `credit` string, required: Credit handle - `amount` integer, required: The credit amount transferred to invoice - `created` string, date-time, required: Date when credit was transferred to invoice. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `text` string, required: Text describing the credit. - `uuids` string[], required: Invoice UUIDs - `plan_version` integer: Subscription plan version - `dunning_plan` string: Dunning plan handle - `discount_amount` integer, required: The potential discount amount deducted from the invoice amount including VAT - `org_amount` integer, required: The invoice original amount including VAT, may differ from amount if adjustments have been applied for the invoice - `amount_vat` integer, required: The invoice vat amount calculated as rounded summed fractional vats for each orderline - `amount_ex_vat` integer, required: The invoice amount without vat - `settled_amount` integer, required: Settled amount - `refunded_amount` integer, required: Refunded amount - `authorized_amount` integer: Authorized amount - `credited_amount` integer: Credited amount - `period_number` integer: The subscription period this invoice is for - `recurring_payment_method` string: Optional reference to recurring payment method created in conjunction with charging - `order_lines` OrderLine[], required: Order lines for invoice sorted by descending timestamp - `id` string, required: Per account unique order line id - `ordertext` string, required: Order line text - `amount` integer, required: Order line total amount including vat - `vat` number, float, required: Order line vat percent - `quantity` integer, required: Order line quantity - `origin` 'plan' | 'add_on' | 'ondemand' | 'additional_cost' | 'credit' | 'discount' | 'setup_fee' | 'surcharge_fee' | 'metered_billing_product', required: Order line origin, one of the following: `plan`, `add_on`, `ondemand`, `additional_cost`, `credit`, `discount`, `setup_fee`, `surcharge_fee`, `metered_billing_product` - `timestamp` string, date-time, required: Timestamp from order line origin, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `amount_vat` integer, required: Order line total vat amount - `amount_ex_vat` integer, required: Order line total amount without vat - `discounted_amount` integer: Order line amount after potential discount has been deducted, including vat - `discounted_amount_ex_vat` integer: Order line amount after potential discount has been deducted, excluding vat - `unit_amount` integer, required: Order line unit amount including vat - `unit_amount_vat` integer, required: Order line unit vat amount - `unit_amount_ex_vat` integer, required: Order line unit amount without vat - `amount_defined_incl_vat` boolean, required: Whether the amount was defined including VAT. E.g. plan amount defined including VAT. - `applied_tax_rule` 'reverse_charge' | 'intra_community_digital_service' | 'third_country' | 'fiscal_unity': Tax rule applied for order line indicates who is liable to account for the VAT. - `origin_handle` string: Handle for additional cost, credit, plan or subscription discount in the case one of those are the origin - `period_from` string, date-time: The start of billing period if the order line is a plan order line for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_to` string, date-time: The end of billing period if the order line is a plan order line for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `discount_percentage` integer: The discount percentage for discount order lines that has a percentage discount - `discounted_order_line` string: For discount order lines a reference to the order line for which the order line is a discount - `cost_object` string: Cost object number (Kostenträger-Nr.) this line is booked to - `additional_costs` string[], required: Additional cost handles for any additional costs added to this invoice - `transactions` InvoiceTransactionDetails[], required: Invoice transactions - `id` string: Autogenerated Transaction Id - `state` 'pending' | 'processing' | 'authorized' | 'settled' | 'refunded' | 'failed' | 'cancelled', required: State of the transaction, one of the following: `pending`, `processing`, `authorized`, `settled`, `refunded`, `failed`, `cancelled` - `invoice` string, required: Invoice handle - `type` 'settle' | 'refund' | 'authorization', required: Transaction type, one of the following: `settle`, `refund`, `authorization` - `amount` integer, required: The transaction amount - `currency` string: Currency in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `settled` string, date-time: When the transaction was settled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `authorized` string, date-time: When the transaction was authorized, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `failed` string, date-time: When the transaction failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `refunded` string, date-time: When the transaction was refunded, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `created` string, date-time, required: Date when the transaction was created. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `payment_type` 'card' | 'mpo' | 'mobilepay' | 'vipps' | 'vipps_recurring' | 'swish' | 'viabill' | 'anyday' | 'manual' | 'applepay' | 'googlepay' | 'paypal' | 'klarna_pay_now' | 'klarna_pay_later' | 'klarna_slice_it' | 'klarna_direct_bank_transfer' | 'klarna_direct_debit' | 'resurs' | 'santander' | 'mobilepay_subscriptions' | 'emv_token' | 'bcmc' | 'blik' | 'pp_blik_oc' | 'giropay' | 'ideal' | 'p24' | 'sepa' | 'trustly' | 'verkkopankki': Payment type for transaction, either: `card`, `mpo`, `mobilepay`, `vipps`, `vipps_recurring`, `swish`, `viabill`, `anyday`, `manual`, `applepay`, `googlepay`, `paypal`, `klarna_pay_now`, `klarna_pay_later`, `klarna_slice_it`, `klarna_direct_bank_transfer`, `klarna_direct_debit`, `resurs`, `santander`, `mobilepay_subscriptions`, `emv_token`, `bcmc`, `blik`, `pp_blik_oc`, `giropay`, `ideal`, `p24`, `sepa`, `trustly`, or `verkkopankki` - `payment_method` string: Reference to payment method in case of a MIT transaction - `card_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: 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. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': 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` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: 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` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `mpo_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: 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. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': 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` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: 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` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `vipps_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: 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. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': 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` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: 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` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `applepay_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: 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. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': 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` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: 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` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `googlepay_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: 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. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': 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` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: 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` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': 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 - `three_d_secure_status` string: 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. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `manual_transaction` ManualTransaction: Specifics in case of manual transaction - `method` 'cash' | 'bank_transfer' | 'check' | 'chargeback' | 'other', required: The method used for the offline manual transaction, allowable values: `cash`, `bank_transfer`, `check`, `chargeback`, `other` - `comment` string: Optional comment for manual transaction - `reference` string: Optional reference for the manual transaction - `payment_date` string, date-time, required: When the manual transaction was performed on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm` and `yyyy-MM-ddTHH:mm:ss` - `viabill_transaction` ViabillTransaction: Specifics in case of ViaBill transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `viabill_id` string: ViaBill id - `anyday_transaction` AnydayTransaction: Specifics in case of Anyday transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `anyday_id` string: Anyday id - `santander_transaction` SantanderTransaction: Specifics in case of Santander transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `santander_id` string: Santander id - `resurs_transaction` ResursTransaction: Specifics in case of Resurs Bank transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `resurs_id` string: Resurs id - `klarna_transaction` KlarnaTransaction: Specifics in case of Klarna transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `type` 'klarna' | 'klarna_pay_now' | 'klarna_pay_later' | 'klarna_slice_it' | 'klarna_direct_bank_transfer' | 'klarna_direct_debit', required: Transaction type: `klarna` - recurring Klarna mandate payment, `klarna_pay_now`, `klarna_pay_later`, `klarna_slice_it`, `klarna_direct_bank_transfer`, `klarna_direct_debit` - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `klarna_id` string: Klarna id - `klarna_mandate` KlarnaMandate: Klarna mandate used to initiate transaction when transaction is recurring - `swish_transaction` SwishTransaction: Specifics in case of Swish transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `swish_id` string: Swish id - `paypal_transaction` PaypalTransaction: Specifics in case of PayPal transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `email` string: Payer email - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `paypal_id` string: PayPal id - `paypal_mandate` PaypalMandate: PayPal mandate used to initiate transaction when transaction is recurring - `email` string: Payer email - `first_name` string: Payer first name - `last_name` string: Payer last name - `payer_id` string: PayPal payer id - `phone_number` string: Payer phone number - `first_name` string: Payer first name - `last_name` string: Payer last name - `payer_id` string: PayPal payer id - `phone_number` string: Payer phone number - `bancontact_transaction` BancontactTransaction: Specifics in case of Bancontact transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `bancontact_id` string: Bancontact id - `blik_transaction` BlikTransaction: Specifics in case of BLIK transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `blik_id` string: Blik id - `giropay_transaction` GiropayTransaction: Specifics in case of Giropay transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `giropay_id` string: Giropay id - `ideal_transaction` IdealTransaction: Specifics in case of IDEAL transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `ideal_id` string: Ideal id - `p24_transaction` P24Transaction: Specifics in case of P24 transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `p24_id` string: P24 id - `sepa_transaction` SepaTransaction: Specifics in case of SEPA transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `sepa_id` string: SEPA id - `sepa_mandate` SepaMandate: SEPA Mandate - `iban` string: Mandate IBAN - `sepa_mandate_bank_reference` string, required: Bank reference - `trustly_transaction` TrustlyTransaction: Specifics in case of Trustly transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `trustly_id` string: Trustly id - `verkkopankki_transaction` VerkkopankkiTransaction: Specifics in case of Verkkopankki transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `verkkopankki_id` string: VerkkopankkiTransaction id - `eps_transaction` EpsTransaction: Specifics in case of Eps transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `eps_id` string: Eps id - `estonia_banks_transaction` EstoniaBanksTransaction: Specifics in case of Estonia Banks transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `estonia_banks_id` string: Estonia Banks id - `latvia_banks_transaction` LatviaBanksTransaction: Specifics in case of Latvia Banks transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `latvia_banks_id` string: Latvia Banks id - `lithuania_banks_transaction` LithuaniaBanksTransaction: Specifics in case of Lithuania Banks transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `lithuania_banks_id` string: Lithuania Banks id - `mbway_transaction` MbwayTransaction: Specifics in case of MB Way transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `mb_way_id` string: MB Way id - `multibanco_transaction` MultibancoTransaction: Specifics in case of Multibanco transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `multibanco_id` string: Multibanco id - `mybank_transaction` MybankTransaction: Specifics in case of MyBank transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `mybank_id` string: MyBank id - `payconiq_transaction` PayconiqTransaction: Specifics in case of Payconiq transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `payconiq_id` string: Payconiq id - `paysafecard_transaction` PaysafecardTransaction: Specifics in case of Paysafecard transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `paysafecard_id` string: Paysafecard id - `paysera_transaction` PayseraTransaction: Specifics in case of Paysera transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `paysera_id` string: Paysera id - `postfinance_transaction` PostfinanceTransaction: Specifics in case of PostFinance transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `postfinance_id` string: PostFinance id - `satispay_transaction` SatispayTransaction: Specifics in case of Satispay transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `satispay_id` string: Satispay id - `wechatpay_transaction` WeChatPayTransaction: Specifics in case of WeChat Pay transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `wechatpay_id` string: WeChat Pay id - `mps_transaction` MpsTransaction: Specifics in case of MobilePay Subscriptions transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `mps_id` string, required: MobilePay Subscriptions id - `mps_subscription` MpsSubscription, required: MobilePay Subscriptions agreement - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: 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. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `external_id` string: Optional external id at MobilePay defined when creating the subscription - `mps_payment_type` 'regular' | 'one_off_cit' | 'one_off_mit', required: MobilePay Subscriptions payment type: `regular`, `one_off_cit` (customer initiated), `one_off_mit` (merchant initiated auto reserve) - `vipps_recurring_transaction` VippsRecurringTransaction: Specifics in case of Vipps Recurring transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `vipps_recurring_id` string, required: Vipps Recurring id - `vipps_recurring_mandate` VippsRecurringMandate, required: Vipps Recurring mandate - `payment_context` string: Payment context describing if the transaction is customer or merchant initiated, one of the following values: `cit`, `mit`, `cit_cof` - `credit_notes` InvoiceCreditNoteV2[]: Invoice credit notes - `id` string, required: Credit note id - `invoice` string, required: Invoice credited by this note - `transaction` string: Refund transaction id if credit note has an associated refund - `credit` string: Credit reference if the credit note relates to a subscription credit - `amount` integer, required: Credit note amount - `created` string, date-time, required: Creation date for note, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `currency` string, required: Credit note currency in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `customer` string, required: Customer handle - `subscription` string: Subscription handle, will be null for a one-time customer invoice - `credits` CreditInvoice[], required: Credits applied to credit note - `credit` string, required: Credit handle - `amount` integer, required: The credit amount transferred to invoice - `created` string, date-time, required: Date when credit was transferred to invoice. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `text` string, required: Text describing the credit. - `amount_vat` integer, required: Credit note vat amount calculated as rounded summed fractional vats for each credit note lines - `amount_ex_vat` integer: Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines - `credit_note_lines` CreditNoteLine[], required: Credit note lines - `amount` integer, required: Credit note line total amount - `text` string, required: Credit note line text - `description` string: Order line description - `quantity` integer, required: Credit note line quantity - `vat` number, float: Vat for this credit note line - `created` string, date-time: Creation date for this credit note line, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `origin` 'plan' | 'add_on' | 'ondemand' | 'additional_cost' | 'credit' | 'discount' | 'setup_fee' | 'surcharge_fee' | 'metered_billing_product': Order line origin, one of the following: `plan`, `add_on`, `ondemand`, `additional_cost`, `credit`, `discount`, `setup_fee`, `surcharge_fee`, `metered_billing_product` - `order_line_id` string: Reference to invoice orderline this credit note line relates to - `amount_incl_vat` integer: Credit note line total amount including VAT - `amount_ex_vat` integer: Credit note line total amount excluding VAT - `unit_amount` integer: Credit note line unit amount - `unit_amount_vat` integer: Credit note line vat amount - `unit_amount_ex_vat` integer: Credit note line unit amount excluding VAT - `amount_incl_vat_defined` boolean: Whether the total and units are including VAT. - `period_from` string, date-time: The start of billing period in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_to` string, date-time: The end of billing period in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `cost_object` string: Cost object number (Kostenträger-Nr.) this line is booked to - `accounting_number` string: Credit note accounting number - `debtor_id` integer: Customer debtor id - `download_url` string: Link to the credit note PDF, available if PDF generation and accounting features are enabled (only for subscription invoices, not charges). Access requires authentication. See https://docs.frisbii.com/reference/authentication. The response is a binary PDF file. - `accounting_created_date` string, date-time: When the credit note was created. A credit note is created when a non-charging invoice is cancelled or refunded. Timestamp in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `cost_center` string: Cost center for accounting purposes - `po_number` string: Purchase order number for accounting purposes - `sales_rep_id` string: Sales representative identifier - `order_id` string: Order identifier - `invoice_file_type` 'pdf' | 'pdf_xml': The type of invoice file, e.g. `pdf` - `payable_amount` integer: The credit note amount to be payed including VAT - `amount_vat_lines` AmountVatLine[]: The list of VAT amounts grouped by VAT percentage - `vat` number, float, required: Vat percent - `amount_vat` integer, required: Total vat amount - `dunning_start` string, date-time: When dunning for the invoice was started, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `dunning_count` integer: Number of dunning events for invoice (number of reminders sent) - `dunning_expired` string, date-time: When dunning for the invoice expired, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_from` string, date-time: The start of billing period if the invoice is for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_to` string, date-time: The end of billing period if the invoice is for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `settle_later` boolean: Whether this is a customer one-time invoice that will be settled later - `settle_later_payment_method` string: The payment method to use for a later settle of a one-time customer invoice - `billing_address` InvoiceBillingAddress: Optional billing address - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `shipping_address` InvoiceShippingAddress: Optional shipping address - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `accounting_number` string: Accounting number - `payable_amount` integer: The invoice amount to be paid including VAT - `download_url` string: Url to invoice pdf - `amount_vat_lines` AmountVatLine[]: Invoice tax amounts - `vat` number, float, required: Vat percent - `amount_vat` integer, required: Total vat amount - `has_sepa_chargeback` boolean: Whether the invoice has a SEPA chargeback ## Other responses - `400`: Invalid request, see error codes at https://api.frisbii.com/v1/error_codes - `401`: None or invalid credentials provided in access to secured resource - `403`: Not authorized to perform resource operation - `404`: Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes - `429`: Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123 - `500`: Internal service error, error is reported automatically to Frisbii --- [API](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api.md) - [All operations](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api/revisions/f0261fb63b1b?raw)