Payment Initiation

POST

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

customerId

uuid

Yes

Identifier of the Customer, owner of the Account

debtorAccountId

uuid

Yes

Identifier of the Account

payeeContactId

uuid

Yes

Identifier of stored Beneficiary Contact

paymentRails

string

Yes

Payment Rails for transfer

Allowed values:

• 'fps' for GBP Payments inside UK

• 'sepa' for EUR payments inside SEPA zone

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

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

paymentPurpose

string

No

Allowed values: See table below

paymentPurposeText

string

No

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

reference

string

Yes

Reference of the Payment

requestedExecutionDate

datetime

No

YYYY-MM-DDTHH:MM:SS.NNNZ

endToEndTransactionId

string

No

Transaction Id from the side of the Remitter

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