Payment methods

Obtain Access Token

post

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/oauth/token

Retrieve an access token using client credentials.

Authorizations

bearerAuth

Body

application/x-www-form-urlencoded

grant_typestringRequired

The type of grant request (e.g., 'client_credentials').

client_idstringRequired

The client identifier issued to the client.

Responses

200

Access token successfully obtained.

application/json

access_tokenstringOptional

The access token issued by the authorization server.

token_typestringOptional

The type of the token issued (typically 'Bearer').

expires_ininteger · int32Optional

The lifetime in seconds of the access token.

400

Invalid request parameters.

401

Unauthorized - Invalid client credentials.

post

/v1/oauth/token

HTTPcURLJavaScriptPython

POST /v1/oauth/token HTTP/1.1
Host: api.brouwervos.nl
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40

"grant_type='text'&client_id='text'"

{
  "access_token": "text",
  "token_type": "text",
  "expires_in": 1
}

List Payment Methods for a Customer

get

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers/{customerId}/payment-methods

Retrieve all payment methods associated with a specific customer of a company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

Responses

200

An array of payment methods.

application/json

idstringOptional

Unique identifier of the customer payment method.

enabledbooleanOptional

Indicates if the payment method is enabled.

methodstring · enumOptionalPossible values:

404

Customer or company not found.

get

/v1/companies/{companyId}/customers/{customerId}/payment-methods

HTTPcURLJavaScriptPython

GET /v1/companies/{companyId}/customers/{customerId}/payment-methods HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

[
  {
    "id": "text",
    "enabled": true,
    "method": "openbanking",
    "openbanking": {
      "alias": "text"
    },
    "sepa": {
      "last4": "text",
      "bic": "text",
      "country": "text"
    },
    "creditcard": {
      "last4": "text",
      "expiration": "2026-03-24"
    },
    "next": {
      "type": "text",
      "url": "https://example.com"
    }
  }
]

Add a Payment Method for a Customer

post

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers/{customerId}/payment-methods

Create a new payment method for a specific customer of a company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

Body

application/json

methodstring · enumOptionalPossible values:

Responses

201

Payment method added successfully.

application/json

400

Invalid request data.

404

Customer or company not found.

post

/v1/companies/{companyId}/customers/{customerId}/payment-methods

HTTPcURLJavaScriptPython

POST /v1/companies/{companyId}/customers/{customerId}/payment-methods HTTP/1.1
Host: api.brouwervos.nl
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "method": "openbanking",
  "user": {
    "language": "text"
  },
  "api": {
    "webhook_url": "https://example.com",
    "return_url": "https://example.com"
  }
}

{
  "id": "text",
  "enabled": true,
  "method": "openbanking",
  "openbanking": {
    "alias": "text"
  },
  "sepa": {
    "last4": "text",
    "bic": "text",
    "country": "text"
  },
  "creditcard": {
    "last4": "text",
    "expiration": "2026-03-24"
  },
  "next": {
    "type": "text",
    "url": "https://example.com"
  }
}

Retrieve Specific Payment Method

get

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

Get details of a specific payment method for a given customer of a company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

paymentMethodIdstringRequired

Unique identifier of the payment method.

Responses

200

Details of the payment method.

application/json

idstringOptional

Unique identifier of the customer payment method.

enabledbooleanOptional

Indicates if the payment method is enabled.

methodstring · enumOptionalPossible values:

404

Payment method, customer, or company not found.

get

/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

HTTPcURLJavaScriptPython

GET /v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId} HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

{
  "id": "text",
  "enabled": true,
  "method": "openbanking",
  "openbanking": {
    "alias": "text"
  },
  "sepa": {
    "last4": "text",
    "bic": "text",
    "country": "text"
  },
  "creditcard": {
    "last4": "text",
    "expiration": "2026-03-24"
  },
  "next": {
    "type": "text",
    "url": "https://example.com"
  }
}

Delete a Payment Method

delete

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

Delete a specific payment method from a customer's account.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

paymentMethodIdstringRequired

Unique identifier of the payment method.

Responses

204

Payment method deleted successfully.

404

Payment method, customer, or company not found.

delete

/v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId}

HTTPcURLJavaScriptPython

DELETE /v1/companies/{companyId}/customers/{customerId}/payment-methods/{paymentMethodId} HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

No content