Returns a specific payment

get https://sepaexpress-prod-fx.azurewebsites.net/api/services/v2/Payments/{id}

Returns a specific payment.

Responses

Response body

object

payment

object

required

Parameters of a payment object

string

required

length between 32 and 32

The unique identifier of this payment object.

merchantId

string

required

length between 32 and 32

The unique identifier of the merchant this payment object belongs to.

merchant

object

Parameters of a merchant object

connectorId

string

required

length between 32 and 32

The unique identifier of the connector this payment object belongs to.

connector

object

Parameters of a connector object

customerId

string

required

length between 32 and 32

The unique identifier of the customer this payment object belongs to.

customer

object

Parameters of a customer object

bankAccountId

string

required

length between 32 and 32

The unique identifier of the bank account this payment object belongs to.

bankAccount

object

Parameters of a bank account object

mandateId

string

required

length between 32 and 32

The unique identifier of the mandate this payment object belongs to.

createdAt

date-time

required

length ≥ 1

Fixed timestamp, recording when this payment object was created

state

string

length between 0 and 32

One of:

created - The payment is created and its id can be immediately used in subsequent calls to the API. The execution
of dependent subsequent calls will get postponed until this payment object gets paid.
pendingApproval - The payment requires the approval by the customer.
pendingReview - The review of the payment by the merchant is pending. Only applicable if the associated connector
defines paymentsNeedReview as true.
pendingSubmission - The payment has not yet been submitted toward the customer's bank.
submitted - The payment has been submitted toward the customer's bank, but the processing has not been finished
yet.
paid - The payment has been successfully collected from the customer.
failed - The payment could not be set up.
discarded - The payment has been discarded.
chargedBack - The payment has been charged back by the customer’s bank.

currencyCode

string

length between 3 and 3

The ISO 4217 currency code.

amount

int32

required

> 0

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

length between 0 and 35

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

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.

refundCount

int32 | null

The number of requested refunds for this payment.

refundAmount

int32 | null

The amount of all requested refunds for this payment.
Specified in the smallest subunit of the used currency, e.g.
cents for EUR.

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, when not specified.

paymentPreNotificationUrl

string

length between 0 and 255

The URL of the generated payment pre notification. This field is only filled, when the
payment pre notification generation feature is enabled in the merchant connector.

idempotencyKey

string

length between 0 and 32

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

length between 0 and 255

Memo for free use by the PSP

validationIban

string

If provided, it will result in an validation error if the content is different to the corresponding iban from the stored mandate.

validationCustomerId

string

If provided, it will result in an validation error if the content is different to the corresponding id from the stored customer.

validationBankAccountId

string

If provided, it will result in an validation error if the content is different to the corresponding id from the stored bank account.

validationConnectorId

string

If provided, it will result in an validation error if the content is different to the corresponding id from the stored connector.

validationMerchantId

string

If provided, it will result in an validation error if the content is different to the corresponding id from 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 payment is approved by using a PSD2 AIS account check via the internet
banking of the customer's bank.

approvalDate

date-time | null

ApprovalDate is an optional field that indicates when the payment was signed.

hostedPageId

string

The unique identifier of the hosted page this payment object belongs to.

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.

creditorIban

string

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

creditorBic

string

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

internalNote

string

Field for internal free use by SPX

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sepaexpress-prod-fx.azurewebsites.net/api/services/v2/Payments/id \
3
     --header 'accept: application/json'

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

application/json

200Ok. Standard response for successful HTTP requests.

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.

404Not Found. The requested resource was not found.

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