Payments

get

Returns a paged list of all the payments

Authorizations

Path parameters

profileIdstringRequired

The id of the profile

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/profiles/{profileId}/payments HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "page": 0,
  "pages": 620,
  "size": 20,
  "count": 12383,
  "data": [
    {
      "id": "payment_282d732kd8ggjdj392jdhfi289",
      "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
      "method": "openbanking",
      "shipping": {
        "company": "text",
        "first_name": "text",
        "last_name": "text",
        "phone": "text",
        "address": {
          "premise": 58,
          "sub_premise": "A",
          "building": "text",
          "postal_code": "text",
          "thoroughfare": "text",
          "locality": "Hoofddorp",
          "state": "Noord-Holland",
          "country": "NL"
        }
      },
      "billing": {
        "company": "text",
        "first_name": "text",
        "last_name": "text",
        "phone": "text",
        "address": {
          "premise": 58,
          "sub_premise": "A",
          "building": "text",
          "postal_code": "text",
          "thoroughfare": "text",
          "locality": "Hoofddorp",
          "state": "Noord-Holland",
          "country": "NL"
        }
      },
      "openbanking": {
        "type": "sepa",
        "execution": "2024-09-25T12:01:00.103Z",
        "bic": "INGBNL2AXXX",
        "country": "NL"
      },
      "terminal": {
        "method": "point_of_sale",
        "emv": {
          "read_method": "emv",
          "aid": "A0000000043060",
          "tsi": "text",
          "tvr": "text",
          "cryptogram": "text",
          "cryptogram_type": "ARQC"
        }
      },
      "ideal": {
        "bic": "ABNANL2AXXX"
      },
      "creditcard": {
        "rrn": "text",
        "fees": {
          "interchange": 1,
          "assesment": 1
        },
        "card": {
          "scheme": "visa",
          "type": "debit",
          "region": "domestic",
          "last4": "text",
          "bin": "text",
          "expiration": "text",
          "holder_name": "text",
          "issuing_country": "NL"
        }
      },
      "sepa_direct_debit": {
        "sequence_type": "final",
        "mandate": {
          "id": "7f159668-b7ef-464e-84c4-089e35de4066",
          "date": "2024-09-25T12:01:00.103Z"
        }
      },
      "sepa": {
        "holder_name": "text",
        "last4": 394,
        "bic": "ABNANL2AXXX",
        "country": "NL"
      },
      "description": "Description of the payment shown to the PSU",
      "currency": "EUR",
      "amount": 8230,
      "state": null,
      "metadata": {
        "key1": 123,
        "customer_id": "123object",
        "internal_reference": "X938378B01",
        "debited": true
      },
      "next": {
        "redirect": "https://dashboard.bankingservice.ai/payments/payment_b6412838e2594e7eaffa28d48cfd02ee?reference=9869d4567b6d4fc49f3030c8ea4477da"
      },
      "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"
      },
      "session": {
        "redirect_url": "https://www.bankingservice.ai/result",
        "webhook_url": "https://www.bankingservice.ai/result"
      },
      "created": "2024-09-25T12:01:00.103Z"
    }
  ]
}

post

Creates a payment flow.

Authorizations

Path parameters

profileIdstringRequired

The id of the profile

Body

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

Payment method type ID

Example: openbankingPossible values:

descriptionstringRequiredExample: Description of the payment shown to the PSU

currencystring · enumRequired

ISO 3166-1 alpha-2 currency code

Example: EURPossible values:

customerstringOptional

ID of the customer that is paying

creditcardone ofOptional

payment_methodstringOptional

Payment method to be used for execution of this payment, this payment method must be one of the payment methods of the customer, required when customer is set.

amountnumberRequired

Amount of the payment in cents of the currency

Example: 8230

metadataobjectOptional

Free form key/ value pair

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

Responses

200

OK

application/json

400

Invalid request

application/json

post

HTTPcURLJavaScriptPython

POST /v1/profiles/{profileId}/payments HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1884

