Create Payment Pre-authorisation

curl --request POST \
  --url https://api.yapily.com/payment-pre-auth-requests \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "applicationUserId": "string",
  "institutionId": "n26",
  "callback": "https://display-parameters.com/",
  "scope": "PIS",
  "reference": "Bill Payment",
  "amount": {
    "amount": 1,
    "currency": "EUR"
  },
  "payee": {
    "name": "Jane Doe",
    "country": "BE",
    "accountIdentifications": [
      {
        "type": "IBAN",
        "identification": "BE12345678901234"
      }
    ]
  },
  "payer": {
    "accountIdentifications": [
      {
        "type": "IBAN",
        "identification": "DE12345678901234567890"
      }
    ]
  }
}
'

{
  "meta": {
    "tracingId": "ba79c56773de42129dbf8164b202276c"
  },
  "data": {
    "id": "53ff00d0-91dd-417d-880b-cdd7c50090ed",
    "userUuid": "e2578545-27a4-4edf-983f-5d33c2d7b559",
    "applicationUserId": "string",
    "institutionId": "n26",
    "state": "4399535ee4de46238fce108a95669848",
    "status": "AWAITING_PRE_AUTHORIZATION",
    "createdAt": "2021-06-10T09:54:46.669Z",
    "featureScope": [
      "INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS"
    ],
    "authorisationUrl": "https://app.n26.com/open-banking?requestId=2e2b2efd-82bb-4a2b-8f67-ced1a93511b8&state=4399535ee4de46238fce108a95669848&authType=XS2A&scope=DEDICATED_PISP",
    "qrCodeUrl": "https://images.yapily.com/image/7384ad3b-5eb1-4304-9cfa-7aa6fcc5e0c7/1623318888?size=0"
  }
}

curl --request POST \
  --url https://api.yapily.com/payment-pre-auth-requests \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "applicationUserId": "string",
  "institutionId": "n26",
  "callback": "https://display-parameters.com/",
  "scope": "PIS",
  "reference": "Bill Payment",
  "amount": {
    "amount": 1,
    "currency": "EUR"
  },
  "payee": {
    "name": "Jane Doe",
    "country": "BE",
    "accountIdentifications": [
      {
        "type": "IBAN",
        "identification": "BE12345678901234"
      }
    ]
  },
  "payer": {
    "accountIdentifications": [
      {
        "type": "IBAN",
        "identification": "DE12345678901234567890"
      }
    ]
  }
}
'

{
  "meta": {
    "tracingId": "ba79c56773de42129dbf8164b202276c"
  },
  "data": {
    "id": "53ff00d0-91dd-417d-880b-cdd7c50090ed",
    "userUuid": "e2578545-27a4-4edf-983f-5d33c2d7b559",
    "applicationUserId": "string",
    "institutionId": "n26",
    "state": "4399535ee4de46238fce108a95669848",
    "status": "AWAITING_PRE_AUTHORIZATION",
    "createdAt": "2021-06-10T09:54:46.669Z",
    "featureScope": [
      "INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS"
    ],
    "authorisationUrl": "https://app.n26.com/open-banking?requestId=2e2b2efd-82bb-4a2b-8f67-ced1a93511b8&state=4399535ee4de46238fce108a95669848&authType=XS2A&scope=DEDICATED_PISP",
    "qrCodeUrl": "https://images.yapily.com/image/7384ad3b-5eb1-4304-9cfa-7aa6fcc5e0c7/1623318888?size=0"
  }
}

Learn more: Payment Pre-Authorisation

Authorizations

Authorization

string

header

required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

psu-ip-address

string

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

sub-application

string<uuid>

The sub-application ID to which event type is being subscribed to

Query Parameters

raw

boolean

Optional. Used to obtain the raw request and response to and from the Institution.

Body

application/json;charset=UTF-8

Mandatory. The payment pre authorisation request object defining the details of the payment and pre auth.

institutionId

string

required

Mandatory. The reference to the Institution which identifies which institution the authorisation request is sent to.

Example:

"yapily-mock"

scope

string

required

Mandatory. Defines the scope of the pre-authorisation request.

Example:

"AIS"

payee

object

required

Mandatory. Details of the beneficiary [person or business].

Show child attributes

payer

object

required

Conditional. Details of the benefactor [person or business].

Show child attributes

amount

Amount Details · object

required

Mandatory. Monetary Amount.

Show child attributes

reference

string

required

Mandatory. The payment reference or description. Limited to a maximum of 18 characters long.

Example:

"Bill payment"

userUuid

string<uuid>

applicationUserId

string

Conditional. The user-friendly reference to the User that will authorise the authorisation request. If a User with the specified applicationUserId exists, it will be used otherwise, a new User with the specified applicationUserId will be created and used. Either the userUuid or applicationUserId must be provided.

Example:

"user-234562290"

forwardParameters

string[]

Extra parameters to be forwarded in the redirect back to the client after the user authorisation flow has been completed.

callback

string

Optional. The server to redirect the user to after the user complete the authorisation at the Institution.

See Using a callback (Optional) for more information.

Example:

"https://display-parameters.com"

redirect

object

Optional. The server to redirect the user to after the user complete the authorisation at the Institution.

Show child attributes

oneTimeToken

boolean

Conditional. Used to receive a oneTimeToken rather than a consentToken at the callback for additional security. This can only be used when the callback is set.

See Using a callback with an OTT (Optional) for more information.

Example:

false

Response

Created

Getting Started

Authorisations

Financial Data

Payments

Consents

Institutions

Users

Notifications

Variable Recurring Payments

Data Plus

Hosted Consent Pages

Hosted Payment Pages

Constraints

Application Management

Webhooks

Application Beneficiaries

User Beneficiaries

Create Payment Pre-authorisation

Authorizations

Headers

Query Parameters

Body

Response