Payment execution

Further reading on generating the Payment Request sent to the Yapily API.

Introduction

In both the payment authorisation and payment request, you will have to generate the paymentRequest payload which defines to who, from where, how much and how to execute the payment. As Yapily is a platform that allows for multiple types of payments to be executed in and across different countries, the following supplementary information will give more guidance on what options are available.

Payment Types

The following table shows the different payment types that are currently available in Yapily. The associated features column shows the features that will be created in the payment consent after you execute Create Payment Authorisation and specify one of the payment types.

To create bulk payments, there is no bulk payment type. Instead you use Create Bulk Payment Authorisation which will take an array of paymentRequest where the payment type will be defined per payment.

Payment Type	Description	Associated Features
`DOMESTIC_INSTANT_PAYMENT`	Initiate and create domestic single instant payments. The `DOMESTIC_INSTANT_PAYMENT` payment type is used to indicate that when sending funds to another account from a participating SEPA country and when the payment is in Euros, SEPA Instant in addition to SEPA is also a viable configuration for the payment. See SEPA Payments for more information.	`INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT` `CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT` `EXISTING_PAYMENT_DETAILS`
`DOMESTIC_PAYMENT`	Initiate and create domestic single payments. Particular payments between accounts from SEPA member countries can be considered a `DOMESTIC_PAYMENT` payment when the payment is in Euros. In these scenarios, funds will be transferred via. SEPA. See Domestic Single Payments for more information.	`INITIATE_DOMESTIC_SINGLE_PAYMENT` `CREATE_DOMESTIC_SINGLE_PAYMENT` `EXISTING_PAYMENT_DETAILS`
`DOMESTIC_PERIODIC_PAYMENT`	Initiate and create domestic periodic payments. They are known as standing orders in UK. See Domestic Periodic Payments for more information.	`INITIATE_DOMESTIC_PERIODIC_PAYMENT` `CREATE_DOMESTIC_PERIODIC_PAYMENT` `EXISTING_PAYMENT_DETAILS`
`DOMESTIC_SCHEDULED_PAYMENT`	Initiate and create domestic scheduled payments. See Domestic Scheduled Payments for more information.	`INITIATE_DOMESTIC_SCHEDULED_PAYMENT` `CREATE_DOMESTIC_SCHEDULED_PAYMENT` `EXISTING_PAYMENT_DETAILS`
`INTERNATIONAL_PAYMENT`	Initiate and create international single payments. See International Single Payments for more information.	`INITIATE_INTERNATIONAL_SINGLE_PAYMENT` `CREATE_INTERNATIONAL_SINGLE_PAYMENT` `EXISTING_PAYMENT_DETAILS`
`INTERNATIONAL_PERIODIC_PAYMENT`	Initiate and create international periodic payments. See International Periodic Payments for more information.	`INITIATE_INTERNATIONAL_PERIODIC_PAYMENT` `CREATE_INTERNATIONAL_PERIODIC_PAYMENT` `EXISTING_PAYMENT_DETAILS`
`INTERNATIONAL_SCHEDULED_PAYMENT`	Initiate and create international scheduled payments. See International Scheduled Payments for more information.	`INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT` `CREATE_INTERNATIONAL_SCHEDULED_PAYMENT` `EXISTING_PAYMENT_DETAILS`

Account Identifications

When making a Payment, it is necessary to provide details of the Payee account (the account that you would like the payment to be sent to) as well as the Payer account (the account that you would like to make the payment from) when sending payments from a European bank account. This is done by using the nested AccountIdentification object in the PaymentRequest.

Type	Description	Format
`SORT_CODE`	Used only in the UK in conjunction with `ACCOUNT_NUMBER` to uniquely identify account	6 numerical characters
`ACCOUNT_NUMBER`	Used only in the UK in conjunction with `SORT_CODE` to uniquely identify account	8 numerical characters
`IBAN`	National standard for uniquely identifying bank accounts	See IBAN Formats by countries
`BBAN`	The Basic Bank Account Number. This forms the first part of the IBAN after the first 4 characters	See IBAN Formats by countries
`BIC`	Business Identifier Codes otherwise known as SWIFT Code	No specific format
`PAN`	-	-
`MASKED_PAN`	-	-
`MSISDN`	-	-
`BSB`	-	-
`NCC`	-	-
`ABA`	-	-
`ABA_WIRE`	-	-
`ABA_ACH`	-	-
`EMAIL`	Email address	-

Account Identifications Combinations

The following tables show which account identifications are required for different scenarios for domestic and international payments.

Domestic Payments

Payer Country	Payee Country	Currency	Payee Account Identification
UK	UK	GBP	`ACCOUNT_NUMBER` + `SORT_CODE`
Any SEPA	Any SEPA	EUR	`IBAN`

International Payments

Payer Country	Payee Country	Currency	Payee Account Identification
Any	All EU and EEA countries: Albania, Austria, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Guernsey, Hungary, Iceland, Republic of Ireland, Italy, Jersey, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, The Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain and Sweden	Any	`BBAN` / `IBAN` + `BIC`