---
title: "HalPaymentRequest"
canonical: "https://openfinanceguide.com/en/stet/1.6.3/resources/hal-payment-request"
edition: "STET PSD2 API 1.6.3.1"
source: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.2-openapi.yaml"
pdf: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf"
language: "en"
normative: "The normative text is the English PDF and OpenAPI file published by STET. This Markdown reproduces it for reading; where they differ, the PDF prevails."
license: "CC BY 3.0 FR (https://creativecommons.org/licenses/by/3.0/fr/), STET. Converted to Markdown by Open Finance Guide."
---

# HalPaymentRequest

Type: `object` · Kind: Hal

HYPERMEDIA structure used for returning the original Payment Request to the PISP

Fields:

- `paymentRequest`, [`PaymentRequestResource`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/payment-request-resource.md), required
- `_links`, [`PaymentRequestLinks`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/payment-request-links.md), required

## Example

```json
{
  "paymentRequest": {
    "resourceId": "MyPmtInfRscId",
    "paymentInformationId": "MyPmtInfId",
    "creationDateTime": "2020-02-19T13:56:54.758+01: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",
      "localInstrument": "INST",
      "categoryPurpose": "CASH"
    },
    "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",
    "creditTransferTransaction": [
      {
        "paymentId": {
          "instructionId": "MyInstrId3",
          "endToEndId": "MyEndToEndId3"
        },
        "requestedExecutionDate": "2020-02-19T13:56:54.759+01:00",
        "instructedAmount": {
          "amount": 124.35,
          "currency": "EUR"
        },
        "beneficiary": {
          "creditor": {
            "name": "June Doe",
            "postalAddress": {
              "country": "FR",
              "addressLine": [
                "18 rue de la DSP2",
                "75008 PARIS"
              ]
            },
            "organisationId": {
              "identification": "12FR5",
              "schemeName": "COID",
              "issuer": "ACPR"
            },
            "privateId": {
              "identification": "852126789",
              "schemeName": "SIREN",
              "issuer": "FR"
            }
          },
          "creditorAccount": {
            "iban": "YY49QEZO90424459988701367845944910",
            "currency": "EUR"
          }
        },
        "ultimateCreditor": {
          "name": "myPreferredUltimateMerchant",
          "postalAddress": {
            "country": "FR",
            "addressLine": [
              "18 rue de la DSP2",
              "75008 PARIS"
            ]
          },
          "organisationId": {
            "identification": "85212678900025",
            "schemeName": "SIRET",
            "issuer": "FR"
          }
        },
        "purpose": "CASH",
        "remittanceInformation": {
          "unstructured": [
            "MyRemittanceInformation"
          ]
        },
        "transactionStatus": "PDNG"
      },
      {
        "paymentId": {
          "instructionId": "MyInstrId4",
          "endToEndId": "MyEndToEndId4"
        },
        "requestedExecutionDate": "2020-02-19T13:56:54.759+01:00",
        "instructedAmount": {
          "amount": 124.35,
          "currency": "EUR"
        },
        "beneficiary": {
          "creditor": {
            "name": "John Doe",
            "postalAddress": {
              "country": "FR",
              "addressLine": [
                "18 rue de la DSP2",
                "75008 PARIS"
              ]
            },
            "organisationId": {
              "identification": "12FR5",
              "schemeName": "COID",
              "issuer": "ACPR"
            },
            "privateId": {
              "identification": "852126789",
              "schemeName": "SIREN",
              "issuer": "FR"
            }
          },
          "creditorAccount": {
            "iban": "YY27KYHO61109079868328944728829436",
            "currency": "EUR"
          }
        },
        "ultimateCreditor": {
          "name": "myPreferredUltimateMerchant",
          "postalAddress": {
            "country": "FR",
            "addressLine": [
              "18 rue de la DSP2",
              "75008 PARIS"
            ]
          },
          "organisationId": {
            "identification": "85212678900025",
            "schemeName": "SIRET",
            "issuer": "FR"
          }
        },
        "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/MyPmtInfRscId"
    },
    "confirmation": {
      "href": "/v1/payment-requests/MyPmtInfRscId/confirmation"
    }
  }
}
```

## Used by

- `POST /payment-requests/{paymentRequestResourceId}/confirmation` (paymentRequestConfirmationPost)
- `GET /payment-requests/{paymentRequestResourceId}` (paymentRequestsGet)