v2

latestSwagger 2.02026-08-0610101.9 MB

Payments

Create payment

Registers a new payment request for the bank account

post/v0/bank/accounts/{bank-account-id}/payments

Path parameters

bank-account-idstring required

Request body

payment-referencestring

Free-text field to help identify and categorise payments.

X is the legal person who owns the account. This will be the entity-name or business-name for companies, or the given-name and surname for individuals. This is also subject to a 35 character limit, so longer names may be cut off. When making a payment to a payee with an associated Confirmation of Payee request containing secondary reference data (SRD), the SRD will take precedence over any payment-reference set in the payment creation request.

Example request

{
  "creditor": {
    "account-number": "12345678",
    "bank-id": "123456"
  },
  "payment-amount": {
    "currency": "GBP",
    "value": "1000.00"
  },
  "payment-reference": "test reference"
}

Response

Created

rejected-atstring date-time

ISO 8601 formatted date-time.

latest-submission-urlstring

Most recent submission (if any made)

rejected-by-urlstring

Link to the user.

payment-direction'inbound-payment' | 'outbound-payment' required

Whether the payment is moving money into or out of the account.

created-by-urlstring

Link to the user.

created-via'api' | 'ui'

created-atstring date-time required

ISO 8601 formatted date-time.

payment-urlstring required

Link to the payment resource.

payment-referencestring

Free-text field to help identify and categorise payments.

payment-type'credit-transfer' | 'direct-debit' required

Whether the payment is a credit transfer or direct debit.

payment-admissions-urlstring

Link to the endpoint for listing payment admissions.

payment-submissions-urlstring

Link to the endpoint for creating and listing payment submissions.

rejection-reasonstring nullable

Example response

{
  "created-by-user": {
    "user-email": "user@example.com",
    "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
    "user-username": "user@example.com"
  },
  "creditor": {
    "iban": "GB42GFNB12345612345678",
    "uk-domestic-sort-code": "123456",
    "bic": "GFNBGB22",
    "account-number": "12345678",
    "bank-id": "123456",
    "bban": "GFNB12345612345678",
    "uk-domestic-account-number": "12345678",
    "other-account-identification": "ABC123",
    "other-institution-identification": "ABC123"
  },
  "latest-submission-url": "/v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA",
  "rejected-by-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  "created-by-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
  "payment-reference": "test reference",
  "payment-amount": {
    "currency": "GBP",
    "value": "1000.00"
  },
  "ultimate-debtor": {
    "iban": "GB42GFNB12345612345678",
    "uk-domestic-sort-code": "123456",
    "bic": "GFNBGB22",
    "account-number": "12345678",
    "bank-id": "123456",
    "bban": "GFNB12345612345678",
    "uk-domestic-account-number": "12345678",
    "other-account-identification": "ABC123",
    "other-institution-identification": "ABC123"
  },
  "payment-admissions-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/admissions",
  "payment-submissions-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA/submissions",
  "debtor": {
    "iban": "GB42GFNB12345612345678",
    "uk-domestic-sort-code": "123456",
    "bic": "GFNBGB22",
    "account-number": "12345678",
    "bank-id": "123456",
    "bban": "GFNB12345612345678",
    "uk-domestic-account-number": "12345678",
    "other-account-identification": "ABC123",
    "other-institution-identification": "ABC123"
  },
  "rejected-by-user": {
    "user-email": "user@example.com",
    "user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
    "user-username": "user@example.com"
  }
}