v1

latestSwagger 2.02026-07-14129254.9 KB

Cross border Payments Consent

Request consent initiation via redirect

post/payments/cross-border-credit-transfers/consents

Request body

Example request

{
  "payments": {
    "creditorAccount": {
      "identification": "PL06884573292356737845125375",
      "schemeName": "IBAN"
    },
    "creditorAddress": {
      "buildingNumber": "15",
      "city": "City",
      "country": "AA",
      "countrySubDivision": "SubDivision",
      "postalCode": "POSTCODE",
      "street": "Street"
    },
    "creditorAgent": {
      "identification": "BARCGB22XXX",
      "schemeName": "BIC"
    },
    "creditorName": "Wood bank",
    "debtorAccount": {
      "identification": "PL06884573292356737845125375",
      "schemeName": "IBAN"
    },
    "debtorAddress": {
      "buildingNumber": "15",
      "city": "City",
      "country": "CC",
      "countrySubDivision": "Division",
      "postalCode": "PostCode",
      "street": "Street"
    },
    "debtorName": "NordPole PLC",
    "endToEndIdentification": "Notification",
    "instructedAmount": {
      "amount": 100.23,
      "currency": "GBP"
    },
    "instructionPriority": "Normal",
    "localInstrument": "Swift",
    "remittanceInformationReference": "UniqueRef1",
    "remittanceInformationUnstructured": "Payment for fruits"
  },
  "requestInfo": {
    "aspspId": "420e5cff-0e2a-4156-991a-f6eeef0478cf",
    "merchant": {
      "id": "MerchantId",
      "name": "MerchantName"
    },
    "tppRedirectURI": "https://tpp-ob.com/callback",
    "xRequestId": "123e4567-e89b-12d3-a456-426655440000"
  }
}

Response

Success

aspspSCAApproach'REDIRECT'

consentRequestIdstring

Example response

{
  "_links": {
    "scaRedirect": "https://bank1.com/sca/login"
  },
  "originalRequestInfo": {
    "xRequestId": "444e4567-e55b-12d3-a456-426655448888"
  }
}