Creates a new payment

post

https://sepaexpress-prod-fx.azurewebsites.net/api/services/v2/Payments

Creates a new payment. The newly created resource can be referenced by the URI given by a Location header field in the response.

Body Params

mandateId

string

required

length between 32 and 32

The unique identifier of the mandate this payment object belongs to. Mandatory, unless a new mandate to create is given.

mandate

object

required

currencyCode

string

required

length between 3 and 3

The ISO 4217 currency code.

amount

int32

required

> 0

The amount to be collected from the customer's bank account. Specified in the smallest subunit of the used currency, e.g. cents for EUR.

reference

string

length between 0 and 16

The unique reference of this payment. This id is used for matching payments and refunds on the participating bank accounts. Length, format and content depend on the regulations defined by the determined payment scheme. Often called End2EndId in the SEPA scheme. Optional.

softDescriptor

string

length between 0 and 140

The soft descriptor for this payment. The text entered here will be printed on the bank statements of the participating bank accounts, if supported in the used payment scheme. Optional. SEPAexpress will generate a scheme compliant soft descriptor, if left empty.

submitAfter

date-time | null

Defines when this payment should be earliest submitted to the customer's bank account. Optional. Payments will be submitted as soon as possible, if not specified.

idempotencyKey

string

length between 0 and 32

The unique idempotency key of this entity creation. Optional, but highly recommended to use. When given, SEPAexpress checks whether an entity of this type with the specified idempotency key already exists, and fails the creation if a duplicate entity is found. The ID of the conflicting entity can be found in the error message.

memo

string

length between 0 and 255

Memo for free use by the PSP.

validationIban

string

length between 15 and 34

If provided, it will result in a validation error if the content does not match the corresponding IBAN of the stored mandate.

validationCustomerId

string

If provided, it will result in a validation error if the content does not match the corresponding id of the stored customer.

validationBankAccountId

string

If provided, it will result in a validation error if the content does not match the corresponding id of the stored bank account.

validationConnectorId

string

If provided, it will result in a validation error if the content does not match the corresponding id of the stored connector.

validationMerchantId

string

If provided, it will result in a validation error if the content does not match the corresponding id of the stored merchant.

approvalBy

string

Optional. Mark this payment as not yet approved by the customer. SEPAexpress will initiate the approval process. One of:

ais - Account Information Service mandate. The customer is redirected to his selected bank login and after successful authorization he gets redirected back to merchant site.

custom1

string

length between 0 and 100

Custom1 for free use by the PSP.

custom2

string

length between 0 and 100

Custom2 for free use by the PSP.

custom3

string

length between 0 and 100

Custom3 for free use by the PSP.

custom4

string

length between 0 and 100

Custom4 for free use by the PSP.

custom5

string

length between 0 and 100

Custom5 for free use by the PSP.

creditorIban

string

length between 15 and 34

If provided will the payment be settled to this creditor IBAN.

creditorBic

string

length between 8 and 11

If provided will the payment be settled to this creditor BIC.

Responses

201Created. The request has been fulfilled and resulted in a new resource being created.

400Bad Request. The request could not be understood by the server, usually due to malformed syntax.

401Unauthorized. The client did not provide a valid authentication HTTP header or the user making the request has been disabled.

403Forbidden. The client provided a valid authentication header, but does not have permission to access this resource.

409Conflict. The resource to be created by your request already exists.

422Unprocessable. The request was well-formed but could not be processed due to other reasons.

429Too many requests. A rate limit has been reached.