Payments

List Payments for a Company

get

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

/v1/companies/{companyId}/payments

Retrieve a list of all payments for a specified company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

Responses

200

A list of payments for the specified company.

application/json

404

Company not found.

get

/v1/companies/{companyId}/payments

HTTPcURLJavaScriptPython

GET /v1/companies/{companyId}/payments HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

[
  {
    "id": "text",
    "source": "text",
    "amount": 1,
    "currency": "AED",
    "state": "created",
    "charges": 1,
    "description": "text",
    "identifier": "text",
    "fee": 1,
    "method": "openbanking",
    "customer": {
      "first_name": "text",
      "last_name": "text",
      "company": "text",
      "address": {
        "premise": "text",
        "building": "text",
        "sub_premise": "text",
        "address2": "text",
        "postal_code": "text",
        "thoroughfare": "text",
        "locality": "text",
        "state": "text",
        "country": "text"
      }
    },
    "next": {
      "url": "text"
    },
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "fee_bearer": "text"
  }
]

Create a Payment for a Company

post

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

/v1/companies/{companyId}/payments

Create a new payment associated with a specified company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

Body

application/json

sourcestringOptional

Source of the payment creation request.

linked_customerstringOptional

Identifier for a linked customer.

linked_customer_payment_methodstringOptional

Identifier for a linked customer's payment method.

profilestringOptional

Profile associated with the payment.

amountnumberOptional

Amount of the payment.

currencystring · enumOptionalPossible values:

descriptionstringOptional

Description of the payment.

methodstring · enumOptionalPossible values:

terminalstringOptional

Identifier for the payment terminal, if applicable.

Responses

201

Payment created successfully.

application/json

400

Invalid request data.

404

Company not found.

post

/v1/companies/{companyId}/payments

HTTPcURLJavaScriptPython

POST /v1/companies/{companyId}/payments HTTP/1.1
Host: api.brouwervos.nl
Content-Type: application/json
Accept: */*
Content-Length: 995

{
  "source": "text",
  "linked_customer": "text",
  "linked_customer_payment_method": "text",
  "profile": "text",
  "amount": 1,
  "currency": "AED",
  "description": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "user": {
    "ip_address": "text",
    "user_agent": "text",
    "language": "text",
    "country": "text"
  },
  "api": {
    "webhook_url": "https://example.com",
    "return_url": "https://example.com"
  },
  "customer": {
    "shipping": {
      "first_name": "text",
      "last_name": "text",
      "company": "text",
      "address": {
        "premise": "text",
        "building": "text",
        "sub_premise": "text",
        "address2": "text",
        "postal_code": "text",
        "thoroughfare": "text",
        "locality": "text",
        "state": "text",
        "country": "text"
      }
    },
    "billing": {
      "first_name": "text",
      "last_name": "text",
      "company": "text",
      "address": {
        "premise": "text",
        "building": "text",
        "sub_premise": "text",
        "address2": "text",
        "postal_code": "text",
        "thoroughfare": "text",
        "locality": "text",
        "state": "text",
        "country": "text"
      }
    }
  },
  "method": "openbanking",
  "terminal": "text",
  "sepa": {
    "iban": "text",
    "holder_name": "text",
    "bic": "text"
  },
  "openbanking": {
    "method": "sepa"
  }
}

{
  "id": "text",
  "source": "text",
  "amount": 1,
  "currency": "AED",
  "state": "created",
  "charges": 1,
  "description": "text",
  "identifier": "text",
  "fee": 1,
  "method": "openbanking",
  "customer": {
    "first_name": "text",
    "last_name": "text",
    "company": "text",
    "address": {
      "premise": "text",
      "building": "text",
      "sub_premise": "text",
      "address2": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "text",
      "state": "text",
      "country": "text"
    }
  },
  "next": {
    "url": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "fee_bearer": "text"
}

Retrieve Specific Payment

get

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

/v1/companies/{companyId}/payments/{paymentId}

Get details of a specific payment for a given company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

paymentIdstringRequired

Unique identifier of the payment.

Responses

200

Detailed information about the payment.

application/json

404

Payment or company not found.

get

/v1/companies/{companyId}/payments/{paymentId}

HTTPcURLJavaScriptPython

GET /v1/companies/{companyId}/payments/{paymentId} HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

{
  "id": "text",
  "source": "text",
  "amount": 1,
  "currency": "AED",
  "state": "created",
  "charges": 1,
  "description": "text",
  "identifier": "text",
  "fee": 1,
  "method": "openbanking",
  "customer": {
    "first_name": "text",
    "last_name": "text",
    "company": "text",
    "address": {
      "premise": "text",
      "building": "text",
      "sub_premise": "text",
      "address2": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "text",
      "state": "text",
      "country": "text"
    }
  },
  "next": {
    "url": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "fee_bearer": "text"
}