Single Payments

Further reading on how to create single payments with Yapily.

Introduction

Single payments are payments which the user can configure from an Institution to pay an entity immediately. It is possible to create either domestic or international single payments provided that the Institution supports either of the following features in the feature array:

  • CREATE_DOMESTIC_SINGLE_PAYMENT
  • CREATE_INTERNATIONAL_SINGLE_PAYMENT

Domestic Single Payments

To create a single immediate payment, you need to provide the following details in the PaymentRequest object:

  • type (mandatory) - Specify the desired payment type
  • paymentIdempotencyId (mandatory) - Specify a unique identifier for the payment less than or equal to 35 alpha-numerical characters
  • amount (mandatory) - Specify the currency and amount to send
  • payee (mandatory) - Specify the payee.name, payee.accountIdentifications and the payee.address.country
  • reference (optional) - Specify a reference less than 18 characters to signpost the transaction for the Payer remittance identification
  • payer (conditional) - See use of payer details for more information

"paymentRequest": {
  "type": "DOMESTIC_PAYMENT",
  "paymentIdempotencyId": "4289457hd38djoa783jw9qag3",
  "amount": {
    "amount": "1.00",
    "currency": "GBP"
  },
  "payee": {
    "name": "Jane Doe",
    "address": {
      "country": "GB"
    },
    "accountIdentifications": [
      {
        "type": "SORT_CODE",
        "identification": "123456"
      },
      {
        "type": "ACCOUNT_NUMBER",
        "identification": "12345678"
      }
    ]
  },
  "reference": "Bill Payment",
}

International Single Payments

While rarely supported by every Institution, if the CREATE_INTERNATIONAL_SINGLE_PAYMENT feature is available, it is possible to make international single payments.

In addition to the properties required for a Domestic Single Payment, you must specify the additional properties required for an International Payment.

SEPA Payments

It is also possible to execute SEPA payments as domestic payments. To find out more, see the European Payments article.

For each Institution that is a SEPA member country, it is also possible that the Institution will allow consumers to make SEPA Instant payments for an additional cost that is passed on to the Payer in exchange for immediate execution and settlement.

To make use of this payment method, the Institution must support CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT in the features array. Provided that the feature is supported, you can specify DOMESTIC_INSTANT_PAYMENT as the paymentRequest.type to use SEPA Credit Instant for this Institution.

Note: Any additional fees are displayed to the payments service user no sooner than when they log into Institution to authorise the payment.

Use of Payer Details

UK

In the UK, it is optional whether you want to specify the Payer in the PaymentRequest. Doing so will force the user to make the payment from the specified account. As displayed below, the accountIdentifications object should contain the ACCOUNT_NUMBER and SORT_CODE:


"paymentRequest": {
  ...
  "payer": {
    "name": "John Doe",
    "accountIdentifications": [
      {
        "type": "ACCOUNT_NUMBER",
        "identification": "12345678"
      },
      {
        "type": "SORT_CODE",
        "identification": "123456"
      }
    ]
  }
}

Europe

In Europe, it is mandatory to specify the Payer in the PaymentRequest. This information can either be obtained by the first accessing the customers account information using AIS or alternatively requesting this from the user or providing the information if you already have access to their bank account information. As displayed below, the accountIdentifications object should just contain the IBAN:


"paymentRequest": {
  ...
  "payer": {
    "name": "John Doe",
    "accountIdentifications": [
      {
        "type": "IBAN",
        "identification": "DE12345678901234567890"
      }
    ]
  }
}