7.3. Standing Orders Request
7.3.1. Payment Request Submission
7.3.2. Request
POST http://localhost:8080/v1/payment-requests
7.3.2.1. No specific Header
7.3.2.2. 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.
{
"paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2018-09-13T08:10:22.877+02:00", "numberOfTransactions" : 2, "initiatingParty" : {
"name" : "MyPreferedPisp", "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","purpose" : "CASH", "chargeBearer" : "SLEV", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2","requestedExecutionDate" : "2018-09-13T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "currency" : "EUR", "amount" : "124.35","remittanceInformation" : [ "MyRemittanceInformation" ] "supplementaryData" : {
"acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }7.3.3. Response
Status code: 201
7.3.3.1. Headers
location: v1/payment-requests/MyPmtInfRscId
7.3.3.2. Body
{
"appliedAuthenticationApproach": "REDIRECT",
"_links": {
"consentApproval": {
"href": "https://psd2.aspsp/consent-approval"
}
}
}7.3.4. Payment Request Retrieval
7.3.5. Request
GET http://localhost:8080/v1/payment-requests/MyPmtInfRscId
7.3.5.1. No specific Header
7.3.5.2. No body data
7.3.6. Response
Status code: 200
7.3.6.1. No specific Header
7.3.6.2. 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" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2018-09-13T08:10:22.877+02:00", "numberOfTransactions" : 2, "initiatingParty" : { "name" : "MyPreferedPisp", "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" } }, "purpose" : "CASH", "chargeBearer" : "SLEV", "paymentInformationStatus" : "PDNG", "fundsAvailability" : true, "booking" : false, "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2" },
"requestedExecutionDate" : "2018-09-13T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "currency" : "EUR", "amount" : "124.35" }, "remittanceInformation" : [ "MyRemittanceInformation" ], "transactionStatus" : "PDNG" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }, "_links" : { "self" : { "href" : "v1/payment-requests/MyPmtInfRscId" }, "confirmation" : { "href" : "v1/payment-requests/MyPmtInfRscId/confirmation" } } }7.3.7. Payment Request Confirmation
7.3.8. Request
POST http://localhost:8080/v1/payment-requests/MyPmtInfRscId/confirmation7.3.8.1. No specific Header
7.3.8.2. Body
{ }
7.3.9. Response
Status code: 200
7.3.9.1. No specific Header
7.3.9.2. Body
{
"paymentRequest": {
"resourceId": "MyPmtInfRscId",
"paymentInformationId": "MyPmtInfId",
"creationDateTime": "2018-09-13T08:10:22.877+02:00",
"numberOfTransactions": 2,
"initiatingParty": {
"name": "MyPreferedPisp",
"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"
}
},
"purpose": "CASH",
"chargeBearer": "SLEV",
"paymentInformationStatus": "PART",
"fundsAvailability": true,
"booking": false,
"creditTransferTransaction": [
{
"paymentId": {
"instructionId": "MyInstrId2",
"endToEndId": "MyEndToEndId2"
},
"requestedExecutionDate": "2018-09-13T00:00:00.000+02:00",
"executionRule": "FWNG",
"frequency": "MNTH",
"instructedAmount": {
"currency": "EUR",
"amount": "124.35"
},
"remittanceInformation": [
"MyRemittanceInformation"
],
"transactionStatus": "ACSC"
}
],
"supplementaryData": {
"acceptedAuthenticationApproach": [
"REDIRECT",
"DECOUPLED"
],
"appliedAuthenticationApproach": "REDIRECT",
"successfulReportUrl": "http://myPisp/PaymentSuccess",
"unsuccessfulReportUrl": "http://myPisp/PaymentFailure"
}
},
"_links": {
"self": {
"href": "v1/payment-requests/MyPmtInfRscId"
}
}
}7.3.10. Payment Request Cancellation
7.3.11. Request
PUT http://localhost:8080/v1/payment-requests/MyPmtInfRscId
7.3.11.1. No specific Header
7.3.11.2. 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.
{
"resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2018-09-13T08:10:22.877+02:00", "numberOfTransactions" : 2, "initiatingParty" : { "name" : "MyPreferedPisp", "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","purpose" : "CASH", "chargeBearer" : "SLEV", "paymentInformationStatus" : "RJCT", "statusReasonInformation" : "DS02", "fundsAvailability" : true, "booking" : false, "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId2", "endToEndId" : "MyEndToEndId2","requestedExecutionDate" : "2018-09-13T00:00:00.000+02:00", "executionRule" : "FWNG", "frequency" : "MNTH", "instructedAmount" : { "currency" : "EUR", "amount" : "124.35","remittanceInformation" : [ "MyRemittanceInformation" ], "transactionStatus" : "ACSC","supplementaryData" : {
"acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure"
}7.3.12. Response
Status code: 201
7.3.12.1. Headers
location: v1/payment-requests/MyPmtInfRscId
7.3.12.2. Body
{
"appliedAuthenticationApproach": "REDIRECT",
"_links": {
"consentApproval": {
"href": "https://psd2.aspsp/consent-approval"
}
}
}7.3.13. Cancellation Request Confirmation
7.3.14. Request
POST http://localhost:8080/v1/payment-requests/MyPmtInfRscId/confirmation7.3.14.1. No specific Header
7.3.14.2. Body
{ }
7.3.15. Response
Status code: 200
7.3.15.1. No specific Header
7.3.15.2. Body
{
"paymentRequest": {
"resourceId": "MyPmtInfRscId",
"paymentInformationId": "MyPmtInfId",
"creationDateTime": "2018-09-13T08:10:22.877+02:00",
"numberOfTransactions": 2,
"initiatingParty": {
"name": "MyPreferedPisp",
"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"
}
},
"purpose": "CASH",
"chargeBearer": "SLEV",
"paymentInformationStatus": "RJCT",
"statusReasonInformation": "DS02",
"fundsAvailability": true,
"booking": false,
"creditTransferTransaction": [
{
"paymentId": {
"instructionId": "MyInstrId2",
"endToEndId": "MyEndToEndId2"
},
"requestedExecutionDate": "2018-09-13T00:00:00.000+02:00",
"executionRule": "FWNG",
"frequency": "MNTH",
"instructedAmount": {
"currency": "EUR",
"amount": "124.35"
},
"remittanceInformation": [
"MyRemittanceInformation"
],
"transactionStatus": "ACSC"
}
],
"supplementaryData": {
"acceptedAuthenticationApproach": [
"REDIRECT",
"DECOUPLED"
],
"appliedAuthenticationApproach": "REDIRECT",
"successfulReportUrl": "http://myPisp/PaymentSuccess",
"unsuccessfulReportUrl": "http://myPisp/PaymentFailure"
}
},
"_links": {
"self": {
"href": "v1/payment-requests/MyPmtInfRscId"
}
}
}