pay-open-banking-demo

As of July 2024 this repository is no longer actively maintained by the GOV.UK Pay team.

Playing around with creating an open banking demo in Go

Building

go build -o pay-open-banking-demo .

Running

docker run -d -p 5432:5432 --name openbanking -e POSTGRES_PASSWORD=mysupersecretpassword postgres

APPLICATION_URL=http://localhost:8080 DATABASE_URL=postgres://postgres:mysupersecretpassword@localhost:5432/?sslmode=disable TRUELAYER_PAY_URL=https://pay-api.truelayer-sandbox.com TRUELAYER_AUTH_URL=https://auth.truelayer-sandbox.com TRUELAYER_CLIENT_ID=xxx TRUELAYER_CLIENT_SECRET=xxx ./pay-open-banking-demo

Environment variables

variable	description
APPLICATION_URL	the base URL of the application
DATABASE_URL	the connection URL for the database
TRUELAYER_PAY_URL	the URL of the TrueLayer Pay API
TRUELAYER_AUTH_URL	the URL of the TrueLayer Auth API
TRUELAYER_CLIENT_ID	the client_id for the TrueLayer account
TRUELAYER_CLIENT_SECRET	the client_secret for the TrueLayer account
BANK_ACCOUNT_NO	the bank account to send funds to, defaults to a test value that works for TrueLayer sandbox
BANK_SORT_CODE	the sort code for the bank to send funds to, defaults to a test value that works for TrueLayer sandbox

Usage

Make a POST request to /v1/api/payments with body:

{
  "reference": "CAKE",
  "description": "Pay for a GOV.UK Pay cake",
  "amount": 2499,
  "return_url": "https://www.google.com"
}

This mimics the behaviour of how a government service would integrate with the GOV.UK Pay API.

Follow the next_url in the response to complete the payment journey.

Deploying

Deployed to GOV.UK PaaS.

Using cloudfoundry ci, login to PaaS and run

cf push

This uses manifest.yml which contains environment variables for the TrueLayer sandbox environment. Secrets are set manually using cf set-env.

Requires a postgres service to be running in PaaS and bound to the app.

To push a version that points to the live TrueLayer account, use live-manifest.yml

cf push -f live-manifest.yml