Payment initiation

POST

https://{EnvironmentURL}/public/core/customers/{customerId}/payments/initiate

customerId

uuid

Yes

Identifier of Customer, owner of the Account

requestedExecutionDate

datetime

No

YYYY-MM-DDTHH:MM:SS.NNNZ

paymentTypeInformation

object

Yes

paymentTypeInformation.paymentRails

string

Yes

Payment Rails for transfer

Allowed values:

• 'fps' for GBP Payments inside UK

• 'sepa' for EUR payments inside SEPA zone

paymentTypeInformation.paymentScheme

string

Yes

Payment Scheme if Payment Rails has multiple choice

Applicable only for case when paymentRail = 'sepa'

Allowed values:

• 'sepaNormal'

• 'sepaInstant' for for amounts < 100 000 EUR

Debtor information

debtor

object of type Party, see below

Yes

Sender of the Payment

debtorAccount

object

Yes

Account to send the Payment

debtorAccount.id

string,uuid

Yes

Identifier of Debtor Account

debtorAccount.baseCurrencyCode

string

Yes

Base currency of the Account.

Current possible values:

• usd

• gbp

• eur

debtorAccount.identification

object of type Account Identification, see below

Yes

Identification of Debtor Account

Credit transfer information

creditTransferTransactionInformation

object

Yes

CTTI

creditTransferTransactionInformation .paymentIdentification

object

Yes

Payment identification

paymentIdentification .endToEndIdentification

String

Yes

End-to-end transaction identification

creditTransferTransactionInformation.purpose

object

Yes

Purpose of the payment

purpose.paymentPurpose

string

Yes

Allowed values: See table below

purpose.unstructured

string

Yes

Must be filled if option "Other" is chosen in paymentPurpose

creditTransferTransactionInformation.amount

object

Yes

Amount to transfer

amount.currencyCode

string

Yes

Code of the Currency of the amount

Allowed values:

• eur

• gbp

amount.value

decimal

Yes

Value of the amount

Creditor information

creditTransferTransactionInformation .creditor

object of type Party, see below

Yes

Sender of the Payment

creditTransferTransactionInformation .creditorAccount

object

Yes

Account to send the Payment

creditorAccount.id

string,uuid

No

Identifier of Creditor Account, if applicable

creditorAccount.baseCurrencyCode

string

Yes

Base currency of the Account.

Current possible values:

• usd

• gbp

• eur

creditorAccount.identification

object of type Account Identification, see below

Yes

Identification of Creditor Account

creditTransferTransactionInformation .remittanceInformation

object

Yes

Remittance of the Payment

remittanceInformation.structured

object

Yes

Type of remittance

structured .creditorReferenceInformation

object

Yes

Reference Information of the Payment

creditorReferenceInformation.reference

string

Yes

35 chars String

name

string

Yes

Name of the Party

legalType

string

Yes

Type of the Party, PRIVATE or BUSINESS

address

object of type Location

Yes

Address of the Party as Location object

identification

object

Yes

Identification of the Party

identification.organisationIdentification

object

Yes

Identification for case when Party is a Business Client

identification.organisationIdentification.other

object

Yes

Type of identification

identification.organisationIdentification.other.id

string,uuid

Yes

Identifier of the Organisation entity. Optional. Only for case where is no privateIdentification

identification.privateIdentification

object

Yes

Identification for case when Party is an Individual client

identification.privateIdentification.other

object

Yes

Type of identification

identification.privateIdentification.other.id

string,uuid

Yes

Identifier of the Person entity. Optional. Only for case where is no organisationIdentification

country

string

Yes

ISO 2-letters Code of the country

state

string

No

State for Countries where applicable

city

string

Yes

City name

street

string

Yes

Street name

building

string

Yes

Building name/number

postCode

string

Yes

Postcode

id

uuid

Yes

type

string

Yes

for type = 'iban'

iban

string

Yes

for type = 'sortcode'

accountNumber

string

Yes

sortCode

string

Yes

iban

string

No

bban

string

No

migrantTransfers

Outflows on account of migrant transfers including personal effects

remittanceForFamily

Remittance for family maintenance and savings

remittanceTowardsPersonal

Remittance towards personal gifts and donations

education

Education (e.g. fees for correspondence courses abroad)

healthService

Health Service (payment towards services received from hospitals, doctors, nurses, paramedical and similar services etc. rendered remotely or on-site)

businessTravel

Business travel

travelForPilgrimage

Travel for Pilgrimage

travelForMedicalTreatment

Travel for medical treatment

travelForEducation

Travel for education (including fees, hostel expenses etc.)

otherTravel

Other travel (including holiday trips and payments for settling international credit cards transactions)

other

Any other reasons