Create a new request to pay

post

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

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

Body Params

connectorId

string

The unique identifier of the connector this object belongs to. Optional. Mandatory if the associated merchant has more than one matching connector configured for the determined payment scheme.

bankAccountId

string

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

bankAccount

object

currencyCode

string

The ISO 4217 currency code.

amount

int32

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

reference

string

The unique reference of this requestToPay. This id is used for matching requestToPays and refunds on the participating bank accounts. Length, format and content are dependent on the regulations defined by the used requestToPay scheme. Often called End2EndId in the SEPA scheme.

softDescriptor

string

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

idempotencyKey

string

The unique idempotency key of this entity creation. Optional, but highly recommended to use. When given, SEPAexpress will check, whether an entity of this type with the given idempotency key does already exist, and will fail the creation, if a duplicate entity is found. The error message will contain the id of the conflicting entity.

memo

string

Memo for free use by the PSP

custom1

string

Custom1 for free use by the PSP.

custom2

string

Custom2 for free use by the PSP.

custom3

string

Custom3 for free use by the PSP.

custom4

string

Custom4 for free use by the PSP.

custom5

string

Custom5 for free use by the PSP.

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.

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