{
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "description": "Description of the payment shown to the PSU",
  "shipping": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "billing": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "currency": "EUR",
  "customer": "text",
  "creditcard": {
    "card": {
      "number": 5571050319405406,
      "cvc": "text",
      "holder_name": "FRANCES KUHIC",
      "expiration": "2024-09-25T00:00:00.000Z"
    }
  },
  "payment_method": "text",
  "ideal": {
    "bic": "ABNANL2AXXX"
  },
  "sepa_direct_debit": {
    "sequence_type": "final",
    "mandate": {
      "id": "7f159668-b7ef-464e-84c4-089e35de4066",
      "date": "2024-09-25T12:01:00.103Z"
    }
  },
  "sepa": {
    "holder_name": "text",
    "iban": "NL27ABNA7020127142",
    "bic": "ABNANL2AXXX"
  },
  "amount": 8230,
  "metadata": {
    "key1": 123,
    "customer_id": "123object",
    "internal_reference": "X938378B01",
    "debited": true
  },
  "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",
    "screen_width": 1,
    "screen_height": 1,
    "color_depth": 1,
    "java_enabled": true,
    "javascript_enabled": true,
    "ip_address": "217.138.20.120",
    "language": "en-EN"
  },
  "terminal": {
    "id": "terminal_h82kd823"
  },
  "openbanking": {
    "type": "sepa",
    "execution": "2024-09-25T12:01:00.103Z",
    "bic": "INGBNL2AXXX",
    "country": "text"
  },
  "session": {
    "redirect_url": "https://www.bankingservice.ai/result",
    "webhook_url": "https://www.bankingservice.ai/result"
  }
}

{
  "id": "payment_282d732kd8ggjdj392jdhfi289",
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "shipping": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "billing": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "openbanking": {
    "type": "sepa",
    "execution": "2024-09-25T12:01:00.103Z",
    "bic": "INGBNL2AXXX",
    "country": "NL"
  },
  "terminal": {
    "method": "point_of_sale",
    "emv": {
      "read_method": "emv",
      "aid": "A0000000043060",
      "tsi": "text",
      "tvr": "text",
      "cryptogram": "text",
      "cryptogram_type": "ARQC"
    }
  },
  "ideal": {
    "bic": "ABNANL2AXXX"
  },
  "creditcard": {
    "rrn": "text",
    "fees": {
      "interchange": 1,
      "assesment": 1
    },
    "card": {
      "scheme": "visa",
      "type": "debit",
      "region": "domestic",
      "last4": "text",
      "bin": "text",
      "expiration": "text",
      "holder_name": "text",
      "issuing_country": "NL"
    }
  },
  "sepa_direct_debit": {
    "sequence_type": "final",
    "mandate": {
      "id": "7f159668-b7ef-464e-84c4-089e35de4066",
      "date": "2024-09-25T12:01:00.103Z"
    }
  },
  "sepa": {
    "holder_name": "text",
    "last4": 394,
    "bic": "ABNANL2AXXX",
    "country": "NL"
  },
  "description": "Description of the payment shown to the PSU",
  "currency": "EUR",
  "amount": 8230,
  "state": null,
  "metadata": {
    "key1": 123,
    "customer_id": "123object",
    "internal_reference": "X938378B01",
    "debited": true
  },
  "next": {
    "redirect": "https://dashboard.bankingservice.ai/payments/payment_b6412838e2594e7eaffa28d48cfd02ee?reference=9869d4567b6d4fc49f3030c8ea4477da"
  },
  "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"
  },
  "session": {
    "redirect_url": "https://www.bankingservice.ai/result",
    "webhook_url": "https://www.bankingservice.ai/result"
  },
  "created": "2024-09-25T12:01:00.103Z"
}

get

Returns the status of the payment, and payment data

Authorizations

Path parameters

profileIdstringRequired

The id of the profile

paymentIdstringRequired

The id of the payment

Responses

200

OK

application/json

404

Resource not found

application/json

get

HTTPcURLJavaScriptPython

