HomeLogin

Payment methods

get

Returns a paged list of all the customers

Authorizations
Path parameters
profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses
200

OK

application/json
get
GET /v1/profiles/{profileId}/customers/{customerId}/payment-methods HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

OK

[
  {
    "id": "text",
    "state": null,
    "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
    "method": "openbanking",
    "description": "Description of the payment shown to the PSU",
    "sepa": {
      "holder_name": "text",
      "last4": 394,
      "bic": "ABNANL2AXXX",
      "country": "NL"
    },
    "openbanking": {
      "bic": "INGBNL2AXXX",
      "country": "text",
      "recurring": {
        "amount": 8230,
        "currency": "EUR",
        "frequency": "daily",
        "day_of_execution": 1,
        "month_of_execution": 12,
        "start_date": "2024-09-25T12:01:00.103Z",
        "end_date": "2024-09-25T12:01:00.103Z"
      }
    },
    "user": {
      "user_agent": "text",
      "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
      "accept_encoding": "gzip, deflate, br, zstd",
      "accept_language": "en-GB,en-US;q=0.9,en;q=0.8",
      "accept_charset": "UTF-8",
      "ip_address": "217.138.20.120",
      "language": "en-EN"
    },
    "created": "2024-09-25T12:01:00.103Z"
  }
]
post

Creates a customer

Authorizations
Path parameters
profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Body

PSU creation customer payment method type

referencestringOptional

Your internal reference, we index this reference for you to search later, not required to use. We also use this for idempotency

Example: b5c9d214-f408-4215-990e-f892c24a6080
methodstring · enumOptional

Payment method type ID

Example: openbankingPossible values:
descriptionstringOptionalExample: Description of the payment shown to the PSU
metadataobjectOptional

Free form key/ value pair

Example: {"key1":123,"customer_id":"123object","internal_reference":"X938378B01","debited":true}
Responses
200

OK

application/json
post
POST /v1/profiles/{profileId}/customers/{customerId}/payment-methods HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 894

{
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "description": "Description of the payment shown to the PSU",
  "sepa": {
    "holder_name": "text",
    "iban": "NL27ABNA7020127142",
    "bic": "ABNANL2AXXX"
  },
  "openbanking": {
    "bic": "INGBNL2AXXX",
    "country": "text",
    "recurring": {
      "amount": 8230,
      "currency": "EUR",
      "frequency": "daily",
      "day_of_execution": 1,
      "month_of_execution": 12,
      "start_date": "2024-09-25T12:01:00.103Z",
      "end_date": "2024-09-25T12:01:00.103Z"
    }
  },
  "user": {
    "user_agent": "text",
    "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
    "accept_encoding": "gzip, deflate, br, zstd",
    "accept_language": "en-GB,en-US;q=0.9,en;q=0.8",
    "accept_charset": "UTF-8",
    "ip_address": "217.138.20.120",
    "language": "en-EN"
  },
  "metadata": {
    "key1": 123,
    "customer_id": "123object",
    "internal_reference": "X938378B01",
    "debited": true
  }
}
{
  "id": "text",
  "state": null,
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "description": "Description of the payment shown to the PSU",
  "sepa": {
    "holder_name": "text",
    "last4": 394,
    "bic": "ABNANL2AXXX",
    "country": "NL"
  },
  "openbanking": {
    "bic": "INGBNL2AXXX",
    "country": "text",
    "recurring": {
      "amount": 8230,
      "currency": "EUR",
      "frequency": "daily",
      "day_of_execution": 1,
      "month_of_execution": 12,
      "start_date": "2024-09-25T12:01:00.103Z",
      "end_date": "2024-09-25T12:01:00.103Z"
    }
  },
  "user": {
    "user_agent": "text",
    "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
    "accept_encoding": "gzip, deflate, br, zstd",
    "accept_language": "en-GB,en-US;q=0.9,en;q=0.8",
    "accept_charset": "UTF-8",
    "ip_address": "217.138.20.120",
    "language": "en-EN"
  },
  "created": "2024-09-25T12:01:00.103Z"
}
get

Returns the data of the customer payment methods

Authorizations
Path parameters
profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses
200

OK

application/json
get
GET /v1/profiles/{profileId}/customers/{customerId}/payment-methods/{customerPaymentMethodId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "state": null,
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "description": "Description of the payment shown to the PSU",
  "sepa": {
    "holder_name": "text",
    "last4": 394,
    "bic": "ABNANL2AXXX",
    "country": "NL"
  },
  "openbanking": {
    "bic": "INGBNL2AXXX",
    "country": "text",
    "recurring": {
      "amount": 8230,
      "currency": "EUR",
      "frequency": "daily",
      "day_of_execution": 1,
      "month_of_execution": 12,
      "start_date": "2024-09-25T12:01:00.103Z",
      "end_date": "2024-09-25T12:01:00.103Z"
    }
  },
  "user": {
    "user_agent": "text",
    "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
    "accept_encoding": "gzip, deflate, br, zstd",
    "accept_language": "en-GB,en-US;q=0.9,en;q=0.8",
    "accept_charset": "UTF-8",
    "ip_address": "217.138.20.120",
    "language": "en-EN"
  },
  "created": "2024-09-25T12:01:00.103Z"
}
delete

Deletes the customer payment method (if possible)

Authorizations
Path parameters
profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses
200

OK

application/json
delete
DELETE /v1/profiles/{profileId}/customers/{customerId}/payment-methods/{customerPaymentMethodId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "state": null,
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "description": "Description of the payment shown to the PSU",
  "sepa": {
    "holder_name": "text",
    "last4": 394,
    "bic": "ABNANL2AXXX",
    "country": "NL"
  },
  "openbanking": {
    "bic": "INGBNL2AXXX",
    "country": "text",
    "recurring": {
      "amount": 8230,
      "currency": "EUR",
      "frequency": "daily",
      "day_of_execution": 1,
      "month_of_execution": 12,
      "start_date": "2024-09-25T12:01:00.103Z",
      "end_date": "2024-09-25T12:01:00.103Z"
    }
  },
  "user": {
    "user_agent": "text",
    "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7",
    "accept_encoding": "gzip, deflate, br, zstd",
    "accept_language": "en-GB,en-US;q=0.9,en;q=0.8",
    "accept_charset": "UTF-8",
    "ip_address": "217.138.20.120",
    "language": "en-EN"
  },
  "created": "2024-09-25T12:01:00.103Z"
}
PreviousPaymentsNextCustomers

Was this helpful?