Shieldpay

Getting Started

Integration Lifecycle

API Fundamentals

Environments

Authentication & Security

Additional Request Requirements

Webhooks

Examples

Generating a Private Key and CSR

Default

Production

Authentication (mTLS & API Keys)

IP Whitelisting

Obtaining Your Certificate & API Key

Request Signing (Digital Signature)

<p class="slate-p " ></p><p class="slate-p " >Our API uses a multi-layered approach to security, requiring every request to be authenticated, signed, and sent from a trusted location.</p><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(52, 60, 73)">Every request to our API will need to:</span></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Establish an MTLS connection.</div></li><li class="slate-li " ><div style="position:relative">Include an API Key for authentication and authorisation.</div></li><li class="slate-li " ><div style="position:relative">Be signed with a Digital Signature for integrity checks.</div></li><li class="slate-li " ><div style="position:relative">Include a Timestamp and Request ID.</div></li><li class="slate-li " ><div style="position:relative">Come from a whitelisted IP address.</div></li></ol><p class="slate-p " ></p>

Our API uses a multi-layered approach to security, requiring every request to be authenticated, signed, and sent from a trusted location.

Sections

Authentication & Security

On this page