YAyapily
Authorisations

Create Payment Authorisation

Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a payment. This endpoint is used to initiate all the different payment listed below. Based on the type of payment you wish to make, you may be required to provide specific properties in PaymentRequest. First make sure that the payment feature you wish to execute is supported by the bank by checking the features array in GET Institution.

Features:

  • INITIATE_DOMESTIC_PERIODIC_PAYMENT
  • INITIATE_DOMESTIC_SCHEDULED_PAYMENT
  • INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT
  • INITIATE_DOMESTIC_SINGLE_PAYMENT
  • INITIATE_INTERNATIONAL_PERIODIC_PAYMENT
  • INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT
  • INITIATE_INTERNATIONAL_SINGLE_PAYMENT
post/payment-auth-requests

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Headers

psu-idstring

Conditional. Represents the user's login ID for the Institution to a personal account.

See PSU identifiers to see if this header is required.

psu-corporate-idstring

Conditional. Represents the user's login ID for the Institution to a business account.

See PSU identifiers to see if this header is required.

psu-ip-addressstring

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

sub-applicationstring uuid

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

Request body

userUuidstring uuid
applicationUserIdstring

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.

forwardParametersstring[]

Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect.

institutionIdstring required

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

callbackstring

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

oneTimeTokenboolean

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 request

{
  "applicationUserId": "user-234562290",
  "institutionId": "yapily-mock",
  "callback": "https://display-parameters.com",
  "paymentRequest": {
    "paymentIdempotencyId": "04ab4536gaerfc0e1f93c4f4",
    "payer": {
      "name": "John Doe",
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "401016"
        }
      ],
      "address": {
        "country": "GB"
      }
    },
    "reference": "Bill payment",
    "payee": {
      "name": "Jane Doe",
      "accountIdentifications": [
        {
          "identification": "401016",
          "type": "SORT_CODE"
        },
        {
          "identification": "71518920",
          "type": "ACCOUNT_NUMBER"
        }
      ],
      "address": {
        "country": "GB"
      },
      "merchantId": "24589303",
      "merchantCategoryCode": "0742"
    },
    "periodicPayment": {
      "frequency": {
        "intervalWeek": 1,
        "intervalMonth": 1,
        "executionDay": 1
      },
      "numberOfPayments": 5,
      "nextPaymentDateTime": "2018-01-10T00:00:00Z",
      "nextPaymentAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "finalPaymentDateTime": "2030-01-10T00:00:00Z",
      "finalPaymentAmount": {
        "amount": 10,
        "currency": "GBP"
      }
    },
    "amount": {
      "amount": 10,
      "currency": "GBP"
    },
    "paymentDateTime": "2021-07-21T17:32:28Z"
  }
}

Response

Created

linksobject
tracingIdstring

Example response

{
  "data": {
    "charges": [
      {
        "chargeAmount": {
          "amount": 10,
          "currency": "GBP"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.