A payment captures the intent to move funds from a bank account to another bank account. Outbound payments can be made from your [bank account](#tag/Bank-accounts) to a [payee](#tag/Payees). Griffin accepts inbound payments to your bank accounts on your behalf. If it's your first time using our payments API, check out our guide for [sending payments](/docs/guides/sending-payments)
swagger: '2.0'
info:
title: The Griffin API keys Payments API
version: ''
description: "## Introduction\n\nThe Griffin API is based on [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).\nIt has resource-oriented URLs, accepts [JSON](https://www.json.org/json-en.html)-encoded request bodies, returns [JSON](https://www.json.org/json-en.html)-encoded responses, and uses standard HTTP response verbs and response codes.\n\nOur API deviates from strict RESTful principles if it makes sense to do so, such as when we enforce tighter access controls around certain operations.\nFor example, when closing a bank account: rather than send a PATCH request to the [bank account](#tag/Bank-accounts) resource to update it's status to `\"closed\"`, we provide a dedicated account closure resource.\n\nAnyone can [create an account](https://app.griffin.com/register) with Griffin and try out our API in [sandbox mode](/docs/guides/sandbox-vs-live-mode).\n\nNew to Griffin? Check out our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Navigation\n\nOur API is designed to be navigated programmatically. When you request any resource, you will find the URLs for related resources in the response body.\n\nThe API is structured as a tree with your [organization](#tag/Organizations) at the top. Everything that you own will be a sub-resource of your organization.\n\nTo bootstrap the navigation process, request the [index](#tag/Navigation/paths/~1v0~1index/get) endpoint: the response will contain your `organization-url`.\n\nFor a walkthrough, see our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Pagination\n\nOur list APIs support pagination (e.g. [list bank accounts](#tag/Bank-accounts/paths/~1v0~1organizations~1%7Borganization-id%7D~1bank~1accounts/get) and [list payments](#tag/Payments/paths/~1v0~1bank~1accounts~1%7Bbank-account-id%7D~1payments/get)).\nBy default, a list API returns up to 25 results. If there are more results available, the response payload will include links to the previous/next pages.\n\n### Change page size\n\nYou can request a different number of results (between 1 and 200, inclusive) by using the `page[size]` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?page[size]=100\n```\n\n### Navigating between pages\n\nList responses will include a `links` object with `prev` and `next` attributes, as shown below.\nPerform a GET request to the value of the attribute to fetch the previous/next page of results.\n\n```\n{\n \"accounts\": [\n // ...\n ],\n \"links\": {\n \"prev\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[before]=djE6WxSPxfYUTnCU9XtWzj9gGA\",\n \"next\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[after]=djE6aw79PXZySUOL16LD8HRJ3A\"\n }\n}\n\n```\nIf there is no previous or next page available, the value of the attribute will be null.\n\nAny other query parameters included in the initial request will also be included in the response payload's links.\nIf you want to change parameters (see [filtering and sorting](#section/Filtering-and-sorting)), request the first page and follow the links from there.\n\n## Filtering and sorting\n\n### Sort results\n\nBy default, resources will be listed in descending order, usually based on the `created-at` attribute.\nYou can change the sorting behaviour of a list of results by using the `sort` query parameter.\n\nFor example, to list bank accounts in ascending order (oldest first):\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=created-at\n```\n\nTo _explicitly_ sort in descending order (newest first), prefix the sort attribute with `-`:\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=-created-at\n```\n\n### Filter results\n\nSome list APIs allow you to filter the results.\nFilters are expressed as nested data structures encoded into query parameters.\nFor example, you can list bank accounts that are in either the `opening` or `open` state with:\n\n```\nGET /v0/organizations/:id/bank/accounts?filter[account-status][in][]=opening&filter[account-status][in][]=open\n```\n\nSimilarly, you can list legal persons with a specific `application-status`:\n\n```\nGET /v0/organizations/:id/legal-persons?filter[application-status][eq]=accepted\n```\n\n### Include resources\n\nSome list APIs allow you to include associated resources in the response, reducing the number of requests needed to fetch related data.\nFor instance, when listing bank accounts, you can include each bank account's beneficiary legal person by using the `include` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?include=beneficiary\n```\n\nThe response returns the usual list of bank accounts, but it will also have an `included` object with a `legal-persons` attribute:\n\n```\n{\n \"accounts\": [\n // ...\n ],\n \"links\": {\n // ...\n }\n \"included\": {\n \"legal-persons\": [\n // ...\n ]\n }\n}\n```\n\nCheck the documentation for each list API to see all options for sorting and filtering\n\n## Request limits\n\nEach organization is allowed up to 50 concurrent (in-flight) API requests. Exceeding this threshold results in a 429 - Too Many Requests response. Upon receiving a 429 response, you should implement a backoff strategy, pausing to allow your outstanding requests to complete before attempting new requests. To manage your request rate effectively and avoid surpassing this limit, consider using a controlled approach such as a finite pool of threads or workers.\n\n## Versioning\n\nThe Griffin API is versioned via a prefix in the URL.\nThe current version is v0.\nAn example endpoint is: https://api.griffin.com/v0/index.\n\nWe will not break your integration with a particular version for as long as we support that version.\nIf we release a new version, you will have 12 months to upgrade to it."
host: api.griffin.com
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- api-key-auth: []
tags:
- name: Payments
description: "A payment captures the intent to move funds from a bank account to another bank account. Outbound payments can be made from your [bank account](#tag/Bank-accounts) to a [payee](#tag/Payees). Griffin accepts inbound payments to your bank accounts on your behalf. \n If it's your first time using our payments API, check out our guide for [sending payments](/docs/guides/sending-payments)"
paths:
/v0/admissions/{admission-id}:
get:
tags:
- Payments
description: Yields an admission.
parameters:
- type: string
required: true
name: admission-id
in: path
responses:
'200':
schema:
type: object
properties:
admission-status:
title: admission-status
enum:
- cancelled
- processing
- returned
- delivered
type: string
description: Specifies the progress of the inbound payment.
admission-scheme-information:
type: object
properties: {}
required:
- payment-scheme
title: admission-scheme-information
x-anyOf:
- type: object
properties:
end-to-end-identification:
title: end-to-end-identification
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
description: An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique.
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
title: fps
- type: object
properties:
end-to-end-identification:
title: end-to-end-identification
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
description: An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique.
payment-scheme:
enum:
- book-transfer
type: string
required:
- end-to-end-identification
- payment-scheme
title: book-transfer
- type: object
properties:
payment-scheme:
enum:
- chaps
type: string
title: chaps
required:
- payment-scheme
- type: object
properties:
payment-scheme:
enum:
- bacs
type: string
title: bacs
required:
- payment-scheme
payment-url:
type: string
title: payment-url
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
description: Link to the payment resource.
created-at:
title: created-at
format: date-time
type: string
description: ISO 8601 formatted date-time.
admission-url:
type: string
title: admission-url
example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA
unique-scheme-identifier:
type: string
title: unique-scheme-identifier
maxLength: 140
example: 'PGIT2IS7AJG77D2HK23020240212826NatWes '
minLength: 1
account-url:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
title: account-url
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
description: Link to the bank account resource.
original-unique-scheme-identifier:
type: string
title: original-unique-scheme-identifier
maxLength: 140
example: 'PGIT2IS7AJG77D2HK23020240212826NatWes '
minLength: 1
required:
- admission-status
- admission-scheme-information
- payment-url
- created-at
- admission-url
- unique-scheme-identifier
- account-url
title: admission
description: ''
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
type: string
description: Returns `GriffinSession` if no valid authentication is found.
'403':
description: ''
'404':
description: ''
summary: Get payment admission
/v0/bank/accounts/{bank-account-id}/admissions:
get:
tags:
- Payments
description: Lists admissions targeting a bank account
parameters:
- in: query
name: sort
description: ''
type: string
required: false
enum:
- -created-at
- created-at
- x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
maximum: 200
minimum: 1
name: page[size]
required: false
type: integer
description: ''
format: int64
in: query
- in: query
name: page[before]
description: A base64 encoded opaque string returned in paginated responses.
type: string
required: false
format: byte
- in: query
name: page[after]
description: A base64 encoded opaque string returned in paginated responses.
type: string
required: false
format: byte
- in: query
name: filter[created-at][lte]
description: Return only resources with a created-at less than or equal to the given timestamp.
type: string
required: false
format: date-time
- in: query
name: filter[created-at][lt]
description: Return only resources with a created-at less than the given timestamp.
type: string
required: false
format: date-time
- in: query
name: filter[created-at][gte]
description: Return only resources with a created-at greater than or equal to the given timestamp.
type: string
required: false
format: date-time
- in: query
name: filter[created-at][gt]
description: Return only resources with a created-at greater than the given timestamp.
type: string
required: false
format: date-time
- in: query
name: filter[admission-status][in][]
description: ''
type: array
required: false
x-allOf:
- {}
- {}
items:
enum:
- cancelled
- processing
- returned
- delivered
type: string
- type: string
required: true
name: bank-account-id
in: path
responses:
'200':
schema:
type: object
properties:
admissions:
type: array
items:
type: object
properties:
admission-status:
title: admission-status
enum:
- cancelled
- processing
- returned
- delivered
type: string
description: Specifies the progress of the inbound payment.
admission-scheme-information:
type: object
properties: {}
required:
- payment-scheme
title: admission-scheme-information
x-anyOf:
- type: object
properties:
end-to-end-identification:
title: end-to-end-identification
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
description: An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique.
payment-scheme:
enum:
- fps
type: string
required:
- end-to-end-identification
- payment-scheme
title: fps
- type: object
properties:
end-to-end-identification:
title: end-to-end-identification
type: string
minLength: 1
x-allOf:
- title: non-empty-string
type: string
minLength: 1
- {}
description: An identifier for a payment, assigned by the originator, passed along unchanged throughout the entire end-to-end chain. Not necessarily unique.
payment-scheme:
enum:
- book-transfer
type: string
required:
- end-to-end-identification
- payment-scheme
title: book-transfer
- type: object
properties:
payment-scheme:
enum:
- chaps
type: string
title: chaps
required:
- payment-scheme
- type: object
properties:
payment-scheme:
enum:
- bacs
type: string
title: bacs
required:
- payment-scheme
payment-url:
type: string
title: payment-url
example: /v0/payments/pm.ICAgICAgcGF5bWVudC1pZA
description: Link to the payment resource.
created-at:
title: created-at
format: date-time
type: string
description: ISO 8601 formatted date-time.
admission-url:
type: string
title: admission-url
example: /v0/admissions/pa.ICAgIGFkbWlzc2lvbi1pZA
unique-scheme-identifier:
type: string
title: unique-scheme-identifier
maxLength: 140
example: 'PGIT2IS7AJG77D2HK23020240212826NatWes '
minLength: 1
account-url:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
title: account-url
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
description: Link to the bank account resource.
original-unique-scheme-identifier:
type: string
title: original-unique-scheme-identifier
maxLength: 140
example: 'PGIT2IS7AJG77D2HK23020240212826NatWes '
minLength: 1
required:
- admission-status
- admission-scheme-information
- payment-url
- created-at
- admission-url
- unique-scheme-identifier
- account-url
title: admission
links:
type: object
properties:
prev:
type: string
x-nullable: true
next:
type: string
x-nullable: true
required:
- prev
- next
title: links
required:
- admissions
- links
title: admissions-paginated-response
description: ''
'400':
description: ''
'401':
description: Requires an API key to continue
headers:
www-authenticate:
type: string
description: Returns `GriffinSession` if no valid authentication is found.
'404':
description: ''
summary: List bank account admissions
/v0/bank/accounts/{bank-account-id}/payments:
get:
tags:
- Payments
description: Lists payments made from a bank account.
parameters:
- in: query
name: sort
description: ''
type: string
required: false
enum:
- -created-at
- created-at
- x-allOf:
- type: integer
format: int64
- minimum: 1
maximum: 201
maximum: 200
minimum: 1
name: page[size]
required: false
type: integer
description: ''
format: int64
in: query
- in: query
name: page[before]
description: A base64 encoded opaque string returned in paginated responses.
type: string
required: false
format: byte
- in: query
name: page[after]
description: A base64 encoded opaque string returned in paginated responses.
type: string
required: false
format: byte
- in: query
name: include
description: 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.
type: array
required: false
x-allOf:
- {}
- {}
items:
enum:
- bank-account
- rejected-by
- latest-submission.created-by
- created-by
- latest-submission
type: string
- in: query
name: filter[rejected][eq]
description: Specifies whether the payment has been [rejected](/docs/guides/payment-approvals).
type: boolean
required: false
- in: query
name: filter[payment-direction][eq]
description: Whether the payment is moving money into or out of the account.
type: string
required: false
enum:
- inbound-payment
- outbound-payment
- in: query
name: filter[latest-submission-status][in][]
description: ''
type: array
required: false
x-allOf:
- {}
- {}
items:
enum:
- scheduled
- failed
- processing
- returned
- delivered
type: string
x-anyOf:
- title: submission-status
enum:
- scheduled
- failed
- processing
- returned
- delivered
type: string
description: Specifies the progress of the outbound payment.
- enum:
- 'null'
type: string
title: no-latest-submission-status
description: No latest submission status
- in: query
name: filter[created-at][lte]
description: Return only resources with a created-at less than or equal to the given timestamp.
type: string
required: false
format: date-time
- in: query
name: filter[created-at][lt]
description: Return only resources with a created-at less than the given timestamp.
type: string
required: false
format: date-time
- in: query
name: filter[created-at][gte]
description: Return only resources with a created-at greater than or equal to the given timestamp.
type: string
required: false
format: date-time
- in: query
name: filter[created-at][gt]
description: Return only resources with a created-at greater than the given timestamp.
type: string
required: false
format: date-time
- type: string
required: true
name: bank-account-id
in: path
responses:
'200':
schema:
type: object
properties:
payments:
type: array
items:
type: object
properties:
creditor:
type: object
properties: {}
required:
- creditor-type
title: creditor
x-anyOf:
- type: object
properties:
account-url:
type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
x-anyOf:
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
- type: string
x-allOf:
- type: string
- {}
- type: object
properties:
bank-account-id:
type: string
format: ''
title: bank-account-id
required: true
name: bank-account-id
required:
- bank-account-id
title: account-url
example: /v0/bank/accounts/ba.IGJhbmstYWNjb3VudC1pZA
description: Link to the bank account resource.
creditor-type:
enum:
- griffin-bank-account
type: string
required:
- account-url
- creditor-type
title: griffin-bank-account
- type: object
properties:
iban:
title: iban
pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
type: string
description: An International Bank Account Number.
maxLength: 34
example: GB42GFNB12345612345678
minLength: 5
uk-domestic-sort-code:
title: uk-domestic-sort-code
pattern: ^[0-9]{6}$
type: string
description: A UK sort code.
maxLength: 6
example: '123456'
minLength: 6
bic:
title: bic
pattern: '[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}'
type: string
description: A BIC.
maxLength: 11
example: GFNBGB22
minLength: 8
account-number:
example: '12345678'
x-allOf:
- type: string
- {}
minLength: 8
maxLength: 8
deprecated: true
title: account-number
pattern: ^[0-9]{8}$
type: string
description: A UK account number.
account-holder:
type: string
minLength: 1
title: account-holder
description: The name of the [account holder](/docs/terms/account-holder).
bank-id-code:
title: bank-id-code
type: string
enum:
- gbdsc
deprecated: true
bank-id:
title: bank-id
pattern: ^[0-9]{6}$
type: string
description: A UK sort code.
maxLength: 6
example: '123456
# --- truncated at 32 KB (288 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/griffin/refs/heads/main/openapi/griffin-payments-api-openapi.yml