8.3. Solicitação de ordens permanentes

8.3.1. Envio da solicitação de pagamento

8.3.1.1. Requisição

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

content-length: 1704 Body

{

"paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2021-11-16T15:30:01.525498+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" : "2021-11-16T14:30:01.52555Z", "standingOrderCharacteristics" : { "startDate" : "2021-11-16T14:30:01.52555Z", "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. Resposta

Status code: 201 Headers
X-Request-Id: dc64f71e-82e3-4e0a-93ae-c9b84ac52a10 location: /v1/payment-requests/payment-request_rsc2651
Keep-Alive: timeout=60
Connection: keep-alive

8.3.1.3. Corpo

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

8.3.2. Recuperação da solicitação de pagamento

8.3.2.1. Requisição

GET http://localhost:18080/v1/payment-requests/payment-request_rsc2651 No specific headers 
 
No body data

8.3.2.2. Resposta

Status code: 200 Headers
X-Request-Id: b270d8fd-5295-4d7e-be0a-734cfeb8ea06
Keep-Alive: timeout=60
Connection: keep-alive

8.3.2.3. Corpo

{
  "paymentRequest": {
    "resourceId": "payment-request_rsc2651",
    "paymentInformationId": "MyPmtInfId",
    "creationDateTime": "2021-11-16T14:30:01.525498Z",
    "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_rsc2652",
        "requestedExecutionDate": "2021-11-16T14:30:01.52555Z",
        "standingOrderCharacteristics": {
          "startDate": "2021-11-16T14:30:01.52555Z",
          "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",
      "nextStatusRequestHint": "2021-11-16T15:35:01.559969+01:00"
    }
  },
  "_links": {
    "request": {
      "href": "/v1/payment-requests/payment-request_rsc2651"
    },
    "confirmation": {
      "href": "/v1/payment-requests/payment-request_rsc2651/confirmation"
    }
  }
}

8.3.3. Confirmação da solicitação de pagamento

8.3.3.1. Requisição

POST http://localhost:18080/v1/payment-requests/payment-request_rsc2651/confirmation Headers 
 
content-length: 22 Body 
 
{ "nonce" : "Nonce56fdd" 
 
}

8.3.3.2. Resposta

Status code: 200 Headers
X-Request-Id: 44c6e5cd-7e8f-4bca-b7a7-b0f73659e5c1
Keep-Alive: timeout=60
Connection: keep-alive

8.3.3.3. Corpo

Nota: este corpo foi extraído de um PDF que perdeu alguns separadores estruturais (chaves / vírgulas). Consulte o PDF de origem para ver o JSON canônico.

{ "paymentRequest" : { 
 
"resourceId" : "payment-request_rsc2651", "paymentInformationId" : "MyPmtInfId", 
 
"creationDateTime" : "2021-11-16T14:30:01.525498Z", "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_rsc2652", "requestedExecutionDate" : "2021-11-16T14:30:01.52555Z", "standingOrderCharacteristics" : { "startDate" : "2021-11-16T14:30:01.52555Z", "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", "nextStatusRequestHint" : "2021-11-16T15:35:01.573904+01:00" } }, "_links" : { "request" : { "href" : "/v1/payment-requests/payment-request_rsc2651" } } }

8.3.4. Cancelamento da solicitação de pagamento

8.3.4.1. Requisição

PUT http://localhost:18080/v1/payment-requests/payment-request_rsc2651 Headers 
 
content-length: 2062 Body 
 
{ "resourceId" : "payment-request_rsc2651", "paymentInformationId" : "MyPmtInfId", "creationDateTime" : "2021-11-16T14:30:01.525498Z", "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_rsc2652", "requestedExecutionDate" : "2021-11-16T14:30:01.52555Z", "standingOrderCharacteristics" : { "startDate" : "2021-11-16T14:30:01.52555Z", "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", "nextStatusRequestHint" : "2021-11-16T15:35:01.587096+01:00" } }

8.3.4.2. Resposta

Status code: 200 Headers
X-Request-Id: bc41bafd-c8d3-41e8-951a-eb5df179b6e1
Keep-Alive: timeout=60
Connection: keep-alive

8.3.4.3. Corpo

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