Returns a specific hosted page

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

Returns a specific hosted page.

Path Params

string

required

Query Params

includeMerchant

boolean | null

Indicates whether the full merchant object should be included. Optional.

includeConnector

boolean | null

Indicates whether the full connector object should be included. Optional.

includeCustomer

boolean | null

Indicates whether the full customer object should be included. Optional.

includeBankAccount

boolean | null

Indicates whether the full bank account object should be included. Optional.

includeMandate

boolean | null

Indicates whether the full mandate object should be included. Optional.

includePayment

boolean | null

Indicates whether the full payment object should be included. Optional.

includeRequestToPay

boolean | null

Indicates whether the full RequestToPay object should be included.

includeRefund

boolean | null

Indicates whether the full refund object should be included. Optional.

includePayout

boolean | null

Indicates whether the full payout object should be included. Optional.

Responses

Response body

object

hostedPage

object

required

Parameters of a HostedPage object

string

required

length between 32 and 32

The unique identifier of this hosted page object.

merchantId

string

length between 32 and 32

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

merchant

object

Parameters of a merchant object

connectorId

string

length between 32 and 32

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

connector

object

Parameters of a connector object

customerId

string

length between 32 and 32

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

customer

object

Parameters of a customer object

bankAccountId

string

length between 32 and 32

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

bankAccount

object

Parameters of a bank account object

mandateId

string

length between 32 and 32

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

paymentId

string

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

requestToPayId

string

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

requestToPay

object

Parameters of a requestToPay object

createdAt

date-time

required

length ≥ 1

Fixed timestamp, recording when this hosted page object was created

state

string

length between 0 and 32

One of:

created - The hosted page is created and its id can be immediately used in subsequent calls to the API.
pending - The hosted page is currently displayed to the customer.
success - The hosted page workflow finished successfully.
failed - The hosted page workflow failed.

type

string

One of:

CreateMandate

cause

string

When the hosted page has failed this contains the cause for failure.

reasonCode

string

When the hosted page has failed this contains the reason code for failure.

trigger

string

When the hosted page has failed this contains the trigger for failure.

token

string

When the hosted page has failed this contains the token for failure.

memo

string

length between 0 and 255

Memo for free use by the PSP

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/HostedPages/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.