Payment Methods

Endpointhttps://api.kontorion.eu/v1

A payment method is a stored instrument (credit card, bank account, direct debit mandate) that a customer uses to pay invoices. Payment methods are tokenized through the configured payment gateway - Kontorion never stores raw card numbers or bank details.

Each customer can have multiple payment methods. One is marked as is_default and is used automatically when invoices are finalized.

List payment methods

GET

https://api.kontorion.eu/v1

/payment-methods

Returns payment methods for the org. Pass ?customer_id= to scope to one customer; omit to see every payment method across the org.

List payment methods › query Parameters

customer_id

string

Filter by customer UUID

include_removed

boolean

Include soft-deleted methods (default false)

List payment methods › Responses

List in data envelope

object[]

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

Display fields populated by the provider sync (card brand / last4 / expiry for card methods, bank name / account_last4 for DD methods). All optional - cards leave bank_* nil and vice versa. Carried as pointers so the JSON omits the key entirely when the column is NULL.

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

Create a payment method

POST

https://api.kontorion.eu/v1

/payment-methods

Creates a new payment method. customer_id is supplied in the request body.

Create a payment method › Request Body

customer_id

string

is_default

boolean

object

provider

string

provider_id

string

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

Create a payment method › Responses

Wrapped in data envelope

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

POST/payment-methods

curl --request POST \
  --url https://api.kontorion.eu/v1/payment-methods \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "customer_id",
  "is_default": true,
  "metadata": {
    "key": {}
  },
  "provider": "provider",
  "provider_id": "provider_id",
  "type": "CREDIT_CARD"
}
'

shell

Example Request Body

{
  "customer_id": "customer_id",
  "is_default": true,
  "metadata": {
    "key": {}
  },
  "provider": "provider",
  "provider_id": "provider_id",
  "type": "CREDIT_CARD"
}

json

Example Responses

{
  "key": {
    "account_last4": "account_last4",
    "bank_name": "bank_name",
    "created_at": "created_at",
    "customer_id": "customer_id",
    "display_brand": "display_brand",
    "exp_month": 0,
    "exp_year": 0,
    "id": "id",
    "is_default": true,
    "last4": "last4",
    "metadata": {
      "key": {}
    },
    "organization_id": "organization_id",
    "provider": "provider",
    "provider_id": "provider_id",
    "status": "active",
    "type": "CREDIT_CARD",
    "updated_at": "updated_at"
  }
}

json

application/json

Get a payment method

GET

https://api.kontorion.eu/v1

/payment-methods/{id}

Returns a single payment method by ID

Get a payment method › path Parameters

id

string · required

Payment method UUID

Get a payment method › Responses

Wrapped in data envelope

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

Update a payment method

PUT

https://api.kontorion.eu/v1

/payment-methods/{id}

Updates an existing payment method by ID

Update a payment method › path Parameters

id

string · required

Payment method UUID

Update a payment method › Request Body

is_default

boolean

object

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

Update a payment method › Responses

Wrapped in data envelope

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

PUT/payment-methods/{id}

curl --request PUT \
  --url https://api.kontorion.eu/v1/payment-methods/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_default": true,
  "metadata": {
    "key": {}
  },
  "provider": "provider",
  "provider_id": "provider_id",
  "status": "active"
}
'

shell

Example Request Body

{
  "is_default": true,
  "metadata": {
    "key": {}
  },
  "provider": "provider",
  "provider_id": "provider_id",
  "status": "active"
}

json

Example Responses

{
  "key": {
    "account_last4": "account_last4",
    "bank_name": "bank_name",
    "created_at": "created_at",
    "customer_id": "customer_id",
    "display_brand": "display_brand",
    "exp_month": 0,
    "exp_year": 0,
    "id": "id",
    "is_default": true,
    "last4": "last4",
    "metadata": {
      "key": {}
    },
    "organization_id": "organization_id",
    "provider": "provider",
    "provider_id": "provider_id",
    "status": "active",
    "type": "CREDIT_CARD",
    "updated_at": "updated_at"
  }
}

json

application/json

Delete a payment method

DELETE

https://api.kontorion.eu/v1

/payment-methods/{id}

Soft-deletes a payment method by ID

Delete a payment method › path Parameters

id

string · required

Payment method UUID

Delete a payment method › Responses

No content

No data returned

Payment Gateways Tax Rules

List payment methods

GET

https://api.kontorion.eu/v1

/payment-methods

Returns payment methods for the org. Pass ?customer_id= to scope to one customer; omit to see every payment method across the org.

List payment methods › query Parameters

customer_id

string

Filter by customer UUID

include_removed

boolean

Include soft-deleted methods (default false)

List payment methods › Responses

List in data envelope

object[]

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

Create a payment method

POST

https://api.kontorion.eu/v1

/payment-methods

Creates a new payment method. customer_id is supplied in the request body.

Create a payment method › Request Body

customer_id

string

is_default

boolean

object

provider

string

provider_id

string

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

Create a payment method › Responses

Wrapped in data envelope

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

Get a payment method

GET

https://api.kontorion.eu/v1

/payment-methods/{id}

Returns a single payment method by ID

Get a payment method › path Parameters

id

string · required

Payment method UUID

Get a payment method › Responses

Wrapped in data envelope

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string

Update a payment method

PUT

https://api.kontorion.eu/v1

/payment-methods/{id}

Updates an existing payment method by ID

Update a payment method › path Parameters

id

string · required

Payment method UUID

Update a payment method › Request Body

is_default

boolean

object

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

Update a payment method › Responses

Wrapped in data envelope

account_last4

string

bank_name

string

created_at

string

customer_id

string

display_brand

string

exp_month

integer

exp_year

integer

id

string

is_default

boolean

last4

string

object

organization_id

string

provider

string

provider_id

string

status

string · enum

Enum values:

active

expired

removed

type

string · enum

Enum values:

CREDIT_CARD

BANK_ACCOUNT

SEPA_DIRECT_DEBIT

SEPA_DIRECT_DEBIT_B2B

ACH_BUSINESS

PAYPAL

EXTERNAL

updated_at

string