api-integration.html.erb

---
title: API integration
---

<div class="govuk-width-container">
  <main id="main-content" class="govuk-main-wrapper" role="main">
    <div class="govuk-grid-row">
      <%= partial 'partials/features-sub-nav.html.erb', locals: { current_page: current_page.data.title } %>

      <div class="govuk-grid-column-two-thirds">
        <h1 class="govuk-heading-l">Integrating your service with GOV.UK&nbsp;Pay</h1>

        <p class="govuk-body">You can use GOV.UK&nbsp;Pay to take credit and debit card payments in your digital service.</p>

        <p class="govuk-body">You’ll be able to:</p>
        <ul class="govuk-list govuk-list--bullet">
          <li>take payments using debit cards, credit cards or digital wallets</li>
          <li>take recurring payments</li>
          <li>give full or partial refunds</li>
          <li>report on payments manually with CSV downloads or automatically via our API</li>
          <li>apply custom branding on payment pages</li>
        </ul>
        <p class="govuk-body">If you integrate with our RESTful API you can customise your payment pages to look like the rest of your digital service.</p>
        <p class="govuk-body">
          <%= link_to 'Create an account', 'https://selfservice.payments.service.gov.uk/register/email-address', class: 'govuk-link' %>
          for free and try it yourself.
        </p>

        <h3 class="govuk-heading-s">When to integrate your service</h3>
        <p class="govuk-body">If you integrate you get all the features of GOV.UK&nbsp;Pay, plus some additional benefits.</p>

        <h3 class="govuk-heading-s">Control your payments</h3>
        <p class="govuk-body">
          Using our API gives you greater flexibility over your payments. For example, it lets you
          <%= link_to 'delay payment', 'https://docs.payments.service.gov.uk/delayed_capture/#delay-taking-a-payment', class: 'govuk-link' %>
          to a time that suits you.
        </p>

        <h3 class="govuk-heading-s">Prepopulated fields</h3>
        <p class="govuk-body">
          GOV.UK&nbsp;Pay
          <%=
            link_to 'prepopulates some transaction details',
                    'https://docs.payments.service.gov.uk/optional_features/prefill_user_details/#prefilling-fields-on-the-payment-page',
                    class: 'govuk-link'
          %>
          so users only need to enter their details once.
        </p>

        <h3 class="govuk-heading-s">Reporting</h3>
        <p class="govuk-body">
          Create
          <%= link_to 'transaction reports', 'https://docs.payments.service.gov.uk/reporting/#reporting', class: 'govuk-link' %>
          to track your payments. Or you can integrate your current income management systems with
          <%= link_to 'our API', 'https://docs.payments.service.gov.uk/api_reference/#api-reference', class: 'govuk-link' %>.
        </p>

        <h3 class="govuk-heading-s">Failure pages</h3>
        <p class="govuk-body">
          Build your own
          <%=
            link_to 'payment failure pages',
                    'https://docs.payments.service.gov.uk/optional_features/use_your_own_error_pages/#use-your-own-payment-failure-pages',
                    class: 'govuk-link'
          %>
          to improve your users experience of your service.
        </p>

        <h3 class="govuk-heading-s">Metadata</h3>
        <p class="govuk-body">
          <%= link_to 'Add metadata', 'https://docs.payments.service.gov.uk/custom_metadata/#add-custom-metadata', class: 'govuk-link' %>
          to your transactions to make it easier to reconcile payments. Add metadata to cost centre or ledger codes, customer IDs or any data you need to track.
        </p>

        <h2 class="govuk-heading-m">Integrate with our API</h2>
        <p class="govuk-body">You’ll need some developer help to get GOV.UK&nbsp;Pay set up.</p>
        <p class="govuk-body">To get started you can:</p>
        <ul class="govuk-list govuk-list--bullet">
          <li>
            read our step by step guidance in our
            <%= link_to 'developer documentation', 'https://docs.payments.service.gov.uk/#gov-uk-pay-documentation', class: 'govuk-link' %>
          </li>
          <li>
            <%= link_to 'contact our team', 'support', class: 'govuk-link' %>
            for support
          </li>
        </ul>
        <p class="govuk-body">
          If you want to find out more about all that GOV.UK&nbsp;Pay offers, see
          <%= link_to 'our features page', 'using-govuk-pay', class: 'govuk-link' %>.
        </p>
      </div>
    </div>
  </main>
</div>