8.3. Standing Orders Request

8.3.1. Payment Request Submission

8.3.1.1. Request

POST http://localhost:8080/v1/payment-requests?ui_locales= 
 
No specific headers 
 
Body 
 
{ 
 
"paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:21.289+02:00", "numberOfTransactions" : 1, "initiatingParty" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" "paymentTypeInformation" : { "serviceLevel" : "SEPA", "categoryPurpose" : "DVPM" "debtor" : { "name" : "MyCustomer", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] "privateId" : { "identification" : "FD37G", "schemeName" : "BANK", "issuer" : "BICXYYTTZZZ" "beneficiary" : { "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" 
 
"chargeBearer" : "SLEV", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "ultimateCreditor" : { "name" : "myPreferredUltimateMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "85212678900025", "schemeName" : "SIRET", "issuer" : "FR" } }, "purpose" : "CASH", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] } } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }

8.3.1.2. Response

Status code: 201 
 
Headers 
 
location: /v1/payment-requests/MyPmtInfRscId 
 
Body 
 
{ 
 
"appliedAuthenticationApproach" : "REDIRECT", "_links" : { "consentApproval" : { "href" : "https://psd2.aspsp/consent-approval" } } }

8.3.2. Payment Request Retrieval

8.3.2.1. Request

GET http://localhost:8080/v1/payment-requests/MyPmtInfRscId 
 
No specific headers 
 
No body data

8.3.2.2. Response

Status code: 200 
 
No specific headers

Body

{ "paymentRequest" : { "resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:21.289+02:00", "numberOfTransactions" : 1, "initiatingParty" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "paymentTypeInformation" : { "serviceLevel" : "SEPA", "categoryPurpose" : "DVPM"

"debtor" : {

"name" : "MyCustomer", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "privateId" : { "identification" : "FD37G", "schemeName" : "BANK", "issuer" : "BICXYYTTZZZ" } }, "debtorAgent" : { "bicFi" : "BNKAFRPPXXX" }, "beneficiary" : { "isTrusted" : true, "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PDNG", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "ultimateCreditor" : {

"name" : "myPreferredUltimateMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "85212678900025", "schemeName" : "SIRET", "issuer" : "FR" } }, "purpose" : "CASH", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "PDNG" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }, "_links" : { "request" : { "href" : "/v1/payment-requests/MyPmtInfRscId" }, "confirmation" : { "href" : "/v1/payment-requests/MyPmtInfRscId/confirmation" } } }

8.3.3. Payment Request Confirmation

8.3.3.1. Request

POST http://localhost:8080/v1/payment-requests/MyPmtInfRscId/confirmation 
 
No specific headers 
 
Body 
 
{ }

8.3.3.2. Response

Status code: 200 
 
No specific headers 
 
Body 
 
{ 
 
"paymentRequest" : { "resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:21.289+02:00", "numberOfTransactions" : 1, "initiatingParty" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" "paymentTypeInformation" : { "serviceLevel" : "SEPA", "categoryPurpose" : "DVPM" "debtor" : { "name" : "MyCustomer", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] "privateId" : { "identification" : "FD37G", "schemeName" : "BANK", "issuer" : "BICXYYTTZZZ" "debtorAgent" : { "bicFi" : "BNKAFRPPXXX" "beneficiary" : { "isTrusted" : true, "creditor" : { 
 
"name" : "Erwin Ghost", 
 
"postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PART", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "ultimateCreditor" : { "name" : "myPreferredUltimateMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "85212678900025", "schemeName" : "SIRET", "issuer" : "FR" } }, "purpose" : "CASH", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "ACSC" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], 
 
"appliedAuthenticationApproach" : "REDIRECT", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }, "_links" : { "request" : { "href" : "/v1/payment-requests/MyPmtInfRscId" } } }

8.3.4. Payment Request Cancellation

8.3.4.1. Request

PUT http://localhost:8080/v1/payment-requests/MyPmtInfRscId

No specific headers

Body

{ "resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:21.289+02:00", "numberOfTransactions" : 1, "initiatingParty" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "paymentTypeInformation" : { "serviceLevel" : "SEPA", "categoryPurpose" : "DVPM" }, "debtor" : { "name" : "MyCustomer", "postalAddress" : { "country" : "FR",

"addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ]

}, "privateId" : { "identification" : "FD37G", "schemeName" : "BANK", "issuer" : "BICXYYTTZZZ" } }, "debtorAgent" : { "bicFi" : "BNKAFRPPXXX" }, "beneficiary" : { "isTrusted" : true, "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "RJCT", "statusReasonInformation" : "DS02", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "ultimateCreditor" : { "name" : "myPreferredUltimateMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ]

"organisationId" : { "identification" : "85212678900025", "schemeName" : "SIRET", "issuer" : "FR" } }, "purpose" : "CASH", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "ACSC" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }

8.3.4.2. Response

Status code: 201

Headers

location: /v1/payment-requests/MyPmtInfRscId

Body

{

"appliedAuthenticationApproach" : "REDIRECT", "_links" : { "consentApproval" : { "href" : "https://psd2.aspsp/consent-approval" } } }

8.3.5. Cancellation Request Confirmation

8.3.5.1. Request

POST http://localhost:8080/v1/payment-requests/MyPmtInfRscId/confirmation 
 
No specific headers

Body

{ }

8.3.5.2. Response

Status code: 200 
 
No specific headers

Body

{

"paymentRequest" : { "resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:21.289+02:00", "numberOfTransactions" : 1, "initiatingParty" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" "paymentTypeInformation" : { "serviceLevel" : "SEPA", "categoryPurpose" : "DVPM" "debtor" : { "name" : "MyCustomer", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] "privateId" : { "identification" : "FD37G", "schemeName" : "BANK", "issuer" : "BICXYYTTZZZ"

"debtorAgent" : { "bicFi" : "BNKAFRPPXXX"

}, "beneficiary" : { "isTrusted" : true, "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "RJCT", "statusReasonInformation" : "DS02", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "ultimateCreditor" : { "name" : "myPreferredUltimateMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "85212678900025", "schemeName" : "SIRET", "issuer" : "FR" } },

"purpose" : "CASH", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "ACSC" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }, "_links" : { "request" : { "href" : "/v1/payment-requests/MyPmtInfRscId" } } }