GET /v1/profiles/{profileId}/payments/{paymentId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "payment_282d732kd8ggjdj392jdhfi289",
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "shipping": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "billing": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "openbanking": {
    "type": "sepa",
    "execution": "2024-09-25T12:01:00.103Z",
    "bic": "INGBNL2AXXX",
    "country": "NL"
  },
  "terminal": {
    "method": "point_of_sale",
    "emv": {
      "read_method": "emv",
      "aid": "A0000000043060",
      "tsi": "text",
      "tvr": "text",
      "cryptogram": "text",
      "cryptogram_type": "ARQC"
    }
  },
  "ideal": {
    "bic": "ABNANL2AXXX"
  },
  "creditcard": {
    "rrn": "text",
    "fees": {
      "interchange": 1,
      "assesment": 1
    },
    "card": {
      "scheme": "visa",
      "type": "debit",
      "region": "domestic",
      "last4": "text",
      "bin": "text",
      "expiration": "text",
      "holder_name": "text",
      "issuing_country": "NL"
    }
  },
  "sepa_direct_debit": {
    "sequence_type": "final",
    "mandate": {
      "id": "7f159668-b7ef-464e-84c4-089e35de4066",
      "date": "2024-09-25T12:01:00.103Z"
    }
  },
  "sepa": {
    "holder_name": "text",
    "last4": 394,
    "bic": "ABNANL2AXXX",
    "country": "NL"
  },
  "description": "Description of the payment shown to the PSU",
  "currency": "EUR",
  "amount": 8230,
  "state": null,
  "metadata": {
    "key1": 123,
    "customer_id": "123object",
    "internal_reference": "X938378B01",
    "debited": true
  },
  "next": {
    "redirect": "https://dashboard.bankingservice.ai/payments/payment_b6412838e2594e7eaffa28d48cfd02ee?reference=9869d4567b6d4fc49f3030c8ea4477da"
  },
  "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"
  },
  "session": {
    "redirect_url": "https://www.bankingservice.ai/result",
    "webhook_url": "https://www.bankingservice.ai/result"
  },
  "created": "2024-09-25T12:01:00.103Z"
}

delete

Cancels a payment flow, or initaited payment, whenever possible.

Authorizations

Path parameters

profileIdstringRequired

The id of the profile

paymentIdstringRequired

The id of the payment

Responses

200

OK

application/json

400

Invalid request

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/profiles/{profileId}/payments/{paymentId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "payment_282d732kd8ggjdj392jdhfi289",
  "reference": "b5c9d214-f408-4215-990e-f892c24a6080",
  "method": "openbanking",
  "shipping": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "billing": {
    "company": "text",
    "first_name": "text",
    "last_name": "text",
    "phone": "text",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  },
  "openbanking": {
    "type": "sepa",
    "execution": "2024-09-25T12:01:00.103Z",
    "bic": "INGBNL2AXXX",
    "country": "NL"
  },
  "terminal": {
    "method": "point_of_sale",
    "emv": {
      "read_method": "emv",
      "aid": "A0000000043060",
      "tsi": "text",
      "tvr": "text",
      "cryptogram": "text",
      "cryptogram_type": "ARQC"
    }
  },
  "ideal": {
    "bic": "ABNANL2AXXX"
  },
  "creditcard": {
    "rrn": "text",
    "fees": {
      "interchange": 1,
      "assesment": 1
    },
    "card": {
      "scheme": "visa",
      "type": "debit",
      "region": "domestic",
      "last4": "text",
      "bin": "text",
      "expiration": "text",
      "holder_name": "text",
      "issuing_country": "NL"
    }
  },
  "sepa_direct_debit": {
    "sequence_type": "final",
    "mandate": {
      "id": "7f159668-b7ef-464e-84c4-089e35de4066",
      "date": "2024-09-25T12:01:00.103Z"
    }
  },
  "sepa": {
    "holder_name": "text",
    "last4": 394,
    "bic": "ABNANL2AXXX",
    "country": "NL"
  },
  "description": "Description of the payment shown to the PSU",
  "currency": "EUR",
  "amount": 8230,
  "state": null,
  "metadata": {
    "key1": 123,
    "customer_id": "123object",
    "internal_reference": "X938378B01",
    "debited": true
  },
  "next": {
    "redirect": "https://dashboard.bankingservice.ai/payments/payment_b6412838e2594e7eaffa28d48cfd02ee?reference=9869d4567b6d4fc49f3030c8ea4477da"
  },
  "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"
  },
  "session": {
    "redirect_url": "https://www.bankingservice.ai/result",
    "webhook_url": "https://www.bankingservice.ai/result"
  },
  "created": "2024-09-25T12:01:00.103Z"
}