Payment methods

PreviousPayments NextCustomers

Was this helpful?

Returns a paged list of all the customers

get

/v1/profiles/{profileId}/customers/{customerId}/payment-methods

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

customerIdstringrequired

The id of the customer

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers/{customerId}/payment-methods'

200

[
  {
    "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"
  }
]

Creates a customer

post

/v1/profiles/{profileId}/customers/{customerId}/payment-methods

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

customerIdstringrequired

The id of the customer

Body

referencestring

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 · enum

Payment method type ID

Example: openbanking

Options: openbanking, creditcard, terminal, internal, ideal

descriptionstring

Example: Description of the payment shown to the PSU

sepaobject

openbankingobject

userobject

metadataobject

Free form key/ value pair

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers/{customerId}/payment-methods' \
  --header 'Content-Type: application/json' \
  --data '{
    "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
    }
  }'

200

400

{
  "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"
}

Returns the data of the customer payment methods

get

/v1/profiles/{profileId}/customers/{customerId}/payment-methods/{customerPaymentMethodId}

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

customerIdstringrequired

The id of the customer

customerIdstringrequired

The id of the customer payment method

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers/{customerId}/payment-methods/{customerPaymentMethodId}'

200

404

{
  "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"
}

Deletes the customer payment method (if possible)

delete

/v1/profiles/{profileId}/customers/{customerId}/payment-methods/{customerPaymentMethodId}

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

customerIdstringrequired

The id of the customer

customerIdstringrequired

The id of the customer payment method

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers/{customerId}/payment-methods/{customerPaymentMethodId}'

200

400

{
  "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"
}

Show child attributes

Show child attributes

Show child attributes