---
title: "Get payment"
method: GET
path: "/v0/payments/{payment-id}"
tags: ["Payments"]
---

# Get payment

`GET /v0/payments/{payment-id}`

Yields payment details

## Path parameters

- `payment-id` string, required

## Response `200`

OK

- object
  - `created-by-user` object — Shows the associated [user](#tag/Users).
    - `user-email` string, required — The user's email address.
    - `user-url` string, required — Link to the user.
    - `user-username` string, required — The username.
    - `api-keys-url` union, required — Link to the user's [api keys](#tag/API-keys).
      - string
      - string
    - `user-memberships-url` union, required — Link to the user's [memberships](#tag/Memberships).
      - string
      - string
    - `given-name` string
    - `surname` string
  - `creditor` union
    - object
      - `account-url` union, required — Link to the bank account resource.
        - string
        - string
      - `creditor-type` 'griffin-bank-account', required
    - object — Creditor specified with bank details
      - `iban` string — An International Bank Account Number.
      - `uk-domestic-sort-code` string — A UK sort code.
      - `bic` string — A BIC.
      - `account-number` string — A UK account number.
      - `account-holder` string — The name of the [account holder](/docs/terms/account-holder).
      - `bank-id-code` 'gbdsc'
      - `bank-id` string — A UK sort code.
      - `creditor-type` 'uk-domestic', required
      - `bban` string — A country-specific Basic Bank Account Number.
      - `account-url` union — Link to the bank account resource.
        - string
        - string
      - `uk-domestic-account-number` string — A UK account number.
      - `other-account-identification` string — Uncategorised account identification
      - `account-number-code` 'bban'
      - `other-institution-identification` string — Uncategorised financial institution identification
  - `rejected-at` string, date-time — ISO 8601 formatted date-time.
  - `latest-submission-url` string — Most recent submission (if any made)
  - `rejected-by-url` string — 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-url` string — Link to the user.
  - `created-via` 'api' | 'ui'
  - `created-at` string, date-time, required — ISO 8601 formatted date-time.
  - `payment-url` string, required — Link to the payment resource.
  - `payment-reference` string — Free-text field to help identify and categorise payments.
  - `payment-amount` object, required — Compound value representing both the currency and amount of money being sent.
    - `currency` 'GBP', required
    - `value` string, required — The value as a decimal-formatted string
  - `payment-type` 'credit-transfer' | 'direct-debit', required — Whether the payment is a credit transfer or direct debit.
  - `ultimate-debtor` object
    - `iban` string — An International Bank Account Number.
    - `uk-domestic-sort-code` string — A UK sort code.
    - `bic` string — A BIC.
    - `account-number` string — A UK account number.
    - `account-holder` string — The name of the [account holder](/docs/terms/account-holder).
    - `bank-id-code` 'gbdsc'
    - `bank-id` string — A UK sort code.
    - `bban` string — A country-specific Basic Bank Account Number.
    - `account-url` union — Link to the bank account resource.
      - string
      - string
    - `uk-domestic-account-number` string — A UK account number.
    - `other-account-identification` string — Uncategorised account identification
    - `account-number-code` 'bban'
    - `other-institution-identification` string — Uncategorised financial institution identification
  - `payment-admissions-url` string — Link to the endpoint for listing payment admissions.
  - `payment-submissions-url` string — Link to the endpoint for creating and listing payment submissions.
  - `debtor` object
    - `iban` string — An International Bank Account Number.
    - `uk-domestic-sort-code` string — A UK sort code.
    - `bic` string — A BIC.
    - `account-number` string — A UK account number.
    - `account-holder` string — The name of the [account holder](/docs/terms/account-holder).
    - `bank-id-code` 'gbdsc'
    - `bank-id` string — A UK sort code.
    - `bban` string — A country-specific Basic Bank Account Number.
    - `account-url` union — Link to the bank account resource.
      - string
      - string
    - `uk-domestic-account-number` string — A UK account number.
    - `other-account-identification` string — Uncategorised account identification
    - `account-number-code` 'bban'
    - `other-institution-identification` string — Uncategorised financial institution identification
  - `rejection-reason` string, nullable
  - `mandate-url` union — Link to a direct debit mandate.
    - string
    - string
  - `rejected-by-user` object — Shows the associated [user](#tag/Users).
    - `user-email` string, required — The user's email address.
    - `user-url` string, required — Link to the user.
    - `user-username` string, required — The username.
    - `api-keys-url` union, required — Link to the user's [api keys](#tag/API-keys).
      - string
      - string
    - `user-memberships-url` union, required — Link to the user's [memberships](#tag/Memberships).
      - string
      - string
    - `given-name` string
    - `surname` string

## Other responses

- `400` — Bad Request
- `401` — Requires an API key to continue
- `404` — Not Found

---

[API](https://skmtc.net/griffin/apis/the-griffin-api.md) · [All operations](https://skmtc.net/griffin/apis/the-griffin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/griffin/the-griffin-api/revisions/7da510b95492/schema)