Payment API

#

Scenario

Customer Name

Building Society

Consent ID

Sample Response
Create Domestic Payment Consents Get Domestic Payment Consents ConsentId Create Domestic Payments Get Domestic Payments Domestic PaymentId

1

Insufficient Available Balance - Selected Account - reselect or cancel

John Reed

Yorkshire

pisp-10070

Request Payload

Sample Response

Sample Response

     

2

PSU but doesn't have the Account Role required to make a payment

Mike Clarke

Yorkshire

pisp-10080

Request Payload

Sample Response

Sample Response

     

3

Warning Flags on Account preventing payment

Peter Campbell

Yorkshire

pisp-10090

Request Payload

Sample Response

Sample Response

     

4

Fin Crime Flags on Account preventing payment

Jack Hopkins

Yorkshire

pisp-10100

Request Payload

Sample Response

Sample Response

     

5

Awaiting Authentication / Authorisation - PSU can Cancel process or eventually Decline

Dan Wright

Chelsea

pisp-10110

Request Payload

Sample Response

Sample Response

     

6

Authorised

Dan Wright

Chelsea

pisp-10120

Request Payload

Sample Response

Sample Response

     

7

Access Token received 24 hours after issue / Idempotency issue

Mike Clarke

Yorkshire

pisp-10130

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

8

External Payment submitted to Faster Payments

George Smith

Yorkshire

pisp-10140

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

9

External Payment submitted to Faster Payments (Day +1 - Just after Midnight)

George Smith

Yorkshire

pisp-10145

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

10

Internal Payment - Immediate Transfer

George Smith

Yorkshire

pisp-10150

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

11

After Midnight - Submitted to Faster Payments next day

Chris Porter

Chelsea

pisp-10160

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

12

Completed - Internal Transfer YBS to YBS

Mike Clarke

Yorkshire

pisp-10170

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

13

Completed - Internal Transfer CBS to CBS

Lucy Abbott

Chelsea

pisp-10180

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

14

Completed - CBS to YBS - Faster Payments

Lucy Abbott

Chelsea

pisp-10190

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

15

Payment intercepted by Fin Crime Work Events - Fin Crime reject

Paul Dobson

Yorkshire

pisp-10210

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

16

Payment passes / not seleted for Fin Crime

Paul Dobson

Yorkshire

pisp-10220

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

17

Payment passes / not seleted for Fin Crime 

Lucy Abbott

Chelsea

pisp-10230

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

Error Scenarios

#

Customer Name

Building Society

Consent ID

Create Domestic Payment Consents

Description

1

John Reed

Yorkshire

1

Request Payload

Sample Response

Insufficient Available Balance

2

Dan Wright

Chelsea

2

Request Payload

Sample Response

Dan Wright's Account Stated by PSU - No permission

3

Dan Wright

Chelsea

3

Request Payload

Sample Response

Invalid Creditor Account (Merchant)

4

Dan Wright

Chelsea

4

Request Payload

Sample Response

Invalid Payment Account - Not PSD2, Warning Flags

5

Dan Wright

Chelsea

5

Request Payload

Sample Response

Invalid Payment Amount (Zero)

6

Dan Wright

Chelsea

6

Request Payload

Sample Response

Invalid Currency (Euro)

7

Dan Wright

Chelsea

7

Request Payload

Sample Response

Invalid Local Instrument (Only accept FPS)

8

Dan Wright

Chelsea

8

Request Payload

Sample Response

Delivery Address must be supplied when Context Type is EcommerceGoods

9

Dan Wright

Chelsea

9

Request Payload

Sample Response

CBS to CBS - Creditor Account is not Active (Date of Death Set)

10

Dan Wright

Chelsea

10

Request Payload

Sample Response

Debtor Account is NOT SortCode + 10 digit Account Number - Only 8 digits supplied

11

Dan Wright

Chelsea

11

Request Payload

Sample Response

