API Workflow & Setup

This document outlines the standard (Happy-path) flow for the PAC API. It explains how to initiate a verification of the name and IBAN of a beneficiary.

To test error scenarios, see Try it Out (Sandbox).

Before you begin

Before you initiate a payee account check, you should to meet the following requirements.

Sandbox Requirements

Set up a sandbox account
Set up sandbox application and subscription to either:
- Payee Account Check Sandbox
- Payee Account Check for Third Parties Sandbox
Set up your Mutual TLS connection, you can find our example certificates for sandbox here.
Set up your signing flow, you can find our example certificates for sandbox here.
Set up your Oauth flow

Production Requirements

Set up a production account. To get a production account, see Go to Production
Set up production application and subscription to either:
- Payee Account Check
- Payee Account Check for Third Parties
Set up your Mutual TLS connection with your EV SSL certificate
Set up your signing flow with your EV SSL certificate
Set up your OAuth flow

Required Headers

You are required to sign the payload for the POST (Verify name and IBAN of the beneficiary)

🚧

Supported characters allowed range from A-Z, a-z, 0-9

Special characters include ; . / \ +? ( ) , +E(at) - colon.

No Diacritics letters or characters are allowed.

📘
Read our Validate Signing Requests documentation for a detailed description of our signing method.

Required headers to include in your requests are:

Name	Description	Format
Date	The date in a RFC-compliant date/time format.	String
Digest	The digest is a base64 encoded hash of the body.	String
X-Request-ID	The X-Request-ID is a UUID generated by you.	UUID
Signature	The signature is the signing string signed with your private key.	String
Signature-Certificate	The signature certificate is the public part of your EV SSL signing certificate.	String
X-IBM-Client-ID	The X-IBM-Client-ID is a UUID generated by your application.	UUID
Authorization	The Authorization header should include your access token.	String
PSU-IP-Address	The PSU-IP-Address consist of the IP address of the initiating party.	String
Content-Type	Defines the type of the request. Only required for POST requests.	String

Step 1 - Verify name and IBAN of the beneficiary

Endpoint:

Verify name and IBAN of the beneficiary
POST /spv/payments/single-payee-verification

Purpose: This endpoint can be used to verify the name and IBAN of a beneficiary before entering a payment instruction. This check is performed to make sure the payment is not rejected due to mismatch in IBAN Name combination.

A successful call returns the resultType that shows if a payment made with these details will be executed or not:

MATCHING - The details are a match. If done together with a payment, the payment is executed immediately.
NOT_MATCHING - The details are not a match. If done together with a payment, the payment is rejected.
CLOSE_MATCH - The details match closely to what is provided. If done together with a payment, the payment is accepted.