openapi: 3.0.3
info:
title: Fraud Service API
description: Fraud Service OpenAPI specification
version: 1.0.0
tags:
- name: Fraud Service
description: Fraud Service Endpoint
paths:
/fraud:
post:
tags:
- Fraud Service
description: API for fraud service
requestBody:
content:
application/json:
schema:
required:
- msgType
- msgDirection
- msgStatus
- payload
- txId
type: object
properties:
msgType:
type: string
description: Type of processed message (pacs.008, camt.056, pacs.004, camt.029)
example: pacs.008
msgDirection:
type: string
description: Direction of processed message (SND or RCV)
example: RCV
msgStatus:
type: string
description: Status of the processed message
example: 75000
payload:
type: string
description: Payload of the processed message.
example: "RP8-01TIPS-P2R-P2E-08-251104240002022-01-26T11:04:24Z0000000000000019325.62022-01-26CLRGTIPSSEPAINSTTAXSBNPAFRPPBREDFRP0IIDRP8TIPS-P2R-P2E-08-25110424000P2R-P2E-08TIDRP8TIPS-P2R-P2E-08-251104240009325.62022-01-26T11:04:24.023+02:00SLEVSIMONE VEIL35xCUST35xBNP PARIBASFR257 Rue de Paris93100 Montreuil1987-10-2815AIXEVFRFR5500111002220033333333355BNPAFRPPXXXBREDFRP0XXXP2R-P2E-08FR18 Quai de la Rap75012 ParisTOTOFRPPXXXFR4400111002220033333333344Steves Saibiensituvepatanpy168010216806162numero INSEEINSEEGOVTSCORCdtrRefInf_TypeIssuer35x[CdtrRefInf_Ref35x]"
confirmRptPayload:
type: string
description: Payload of the pacs.002 or of the nack associated with the message, if present.
example: "06R01202201261104244730000062022-01-26T12:04:24.473BREDFRP0IPSTFRPPRP8-01TIPS-P2R-P2E-08-25110424000pacs.008.001.08ACCP06R0120220126110424473000006IIDRP8TIPS-P2R-P2E-08-25110424000P2R-P2E-08TIDRP8TIPS-P2R-P2E-08-251104240002022-01-26T11:04:24.023+02:00SEPAINSTTAXSBNPAFRPPXXX"
payloadId:
type: string
description: Unique reference of the message related to the payload
example: TIDRP8TIPS-P2R-P2E-08-25110424000
txId:
type: string
description: Unique reference of original pacs.008.
example: TIDRP8TIPS-P2R-P2E-08-25110424000
token:
type: string
description: Security token given in the capture request for outgoing / by the Token API for incoming.
debtorIBAN:
type: string
description: Debtor International Bank Account Number of the message
example: FR5500111002220033333333355
creditorIBAN:
type: string
description: Creditor International Bank Account Number of the message
example: FR4400111002220033333333344
debtorBIC:
type: string
description: Debtor Business Identifier Code of the message
example: BNPAFRPPXXX
creditorBIC:
type: string
description: Creditor Business Identifier Code of the message
example: BREDFRP0XXX
debtorNm:
type: string
description: Debtor name of the message
example: SIMONE VEIL
creditorNm:
type: string
description: Creditor name of the message
example: Steves Saibiensituvepatanpy
intrBkSttlmAmt:
type: string
description: Amount of the message
example: 9325.6
intrBkSttlmAmtCcy:
type: string
description: Currency of the message
example: EUR
circuitCd:
type: string
description: Circuit on which the message is exchanged
example: TIPS
suCd:
type: string
description: Code of the payment owner Single Unit (related to bank organization)
example: BNKA
proprietary:
type: object
description: Key that allows to send a set of data specific to the Bank if provided in the original message
example: {"addressIP": "127.0.0.1","browser" : "IE11"}
responses:
'200':
description: Success
content:
application/json:
schema:
required:
- returnCode
type: object
properties:
returnCode:
maxLength: 2
minLength: 2
type: string
description: Passing or not passing return code of the control carried out(OK or KO)
example: OK
reasonCode:
maxLength: 30
minLength: 1
type: string
description: Reason code that will be returned in the event reports and the customer notifications, or pacs.002 confirmation messages.
example: "0477"
reasonLabel:
type: string
description: Reason name label
example: OFAC 100
'400':
description: Bad Request
'401':
description: Unauthorized Access
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Method Not Allowed
'409':
description: Conflict
'415':
description: Unsupported Media Type
'429':
description: Too Many Requests
'500':
description: Internal server error
'504':
description: Gateway Timeout