Debtor Account is is Valid (6 + 10) - Creditor Invalid (YBS/CBS but only 8 digits supplied

 

Standing Order API

#

Scenario

Customer Name

Building Society

Consent ID

Sample Response
Create Standing Order Consent Request Get Standing Order Consent Request Status Create Standing Order Request Get Standing Order Request Status

1

PSU logins in - Status = Awaiting Authorisation, PSU is not authorised to use Account specified - Status = Rejected

Dan Wright

Chelsea

so-30000

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

2

PSU logins in - Status = Awaiting Authorisation, PSU does not Authorise Standing Order - Status = Rejected

Dan Wright

Chelsea

so-30002

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

3

PSU logins in - Status = Awaiting Authorisation, PSU does       Authorise Standing Order - Status = Authorised

Dan Wright

Chelsea

so-30004

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

4

Flags that prevent Payments being made

Mike Clarke

Yorkshire

so-30010

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

5

PSU not authorised to make payment

Dan Wright

Chelsea

so-30020

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

6

Account requires multiple signatures to make payment

Adam Jones

Chelsea

so-30030

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

7

Valid Standing Order with Weekly Frequency 100

Dan Wright

Chelsea

so-30040

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

8

Valid Standing Order with Fortnightly Frequency 100

Dan Wright

Chelsea

so-30050

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

9

Valid Standing Order with Monthly Frequency 12

Dan Wright

Chelsea

so-30060

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

10

Valid Standing Order with Quarterly Frequency 8

Dan Wright

Chelsea

so-30070

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

11

Valid Standing Order with Six Monthly Frequency 6

Dan Wright

Chelsea

so-30080

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

12

Valid Standing Order with Monthly Frequency 12

Jane Williams

Chelsea

so-30090

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

13

Valid Standing Order with Annually Frequency 5

Jane Williams

Chelsea

so-30100

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

14

Valid Standing Order with Weekly Frequency 52

George Smith

Yorkshire

so-30110

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

15

Valid Standing Order with Monthly Frequency 24

George Smith

Yorkshire

so-30120

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

16

Valid Standing Order with Monthly Frequency 12

Jane Williams

Chelsea

so-30130

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

17

Valid Standing Order with Monthly Frequency 12

Jane Williams

Chelsea

so-30140

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

18

Valid Standing Order with Monthly Frequency 12

Jack Hopkins

Yorkshire

so-30150

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

19

Valid Standing Order with Monthly Frequency 12

Peter Campbell

Yorkshire

so-30160

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

20

Valid Standing Order with Fortnightly Frequency 100

Dan Wright

Chelsea

so-30170

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

21

Valid Standing Order with Monthly Frequency 12

Dan Wright

Chelsea

so-30180

Request Payload

Sample Response

Sample Response

Request Payload

Sample Response

Sample Response

 

Error Scenarios

#

Customer Name

Building Society

Consent ID

Create Funds Confirmation Consent Request

Description

1

Dan Wright

Chelsea

1

Request Payload

Sample Response

Daily - Frequency Unsupported

2

Dan Wright

Chelsea

2

Request Payload

Sample Response

EvryWorkgDay - Frequency Unsupported

3

Dan Wright

Chelsea

3

Request Payload

Sample Response

WklnMnthDay - Frequency Unsupported

4

Dan Wright

Chelsea

4

Request Payload

Sample Response

IntrvlMnthDay - Frequency Unsupported

5

Dan Wright

Chelsea

5

Request Payload

Sample Response

QtrDay - Frequency Unsupported

6

Dan Wright

Chelsea

6

Request Payload

Sample Response

IntrvlWkDay - Frequency Unsupported

7

Dan Wright

Chelsea

7

Request Payload

Sample Response

Number of Payments - Number of Payments Unsupported

8

George Smith

Yorkshire

8

Request Payload

Sample Response

First Payment Date - Missing

9

Dan Wright

Chelsea

9

Request Payload

Sample Response

First Payment Date - Not > 3 days in advance

10

Dan Wright

Chelsea

10

Request Payload

Sample Response

Last Payment Date - Not > Start Date

11

Dan Wright

Chelsea

11

Request Payload

Sample Response

Recurring Amount - Only allowed to have a single Amount

12

Dan Wright

Chelsea

12

Request Payload

Sample Response

Final Amount - Only allowed to have a single Amount

13

Dan Wright

Chelsea

13

Request Payload

Sample Response

Curency - Euro - Not Supported

14

Dan Wright

Chelsea

14

Request Payload

Sample Response

Foreign Creditor - GB Payments only

15

Lucy Abbott

Chelsea

15

Request Payload

Sample Response

Debtor Account Error - Debtor Account Not Open

16

Lucy Abbott

Chelsea

16

Request Payload

Sample Response

No Reference - Reference must be supplied and must be unique for Customer / Creditor Account

17

Lucy Abbott

Chelsea

17

Request Payload

Sample Response

Ecommerce Service - No Merchant Details - Service Payments must have Merchant details populated

18

Lucy Abbott

Chelsea

18

Request Payload

Sample Response

Ecommerce Goods - No Del Address - Service Payments must have Merchant details populated = Goods must have Del Address