ofOpen Finance Guide

Traducción no oficial, realizada por Open Finance Guide a partir de la especificación en inglés publicada por STET. STET no la ha revisado ni aprobado, y solo el texto original es el de referencia.

Leer el original en inglés

8.3. Solicitud de órdenes permanentes

8.3.1. Envío de la solicitud de pago

8.3.1.1. Solicitud

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

Cabeceras

content-length: 1704

Cuerpo

{
  "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. Respuesta

Código de estado: 201

Cabeceras

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. Cuerpo

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

8.3.2. Recuperación de la solicitud de pago

8.3.2.1. Solicitud

GET http://localhost:18080/v1/payment-requests/payment-request_rsc2651

Sin cabeceras específicas

Sin datos de cuerpo

8.3.2.2. Respuesta

Código de estado: 200

Cabeceras

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

8.3.2.3. Cuerpo

{
  "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. Confirmación de la solicitud de pago

8.3.3.1. Solicitud

POST http://localhost:18080/v1/payment-requests/payment-request_rsc2651/confirmation

Cabeceras

content-length: 22

Cuerpo

{
  "nonce": "Nonce56fdd"
}

8.3.3.2. Respuesta

Código de estado: 200

Cabeceras

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

8.3.3.3. Cuerpo

{
  "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. Cancelación de la solicitud de pago

8.3.4.1. Solicitud

PUT http://localhost:18080/v1/payment-requests/payment-request_rsc2651

Cabeceras

content-length: 2062

Cuerpo

{
  "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. Respuesta

Código de estado: 200

Cabeceras

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

8.3.4.3. Cuerpo

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