Payment methods

get

https://api.bankingservice.aihttps://sandbox.api.bankingservice.aihttps://staging.api.bankingservice.aihttps://acceptance.api.bankingservice.aihttps://experimental.api.bankingservice.aihttps://internal.api.bankingservice.ai

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

Returns a paged list of all the customers

Authorizations

oAuth2

OAuth2clientCredentialsRequired

This API uses OAuth 2 with the credentials grant flow.

Token URL: Refresh URL:

Path parameters

profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses

200

OK

application/json

PSU customer type

idstringRead-onlyRequired

statestring · enumOptionalPossible values:

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

createdstringRead-onlyRequiredExample: 2024-09-25T12:01:00.103Z

get

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

HTTPcURLJavaScriptPython

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

https://api.bankingservice.aihttps://sandbox.api.bankingservice.aihttps://staging.api.bankingservice.aihttps://acceptance.api.bankingservice.aihttps://experimental.api.bankingservice.aihttps://internal.api.bankingservice.ai

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

Creates a customer

Authorizations

oAuth2

OAuth2clientCredentialsRequired

This API uses OAuth 2 with the credentials grant flow.

Token URL: Refresh URL:

Path parameters

profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Body

application/json

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

PSU customer type

idstringRead-onlyRequired

statestring · enumOptionalPossible values:

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

createdstringRead-onlyRequiredExample: 2024-09-25T12:01:00.103Z

400

Invalid request

application/json

post

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

HTTPcURLJavaScriptPython

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

https://api.bankingservice.aihttps://sandbox.api.bankingservice.aihttps://staging.api.bankingservice.aihttps://acceptance.api.bankingservice.aihttps://experimental.api.bankingservice.aihttps://internal.api.bankingservice.ai

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

Returns the data of the customer payment methods

Authorizations

oAuth2

OAuth2clientCredentialsRequired

This API uses OAuth 2 with the credentials grant flow.

Token URL: Refresh URL:

Path parameters

profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses

200

OK

application/json

PSU customer type

idstringRead-onlyRequired

statestring · enumOptionalPossible values:

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

createdstringRead-onlyRequiredExample: 2024-09-25T12:01:00.103Z

404

Resource not found

application/json

get

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

HTTPcURLJavaScriptPython

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

https://api.bankingservice.aihttps://sandbox.api.bankingservice.aihttps://staging.api.bankingservice.aihttps://acceptance.api.bankingservice.aihttps://experimental.api.bankingservice.aihttps://internal.api.bankingservice.ai

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

Deletes the customer payment method (if possible)

Authorizations

oAuth2

OAuth2clientCredentialsRequired

This API uses OAuth 2 with the credentials grant flow.

Token URL: Refresh URL:

Path parameters

profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses

200

OK

application/json

PSU customer type

idstringRead-onlyRequired

statestring · enumOptionalPossible values:

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

createdstringRead-onlyRequiredExample: 2024-09-25T12:01:00.103Z

400

Invalid request

application/json

delete

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

HTTPcURLJavaScriptPython

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