Retrieve the status of a payment request initiation

Use case

This method allows the PISP to obtain the status of a payment initiation request previously sent to the ASPSP for a given PSU through a POST /paymentRequests request.

 

Prerequisite

In order to process this request some eligibility prerequisites are needed, like to get the OAUTH2 access token (see "Retrieve your access token" use case).

The TPP has already sent a request that has been saved by the ASPSP and to which the ASPSP responded with a location link to the saved payment/transfer request.

 

Request

get/payment-requests/{paymentRequestResourceId}

 

Mandatory or facultative body parameters needed for calling the service

Mandatory parameter paymentRequestResourceId : Identification of the payment request resource

 

Returned result

When submitting the request and if all the data is correctly formatted, a response (HTPP 200) will be returned.

This response will contain the payment initiation data enriched with the status of the initiation request and the associated payment.

The possible values for the status of the payment request are as follows (values for STET version v1.4.0.47) :

Code Description
ACCP AcceptedCustomerProfile : Preceding check of technical validation was successful. Customer profile check was also successful.
ACSC AcceptedSettlementCompleted : Settlement on the debtor's account has been completed.
ACSP AcceptedSettlementInProcess : All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
ACTC AcceptedTechnicalValidation : Authentication and syntactical and semantical validation are successful.
ACWC AcceptedWithChange : Instruction is accepted but a change will be made, such as date or remittance not sent.
ACWP AcceptedWithoutPosting : Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
PART PartiallyAccepted : A number of transactions have been accepted, whereas another number of transactions have not yet achieved 'accepted' status.
RCVD Received : Payment initiation has been received by the receiving agent.
PDNG Pending : Payment request or individual transaction included in the payment request is pending. Further checks and status update will be performed.
RJCT Rejected : Payment request has been rejected.

 

The following table shows the possible values ​​for the status of the payment initiation and the associated payment transaction (values for STET version v1.4.0.47) :

Processing an initiation containing a payment Result paymentInformationStatus value transactionStatus value
Check and record the initiation request OK ACTC -
KO RJTC -
Consent OK ACCP  -
KO RJCT  -
Request for payment execution OK ACSP PDNG
OK ACSP ACSP
KO RJCT RJCT
Payment execution OK ACSC ACSC
KO RJCT RJCT

 

Example

Request :

GET/stet/psd2/v1/payment-requests/0000000386-155532845000030007970322

 

Result :

Status code : 200

 

Body

{
      "paymentRequest": {
            "resourceId": "0000000386-155532845000030007970322",
            "paymentInformationId": "TestBP041501C",
            "creationDateTime": "2019-04-15T12:56:11.122Z",
            "numberOfTransactions": 1,
            "initiatingParty": {
                  "name": "Mon marchand",
                  "postalAddress": {
                        "country": "FR",
                        "addressLine": [
                              "Copé Choux",
                              "44850 Mouzeil"
                        ]
                  },
                  "organisationId": {
                        "identification": "00987654321",
                       "schemeName": "BANK",
                       "issuer": "FR"
                  },
                  "privateId": null
            },
            "paymentTypeInformation": {
                  "instructionPriority": "HIGH",
                  "serviceLevel": "SEPA",
                  "localInstrument": null,
                  "categoryPurpose": "CASH"
            },
            "debtor": {
                  "name": "Gaby Gallet Fourcade",
                  "postalAddress": {
                        "country": "FR",
                        "addressLine": [
                              "25 rue de la Grange aux Loups",
                              "44000 Nantes"
                        ]
                  },
                  "organisationId": null,
                  "privateId": {
                        "identification": "D0999993I0",
                        "schemeName": "COID",
                        "issuer": "FR"
                  }
            },
            "debtorAccount": {
                  "iban": "FR7613807008060732183304150",
                  "other": null
            },
            "debtorAgent": {
                  "bicFi": "CCBPFRPPNAN",
                  "clearingSystemMemberId": null,
                  "name": null,
                  "postalAddress": null
            },
            "beneficiary": {
                  "id": "string",
                  "isTrusted": false,
                  "creditorAgent": {
                        "bicFi": "CCBPFRPPNAN",
                        "clearingSystemMemberId": null,
                        "name": null,
                        "postalAddress": null
                  },
                  "creditor": {
                        "name": "Camille Foucher",
                        "postalAddress": {
                              "country": "FR",
                              "addressLine": [
                                    "23 rue Fructidor",
                                    "44000 Nantes"
                              ]
                        },
                        "organisationId": null,
                        "privateId": {
                              "identification": "D0371101",
                              "schemeName": "COID",
                              "issuer": "FR"
                        }
                   },
                  "creditorAccount": {
                        "iban": "FR7613807000343142150215863",
                        "other": null
                  }
            },
            "ultimateCreditor": null,
            "purpose": null,
            "chargeBearer": "SLEV",
            "paymentInformationStatus": "ACTC",
            "statusReasonInformation": null,
            "fundsAvailability": null,
            "booking": false,
            "requestedExecutionDate": "2019-04-15T12:56:11.122Z",
            "creditTransferTransaction": [
                  {
                        "paymentId": {
                              "resourceId": "0000000386-155532845000130007219679",
                             "instructionId": "TestBP041501C",
                             "endToEndId": "TestBP041501C"
                        },
                        "requestedExecutionDate": null,
                        "endDate": null,
                        "executionRule": null,
                        "frequency": null,
                        "instructedAmount": {
                              "currency": "EUR",
                              "amount": "150"
                        },
                        "beneficiary": null,
                        "ultimateCreditor": null,
                        "regulatoryReportingCodes": [
                              "string"
                        ],
                        "remittanceInformation": [
                              "ma remittance"
                        ],
                        "transactionStatus": null,
                        "statusReasonInformation": null
                  }
            ],
            "supplementaryData": {
                 "acceptedAuthenticationApproach": [
                       "REDIRECT"
                  ],
                  "appliedAuthenticationApproach": "REDIRECT",
                  "scaHint": "noScaExemption",
                  "successfulReportUrl": "https://www.successful.fr",
                 "unsuccessfulReportUrl": "https://www.unsuccessful.fr"
           }
      },
      "_links": null
}

 

Error codes

Error type

HTTP code

Description

Reason

Bad access token, authentication problem

403

Forbidden

 

Unknown request resource 

404

Not Found

Unknown ressource

Bad request or request outside the authorized scope

405

Method not allowed

 

Generic message

500

Internal server error

 

Duplicate query

500

Internal server error

error : Database insertion problem, duplicate unique key