8.1. Payment Request with multiple instructions having different execution dates
8.1.1. Payment Request Submission
8.1.1.1. Request
POST http://localhost:8080/v1/payment-requests?ui_locales=
No specific headersBody
{
"paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:20.495+02:00", "numberOfTransactions" : 2,
"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" : "myMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY64COJH41059545330222956960771321" } }, "chargeBearer" : "SLEV", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId3", "endToEndId" : "MyEndToEndId3" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "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" : "COMC",
"remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] } }, { "paymentId" : { "instructionId" : "MyInstrId4", "endToEndId" : "MyEndToEndId4" }, "requestedExecutionDate" : "2019-11-08T00:00:00.000+01:00", "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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] } } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "scaHint" : "scaExemption", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }
8.1.1.2. Response
Status code: 201
Headers
location: /v1/payment-requests/MyPmtInfRscId
Body
{
"appliedAuthenticationApproach" : "REDIRECT", "_links" : { "consentApproval" : { "href" : "https://psd2.aspsp/consent-approval" } } }
8.1.2. Payment Request Retrieval
8.1.2.1. Request
GET http://localhost:8080/v1/payment-requests/MyPmtInfRscId
No specific headers
No body data8.1.2.2. Response
Status code: 200
No specific headersBody
{ "paymentRequest" : { "resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:20.495+02:00", "numberOfTransactions" : 2, "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" : "myMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY64COJH41059545330222956960771321" } }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PDNG", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId3", "endToEndId" : "MyEndToEndId3" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "PDNG" }, { "paymentId" : { "instructionId" : "MyInstrId4", "endToEndId" : "MyEndToEndId4" }, "requestedExecutionDate" : "2019-11-08T00:00:00.000+01:00", "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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "PDNG" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "scaHint" : "scaExemption", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure"
} }, "_links" : { "request" : { "href" : "/v1/payment-requests/MyPmtInfRscId" }, "confirmation" : { "href" : "/v1/payment-requests/MyPmtInfRscId/confirmation" } } }
8.1.3. Payment Request Confirmation
8.1.3.1. Request
POST http://localhost:8080/v1/payment-requests/MyPmtInfRscId/confirmation
No specific headers
Body
{ }8.1.3.2. Response
Status code: 200
No specific headersBody
{
"paymentRequest" : { "resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:20.495+02:00", "numberOfTransactions" : 2, "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" : "myMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY64COJH41059545330222956960771321" } }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PART", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId3", "endToEndId" : "MyEndToEndId3" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00",
"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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "ACSC" }, { "paymentId" : { "instructionId" : "MyInstrId4", "endToEndId" : "MyEndToEndId4" }, "requestedExecutionDate" : "2019-11-08T00:00:00.000+01:00", "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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "PDNG" } ],
"supplementaryData" : {
"acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "scaHint" : "scaExemption", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }, "_links" : { "request" : { "href" : "/v1/payment-requests/MyPmtInfRscId" } } }
8.1.4. Payment Request Cancellation
8.1.4.1. Request
PUT http://localhost:8080/v1/payment-requests/MyPmtInfRscId
No specific headersBody
{
"resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2019-10-08T10:35:20.495+02:00", "numberOfTransactions" : 2, "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" : "myMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY64COJH41059545330222956960771321" } }, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PART", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId3", "endToEndId" : "MyEndToEndId3" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00",
"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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "ACSC" }, { "paymentId" : { "instructionId" : "MyInstrId4", "endToEndId" : "MyEndToEndId4" }, "requestedExecutionDate" : "2019-11-08T00:00:00.000+01:00", "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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "RJCT", "statusReasonInformation" : "DS02"
} ],
"supplementaryData" : {
"acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT",
"scaHint" : "scaExemption",
"successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" }
}
8.1.4.2. Response
Status code: 201
Headers
location: /v1/payment-requests/MyPmtInfRscIdBody
{ "appliedAuthenticationApproach" : "REDIRECT", "_links" : { "consentApproval" : { "href" : "https://psd2.aspsp/consent-approval" } } }
8.1.5. Cancellation Request Confirmation
8.1.5.1. Request
POST http://localhost:8080/v1/payment-requests/MyPmtInfRscId/confirmation
No specific headersBody
{ }
8.1.5.2. Response
Status code: 200
No specific headersBody
{ "paymentRequest" : { "resourceId" : "MyPmtInfRscId", "paymentInformationId" : "MyPmtInfId",
"creationDateTime" : "2019-10-08T10:35:20.495+02:00",
"numberOfTransactions" : 2,
"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" : "myMerchant", "postalAddress" : { "country" : "FR", "addressLine" : [ "18 rue de la DSP2", "75008 PARIS" ] }, "organisationId" : { "identification" : "852126789", "schemeName" : "SIREN", "issuer" : "FR" } }, "creditorAccount" : { "iban" : "YY64COJH41059545330222956960771321"
}
}, "chargeBearer" : "SLEV", "paymentInformationStatus" : "PART", "creditTransferTransaction" : [ { "paymentId" : { "instructionId" : "MyInstrId3", "endToEndId" : "MyEndToEndId3" }, "requestedExecutionDate" : "2019-10-08T00:00:00.000+02:00", "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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "ACSC" }, { "paymentId" : { "instructionId" : "MyInstrId4", "endToEndId" : "MyEndToEndId4" }, "requestedExecutionDate" : "2019-11-08T00:00:00.000+01:00", "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" : "COMC", "remittanceInformation" : { "unstructured" : [ "MyRemittanceInformation" ] }, "transactionStatus" : "RJCT", "statusReasonInformation" : "DS02" } ], "supplementaryData" : { "acceptedAuthenticationApproach" : [ "REDIRECT", "DECOUPLED" ], "appliedAuthenticationApproach" : "REDIRECT", "scaHint" : "scaExemption", "successfulReportUrl" : "http://myPisp/PaymentSuccess", "unsuccessfulReportUrl" : "http://myPisp/PaymentFailure" } }, "_links" : { "request" : { "href" : "/v1/payment-requests/MyPmtInfRscId" } } }