ofOpen Finance Guide
GlossaireSTETBlogContact

8.3. Standing Orders Request

8.3.1. Payment Request Submission

8.3.1.1. Request

POST http://localhost:18080/v1/payment-requests?ui_locales=

Headers

content-length: 1705

Body

{

"paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2020-10-26T08:55:44.39803+01: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" "chargeBearer" : "SLEV",

"creditTransferTransaction" : [ {

"paymentId" : {

"instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "requestedExecutionDate" : "2020-10-26T07:55:44.398067Z", "standingOrderCharacteristics" : { "startDate" : "2020-10-26T07:55:44.398067Z", "executionRule" : "FWNG", "frequency" : "MNTH" }, "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "beneficiary" : { "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } }, "ultimateCreditor" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "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

X-Request-Id: 8dbee9c0-8063-4100-b310-9cfb85fef436 location: /v1/payment-requests/payment-request_rsc2397 Keep-Alive: timeout=60 Connection: keep-alive

8.3.1.3. 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:18080/v1/payment-requests/payment-request_rsc2397 
 
No specific headers 
 
No body data
8.3.2.2. Response
Status code: 200 
 
Headers
X-Request-Id: ad7137f0-81b8-42d3-b8d5-7522ae9b97b4
Keep-Alive: timeout=60
Connection: keep-alive
8.3.2.3. Body

Note: this body was extracted from a PDF that lost some structural separators (braces / commas). Refer to the source PDF for the canonical JSON.

{ 
 
"paymentRequest" : { 
 
"resourceId" : "payment-request_rsc2397", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2020-10-26T07:55:44.39803Z", "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" }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PDNG", "fundsAvailability" : true, "booking" : false, "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "resourceId" : "transaction_rsc2398", "requestedExecutionDate" : "2020-10-26T07:55:44.398067Z", "standingOrderCharacteristics" : { "startDate" : "2020-10-26T07:55:44.398067Z", "executionRule" : "FWNG", "frequency" : "MNTH" }, "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "beneficiary" : { "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } 
 
}, "ultimateCreditor" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "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/payment-request_rsc2397" }, "confirmation" : { "href" : "/v1/payment-requests/payment-request_rsc2397/confirmation" } } }

8.3.3. Payment Request Confirmation

8.3.3.1. Request
POST http://localhost:18080/v1/payment-requests/payment-request_rsc2397/confirmation

Headers

content-length: 22

Body

{

"nonce" : "Nonce56fdd"

}

8.3.3.2. Response
Status code: 200 
 
Headers
X-Request-Id: 4696cb4e-1857-4ebf-8dbc-11149af86bfd
Keep-Alive: timeout=60
Connection: keep-alive
8.3.3.3. Body

Note: this body was extracted from a PDF that lost some structural separators (braces / commas). Refer to the source PDF for the canonical JSON.

{ 
 
"paymentRequest" : { 
 
"resourceId" : "payment-request_rsc2397", 
 
"paymentInformationId" : "MyPmtInfId", 
 
"creationDateTime" : "2020-10-26T07:55:44.39803Z", 
 
"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" }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PART", "fundsAvailability" : true, "booking" : false, "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" }, "resourceId" : "transaction_rsc2398", "requestedExecutionDate" : "2020-10-26T07:55:44.398067Z", "standingOrderCharacteristics" : { "startDate" : "2020-10-26T07:55:44.398067Z", "executionRule" : "FWNG", "frequency" : "MNTH" }, "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "beneficiary" : { "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", 
 
"schemeName" : "COID", "issuer" : "ACPR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } }, "ultimateCreditor" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "purpose" : "CASH", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "ACSC" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "appliedAuthentication" : "strongAuthentication", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }, "_links" : { "request" : { "href" : "/v1/payment-requests/payment-request_rsc2397" } } }

8.3.4. Payment Request Cancellation

8.3.4.1. Request
PUT http://localhost:18080/v1/payment-requests/payment-request_rsc2397

Headers

content-length: 2004

Body

{

"resourceId" : "payment-request_rsc2397", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2020-10-26T07:55:44.39803Z", "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"

},

"chargeBearer" : "SLEV",

"paymentInformationStatus" : "CANC",

"fundsAvailability" : true,

"booking" : false,

"creditTransferTransaction" : [ {

"paymentId" : {

"instructionId" : "MyInstrId2",

"endToEndId" : "MyEndToEndId2" }, "resourceId" : "transaction_rsc2398", "requestedExecutionDate" : "2020-10-26T07:55:44.398067Z", "standingOrderCharacteristics" : { "startDate" : "2020-10-26T07:55:44.398067Z", "executionRule" : "FWNG", "frequency" : "MNTH" }, "instructedAmount" : { "amount" : 124.35, "currency" : "EUR" }, "beneficiary" : { "creditor" : { "name" : "Erwin Ghost", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" } }, "creditorAccount" : { "iban" : "YY98JHCL48922452970525461479908705" } }, "ultimateCreditor" : { "name" : "MyPreferredPisp", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "12FR5", "schemeName" : "COID", "issuer" : "ACPR" }

"purpose" : "CASH",

"remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] "transactionStatus" : "ACSC"

"supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "appliedAuthentication" : "strongAuthentication", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure"

}

8.3.4.2. Response

Status code: 200

Headers

X-Request-Id: 59c4165d-bf90-4b17-b78a-cd2325f1b48b Keep-Alive: timeout=60 Connection: keep-alive

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