Create a payment

This endpoint is intended to create a new payment.

Prerequisites:

To use this endpoint you need to have the PAYMENT_CREATE scope for the API Key. Please contact your relation manager to get this permission.

Request Parameters:

Beneficiary Object is represented as Contact Object.

• beneficiary.type : specifies the type of beneficiary and can be either "legal_entity" or "person"
• beneficiary.country : indicates the two-letter ISO country code of the beneficiary's country (e.g., "CH" for Switzerland)
• either bankAccount.iban or bankAccount.accountNumber is mandatory

Payment signoff

• Default: payments created with API are not signed off, they must be signed off in amnis Web App before being processed
• PEER: payments created with API to an IBAN of current amnis customers are automatically signed and immediately processed as PEER payment. Learn more here about amnis PEER.

application/json

Request Body required

• amount stringnull required
• executionDate stringnull

  If left empty, the next possible execution date will be selected automatically

• reference stringnull required

  Possible values: >= 3 characters and <= 140 characters

  This text will be seen by the beneficiary

• feeSchedule string

  Possible values: <= 4 characters, [DEBT, SHAR, CRED]

  For LOCAL payments leave it empty, for SWIFT payments provide a value

• beneficiary object

  The beneficiary field is required, except for payments to IBANs linked to existing amnis customers.

  anyOf

  • MOD1

  ---

  name string

  address string

  city string

  zip string

  country string

  type string

bankAccount object required

anyOf

• MOD1

---

iban string

accountNumber string

swift string

currency string

country string

additionalFields object[] nullable

Array [

name string

value string

]

externalId stringnull

This should be a unique ID used to identify this payment in your system.