Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Payments

List payments in your organization.

get/v0/organizations/{organization-id}/payments

Path parameters

organization-idstring required

Query parameters

sort'-created-at' | 'created-at'
page[size]integer
page[before]string byte

A base64 encoded opaque string returned in paginated responses.

page[after]string byte

A base64 encoded opaque string returned in paginated responses.

includestring[]

For each payment returned, include its bank account, latest submission (if one exists), rejecting user (if one exists), and/or creating user (if one exists) in the response under the included attribute.

filter[rejected][eq]boolean

Specifies whether the payment has been rejected.

filter[payment-direction][eq]'inbound-payment' | 'outbound-payment'

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

filter[latest-submission-status][in][]string[]
filter[created-at][lte]string date-time

Return only resources with a created-at less than or equal to the given timestamp.

filter[created-at][lt]string date-time

Return only resources with a created-at less than the given timestamp.

filter[created-at][gte]string date-time

Return only resources with a created-at greater than or equal to the given timestamp.

filter[created-at][gt]string date-time

Return only resources with a created-at greater than the given timestamp.

Response

OK

Example response

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