Payment initiation.
POST/api/v1/transactions/:payment-service/:payment-product
This method is used to initiate a payment at the ASPSP.
Variants of payment initiation requests
This method to initiate a payment initiation at the ASPSP can be sent with either a JSON body or an pain.001 body depending on the payment product in the path.
- There are the following payment products:
- sepa-credit-transfers
Furthermore the request body depends on the payment-service:
- payments: A single payment initiation request.
This is the first step in the API to initiate the related recurring/periodic payment.
Request
Path Parameters
Possible values: [payments]
Payment service.
Possible values: [sepa-credit-transfers]
The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The ASPSP will publish which of the payment products/endpoints will be supported.
Header Parameters
ID of the request, unique to the call, as determined by the initiating party.
This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
Is contained if and only if the Signature element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation.
Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP’s documentation.
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Might be mandated in the ASPSP's documentation. Only used in a corporate context.
Possible values: Value must match regular expression \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
If it equals true, the TPP prefers a redirect over an embedded SCA approach. If it equals "false", the TPP prefers not to be redirected for SCA. The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the parameter TPP-Decoupled-Preferred and the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
URI of the TPP, where the transaction flow shall be redirected to after a Redirect.
Mandated for the Redirect SCA Approach, specifically when TPP-Redirect-Preferred equals "true". It is recommended to always use this header field.
If it equals "true", the TPP prefers a decoupled SCA approach. If it equals "false", the TPP prefers not to use the decoupled approach for SCA. The ASPSP will then choose between the embedded or the redirect SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the parameter TPP-Redirect-Preferred and the SCA method chosen by the TPP/PSU The parameter might be ignored by the ASPSP. If both parameters TPP-Redirect-Preferred and TPP-Decoupled-Preferred are present and true, the request is still not rejected, but it is up to the ASPSP, which approach will actually be used.
Remark for Future: TPP-Redirect-Preferred and TPP-Decoupled-Preferred will be revised in future versions, maybe merged. Currently kept separate for downward compatibility.
If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
If it equals "true", the TPP prefers to start the authorization process separately, e.g. because of the usage of a signing basket. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality.
If it equals "false" or if the parameter is not used, there is no preference of the TPP. his especially indicates that the TPP assumes a direct authorisation of the transaction in the next step, without using a signing basket.
If it equals "true" then the TPP prefers a rejection of the payment initiation in case the ASPSP is providing an integrated confirmation of funds request an the result of this is that not sufficient funds are available.
If it equals "false" then the TPP prefers that the ASPSP is dealing with the payment initiation like in the ASPSPs online channel, potentially waiting for a certain time period for funds to arrive to initiate the payment.
This parameter might be ignored by the ASPSP.
This header might be used by TPPs to inform the ASPSP about the brand used by the TPP towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and TPP. This header might be ignored by the ASPSP.
URI for the Endpoint of the TPP-API to which the status of the payment initiation should be sent. This header field may by ignored by the ASPSP. For security reasons, it shall be ensured that the TPP-Notification-URI as introduced above is secured by the TPP eIDAS QWAC used for identification of the TPP.
The following applies: URIs which are provided by TPPs in TPP-Notification-URI shall comply with the domain secured by the eIDAS QWAC certificate of the TPP in the field CN or SubjectAltName of the certificate. Please note that in case of example-TPP.com as certificate entry TPP- Notification-URI like www.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction-id/notifications or notifications.example-TPP.com/xs2a-client/v1/ASPSPidentifcation/mytransaction-id/notifications would be compliant.
Wildcard definitions shall be taken into account for compliance checks by the ASPSP. ASPSPs may respond with ASPSP-Notification-Support set to false, if the provided URIs do not comply.
The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated.
The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the TPP. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the TPP. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the TPP.
This header field may be ignored, if the ASPSP does not support resource notification services for the related TPP.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
Possible values: [GET, POST, PUT, PATCH, DELETE]
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
- application/json
Body
JSON request body for a payment initiation request message.
- InitiatePaymentRequestBody
-
IBAN, of a payment accounts, or
-
BBAN, for payment accounts if there is no IBAN, or
-
Not used by SDC the Primary Account Number(PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
-
Not used by SDC the Primary Account Number(PAN) of a card in a masked form, or
-
Not used by SDC an alias to access a payment account via a registered mobile phone number(MSISDN).
-
A payment account AccountReferenceOther when using a national payment Form.
- 1056
- 5768.2
- -1.50
- 5877.78
-
IBAN, of a payment accounts, or
-
BBAN, for payment accounts if there is no IBAN, or
-
Not used by SDC the Primary Account Number(PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
-
Not used by SDC the Primary Account Number(PAN) of a card in a masked form, or
-
Not used by SDC an alias to access a payment account via a registered mobile phone number(MSISDN).
-
A payment account AccountReferenceOther when using a national payment Form.
Array [
]
oneOf
Possible values: <= 35 characters
End to End Identification.
debtorAccount
object
required
Reference to an account by either
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
Basic Bank Account Number (BBAN) Identifier.
This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).
Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other
object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type
(e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
instructedAmount
object
required
Base Model for amount.
Possible values: non-empty, Value must match regular expression [A-Z]{3}
Currency Code.
Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example Valid representations for EUR with up to two decimals are:
creditorAccount
object
required
Reference to an account by either
Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
IBAN of the account.
Basic Bank Account Number (BBAN) Identifier.
This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).
Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer
Possible values: <= 35 characters
Primary Account Number according to ISO/IEC 7812.
Possible values: <= 35 characters
Masked Primary Account Number.
Possible values: <= 35 characters
Mobile phone number.
other
object
In cases where the specifically defined criteria (IBAN, BBAN, MSISDN) are not provided to identify an instance of the respective account type
(e.g. a savings account), the ASPSP shall include a proprietary ID of the respective account that uniquely identifies the account for this ASPSP.
Possible values: non-empty and <= 35 characters
Proprietary identification of the account.
Possible values: <= 35 characters
An entry provided by an external ISO code list.
Possible values: <= 35 characters
A scheme name defined in a proprietary way.
Possible values: <= 35 characters
Issuer of the identification.
Possible values: Value must match regular expression [A-Z]{3}
Account Currency Code.
Possible values: Value must match regular expression [A-Z]{3}
ExternalCashAccountType1Code from ISO 20022.
Possible values: Value must match regular expression [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
Creditor Agent.
Possible values: <= 140 characters
Creditor Agent Name
Possible values: non-empty and <= 70 characters
Creditor Name
creditorAddress
object
Address
Possible values: <= 70 characters
Street name.
Building Number.
Town Name.
postal Code
Possible values: non-empty, Value must match regular expression [A-Z]{2}
Country code.
ISO 3166 ALPHA2 country code. Is only required for Cross border payment
Creditor Name
Possible values: [debt, cred, shar, slev]
Charge Bearer. ChargeBearerType1Code from ISO20022 only mandatory for Crossborder
Possible values: <= 140 characters
Unstructured remittance information.
Unstructured remittance information.
remittanceInformationStructuredArray
object[]
nullable
Array of structured remittance information.
Possible values: non-empty and <= 35 characters
Possible values: <= 35 characters
Possible values: <= 35 characters
Responses
- 201
- 400
- 401
- 403
- 500
Created
Response Headers
X-Request-ID
string
ID of the request, unique to the call, as determined by the initiating party.
responseCode
string
ID of the response by a code 200 for OK and 4xx for bad response
Location
string
Location of the created resource.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- 1056
- 5768.2
- -1.50
- 5877.78
- 1056
- 5768.2
- -1.50
- 5877.78
- 1056
- 5768.2
- -1.50
- 5877.78
- 1056
- 5768.2
- -1.50
- 5877.78
Array [
]
-
'scaRedirect': In case of an SCA Redirect Approach, the ASPSP is transmitting the link to which to redirect the PSU browser.
-
'scaOAuth': In case of a SCA OAuth2 Approach, the ASPSP is transmitting the URI where the configuration of the Authorisation Server can be retrieved.The configuration follows the OAuth 2.0 Authorisation Server Metadata specification.
-
'confirmation': Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with
-
a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or
-
an access token as retrieved by submitting an authorization code after the integrated OAuth based authentication process with the ASPSP authentication server.
-
-
'startAuthorisationWithPsuIdentification': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU identification data.
-
'startAuthorisationWithPsuAuthentication': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while uploading the PSU authentication data.
- 'startAuthorisationWithEncryptedPsuAuthentication': Same as startAuthorisactionWithPsuAuthentication where the authentication data need to be encrypted on application layer in uploading.
-
'startAuthorisationWithAuthenticationMethodSelection': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while selecting the authentication method. This link is contained under exactly the same conditions as the data element "scaMethods".
-
'startAuthorisationWithTransactionAuthorisation': The link to the authorisation end-point, where the authorisation sub-resource has to be generated while authorising the transaction e.g. by uploading an OTP received by SMS.
-
'self': The link to the payment initiation resource created by this request. This link can be used to retrieve the resource data.
-
'status': The link to retrieve the transaction status of the payment initiation.
-
'scaStatus': The link to retrieve the scaStatus of the corresponding authorisation sub-resource. This link is only contained, if an authorisation sub-resource has been already created.
Array [
]
Possible values: [accc, accp, acsc, acsp, actc, acwc, rcvd, pdng, rjct, canc, acfc, patc, part]
The transaction status is filled with codes of the ISO 20022
Possible values: non-empty
PaymentId
transactionFees
object
Base Model for amount.
Possible values: non-empty, Value must match regular expression [A-Z]{3}
Currency Code.
Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example Valid representations for EUR with up to two decimals are:
currencyConversionFee
object
Base Model for amount.
Possible values: non-empty, Value must match regular expression [A-Z]{3}
Currency Code.
Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example Valid representations for EUR with up to two decimals are:
estimatedTotalAmount
object
Base Model for amount.
Possible values: non-empty, Value must match regular expression [A-Z]{3}
Currency Code.
Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example Valid representations for EUR with up to two decimals are:
estimatedInterbankSettlementAmount
object
Base Model for amount.
Possible values: non-empty, Value must match regular expression [A-Z]{3}
Currency Code.
Possible values: non-empty, Value must match regular expression -?[0-9]{1,14}(\.[0-9]{1,3})?
The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.
Example Valid representations for EUR with up to two decimals are:
If equals 'true', the transaction will involve specific transaction cost as shown by the ASPSP in their public price list or as agreed between ASPSP and PSU. If equals 'false', the transaction will not involve additional specific transaction costs to the PSU unless the fee amount is given specifically in the data elements transactionFees and/or currencyConversionFees. If this data element is not used, there is no information about transaction fees unless the fee amount is given explicitly in the data element transactionFees and/or currencyConversionFees.
scaMethods
object[]
nullable
Authentication object.
This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.
Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor,
or if an access token is transported.
If this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body.
These methods shall be presented towards the PSU for selection by the TPP.
Possible values: [smS_OTP, chiP_OTP, photO_OTP, pusH_OTP, smtP_OTP]
Type of the authentication method.
Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation.
Possible values: non-empty and <= 35 characters
An identification provided by the ASPSP for the later identification of the authentication method selection.
This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.
Detailed information about the SCA method for the PSU.
chosenScaMethod
object
Authentication object.
Possible values: [smS_OTP, chiP_OTP, photO_OTP, pusH_OTP, smtP_OTP]
Type of the authentication method.
Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP?s documentation.
Possible values: non-empty and <= 35 characters
An identification provided by the ASPSP for the later identification of the authentication method selection.
This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.
Detailed information about the SCA method for the PSU.
challengeData
object
It is contained in addition to the data element 'chosenScaMethod' if challenge data is needed for SCA.
In rare cases this attribute is also used in the context of the 'startAuthorisationWithPsuAuthentication' link.
PNG data(max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.
A collection of strings as challenge data.
A link where the ASPSP will provides the challenge image for the TPP.
The maximal length for the OTP to be typed in by the PSU.
Possible values: [characters, integer]
The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU
Possible values: <= 500 characters
Text to be displayed to the PSU.
_links
object
required
A list of hyperlinks to be recognised by the TPP. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request.
Remark: All links can be relative or full links, to be decided by the ASPSP.
Type of links admitted in this response, (further links might be added for ASPSP defined extensions):
scaRedirect
object
Link to a resource.
href Entry.
scaOAuth
object
Link to a resource.
href Entry.
confirmation
object
Link to a resource.
href Entry.
startAuthorisation
object
Link to a resource.
href Entry.
startAuthorisationWithPsuIdentification
object
Link to a resource.
href Entry.
startAuthorisationWithPsuAuthentication
object
Link to a resource.
href Entry.
startAuthorisationWithAuthenticationMethodSelection
object
Link to a resource.
href Entry.
startAuthorisationWithTransactionAuthorisation
object
Link to a resource.
href Entry.
self
object
Link to a resource.
href Entry.
scaStatus
object
Link to a resource.
href Entry.
status
object
Link to a resource.
href Entry.
tppMessages
object[]
nullable
TPP messages.
Possible values: [error, warning]
Category of the TPP message category.
Possible values: [warning, beneficiarY_WHITELISTING_REQUIRED]
Message codes for HTTP Codes 201 to a Payment Initiation Request.
Possible values: <= 500 characters
Additional explaining text to the TPP.
{
"transactionStatus": "accc",
"paymentId": "25ba82ce-b975-4f47-a2e9-9cac0ba27c82",
"transactionFees": {
"currency": "EUR",
"amount": "5877.78"
},
"currencyConversionFee": {
"currency": "EUR",
"amount": "5877.78"
},
"estimatedTotalAmount": {
"currency": "EUR",
"amount": "5877.78"
},
"estimatedInterbankSettlementAmount": {
"currency": "EUR",
"amount": "5877.78"
},
"transactionFeeIndicator": true,
"scaMethods": [
{
"authenticationType": "smS_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "string",
"name": "SMS OTP on phone +49160 xxxxx 28",
"explanation": "Detailed information about the SCA method for the PSU."
}
],
"chosenScaMethod": {
"authenticationType": "smS_OTP",
"authenticationVersion": "string",
"authenticationMethodId": "string",
"name": "SMS OTP on phone +49160 xxxxx 28",
"explanation": "Detailed information about the SCA method for the PSU."
},
"challengeData": {
"myProperty": "string",
"data": "string",
"imageLink": "string",
"otpMaxLength": 0,
"otpFormat": "characters",
"additionalInformation": "string"
},
"psuMessage": "string",
"_links": {
"scaRedirect": {
"href": "string"
},
"scaOAuth": {
"href": "string"
},
"confirmation": {
"href": "string"
},
"startAuthorisation": {
"href": "string"
},
"startAuthorisationWithPsuIdentification": {
"href": "string"
},
"startAuthorisationWithPsuAuthentication": {
"href": "string"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"href": "string"
},
"startAuthorisationWithTransactionAuthorisation": {
"href": "string"
},
"self": {
"href": "string"
},
"scaStatus": {
"href": "string"
},
"status": {
"href": "string"
}
},
"tppMessages": [
{
"category": "error",
"code": "warning",
"text": "string"
}
]
}
{
"transactionStatus": "rjct",
"paymentId": "eb46a3a7-ff92-4618-8165-9a20efa8fc23",
"psuMessage": "Success"
}
Bad Request
Response Headers
X-Request-ID
string
ID of the request, unique to the call, as determined by the initiating party.
responseCode
string
ID of the response by a code 200 for OK and 4xx for bad response
Location
string
Location of the created resource.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
result
object
nullable
property name*
string[]
nullable
string
{
"responseCode": 0,
"responseMessage": "string",
"responseType": "string",
"result": {}
}
{
"responseCode": 400,
"responseMessage": "One or more validation errors occurred.",
"responseType": "InvalidRequest",
"result": {
"amount": [
"Amount is required.",
"Amount should be not empty."
],
"currency": [
"Currency it is required.",
"Currency should be not empty.",
"Currency should be 3 characters.",
"Currency is not valid. Currency showld be format ISO 4217:2015."
],
"accountNumber": [
"AccountNumber is required.",
"AccountNumber should be not empty."
],
"accountBranch": [
"AccountBranch is required.",
"AccountBranch should be not empty."
],
"institutionCode": [
"InstitutionCode is required.",
"InstitutionCode should be not empty."
],
"productDescription": [
"ProductDescription is required.",
"InstitutionCode should be not empty."
],
"billNumber": [
"BillNumber is required.",
"BillNumber should be not empty."
],
"customerNumber": [
"CustomerNumber is required.",
"CustomerNumber should be not empty."
],
"mobileNumber": [
"MobileNumber is required.",
"MobileNumber should be not empty."
]
}
}
Unauthorized
Forbidden
Server Error
Response Headers
X-Request-ID
string
ID of the request, unique to the call, as determined by the initiating party.
responseCode
string
ID of the response by a code 200 for OK and 4xx for bad response
Location
string
Location of the created resource.
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"responseCode": 0,
"responseMessage": "string",
"responseType": "string",
"result": "string"
}
{
"responseCode": 500,
"responseMessage": "One or more errors occurred. (We have identified an unexpected error on our side.)",
"responseType": "InternalServerError",
"result": null
}