Payments

Initiate and update payment requests, as well as obtain status information for a payment. Manage payment initiation seamlessly and track the progress of your payments.

With Payments API, you can easily handle payment requests and obtain real-time updates on payment status, simplifying the payment initiation process for your application.

The following diagram depicts the flow for initiating and authorizing a payment through our API, in compliance with PSD2. The diagram outlines the sequence of actions and decisions required to successfully execute a payment.

snappi

POST/v1/{payment-service}/{payment-product}

Initiate payment

Initiate a secure payment transaction.

Provide essential transaction details such as debtor / creditor information, instructed amounts and remittance information to successfully process payments.

Path parameters

  • Name
    payment-service
    Type
    string
    Description

    The type of payment service used to initiate the payment. Available options: payments.

  • Name
    payment-product
    Type
    string
    Description

    The product or service for which the payment is being initiated. Available options: internal-transfers, sepa-credit-transfers.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The security certificate of the TPP, used for authentication.

  • Name
    ClientId
    Type
    string
    Description

    The unique ID of the client intitiating the payment.

  • Name
    pSUIPAddress
    Type
    string
    Description

    The IP address of the Payment Service User (PSU).

  • Name
    PSU_ID
    Type
    string
    Description

    The PSU's ID, as determined by the PSU. This ID is the identification of the PSU within the ASPSP and should contain the web user's username that requests the consent or initiates the payment.

  • Name
    consentID
    Type
    string
    Description

    The unique identifier of the consent for the payment.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Body parameters

  • Name
    endToEndIdentification
    Type
    string
    Description

    Unique identifier for the end-to-end transaction.

  • Name
    debtorAccount
    Type
    object
    Description

    Information about the debtor's account, including:

    • iban: The International Bank Account Number (IBAN) of the creditor.
    • bban: The Basic Bank Account Number (BBAN) of the creditor's account.
    • pan: The Primary Account Number of the payer's card.
    • maskedPan: The masked Primary Account Number(PAN) of the payer's card.
    • msisdn: The mobile phone number of the payer.
    • currency: The currency in which the payment is to be made.
  • Name
    instructedAmount
    Type
    object
    Description

    The instructed amount for the payment, including:

    • currency: The currency in which the payment is to be made.
    • Amount: Placeholder for the amount parameter.
  • Name
    creditorAccount
    Type
    object
    Description

    The account number of the creditor, including:

    • iban: The International Bank Account Number (IBAN) of the creditor.
    • bban: The Basic Bank Account Number (BBAN) of the creditor account.
    • pan: The Primary Account Number (PAN) of the payer's card.
    • maskedPan: The masked PAN of the creditor account.
    • msisdn: The mobile phone number of the payer.
    • currency: The currency in which the payment is to be made.
  • Name
    creditorAgent
    Type
    string
    Description

    The clearing agent or institution of the creditor.

  • Name
    creditorAgentName
    Type
    string
    Description

    The name of the clearing agent or institution of the creditor.

  • Name
    creditorName
    Type
    string
    Description

    The name of the creditor.

  • Name
    creditorAddress
    Type
    object
    Description

    The address of the creditor, including:

    • buildingNumber: The building number of the creditor address.
    • city: The city of the creditor address.
    • country: The country of the creditor address.
    • postalCode: The postal code of the creditor address.
    • street: The street name of the creditor address.
  • Name
    remittanceInformationUnstructured
    Type
    string
    Description

    The unstructured remittance information for the payment.

Response attributes

  • Name
    transactionStatus
    Type
    string
    Description

    The status of the transaction (integer). Available options: Description: ACCC, ACCP, ACSC, ACSP, ACTC, ACWC, ACWP, RCVD, PDNG, RJCT, CANC, ACFC, PATC, PART.

  • Name
    paymentId
    Type
    string
    Description

    The unique identifier assigned to the payment.

  • Name
    transactionFees
    Type
    object
    Description

    Details regarding any fees associated with the transaction, including:

    • currency: The currency of the fees.
    • Amount: Placeholder for the amount parameter.
  • Name
    transactionFeeIndicator
    Type
    boolean
    Description

    Indicates if transaction fees apply to the payment.

  • Name
    scaMethods
    Type
    array
    Description

    Specifies the Strong Customer Authentication (SCA) methods available for the payment. Each method in the list has the following attributes:

    • authenticationType: The type of authentication used, such as SMS OTP, push notification, etc. Available options: 0 - 3.
    • authenticationVersion: The version of the authentication method implemented.
    • authenticationMethodId: The ID of the authentication method.
    • name: A human-readable name for the authentication method.
    • explanation: A brief explanation or description of the authentication method.
  • Name
    chosenScaMethod
    Type
    object
    Description

    Specifies the chosen SCA method for authentication during the payment process. It has the same attributes as the scaMethods list:

    • authenticationType (integer): The type of authentication used, such as SMS OTP, push notification, etc. Available options: 0 - 3.
    • authenticationVersion: The version of the authentication method implemented.
    • authenticationMethodId: The ID of the authentication method.
    • name: A human-readable name for the authentication method.
    • explanation: A brief explanation or description of the authentication method.
  • Name
    challengeData
    Type
    object
    Description

    Data related to the challenge for authentication. It includes:

    • image: An image associated with the payment transaction.
    • data: Contains relevant data related to the payment transaction.
    • imageLink: A link to an image associated with the payment transaction.
    • optMaxLength (integer): The maximum length of the One-Time Password (OTP), if OTP is used for the challenge.
    • optFormat (integer): The format of the OTP (e.g., numeric, alphanumeric).
    • additionalInformation: Any additional information related to the payment.
  • Name
    links
    Type
    object
    Description

    Links to other resources related to the payment.

  • Name
    tppMessages
    Type
    array
    Description

    Messages from the Third-Party Provider (TPP) related to the payment, including:

    • category (integer): Categorizes the payment transaction. Available options: 0, 1.
    • code (integer): A unique code associated with the payment. Available options: 0.
    • path (string): The path followed during the payment process.
    • text (string): The text response returned by the API.
  • Name
    paymentService
    Type
    array
    Description

    The payment service that was used for the payment.

  • Name
    paymentProduct
    Type
    array
    Description

    The payment product that was used for the payment.

  • Name
    customerPhone
    Type
    string
    Description

    The phone number of the customer.

  • Name
    statusCode
    Type
    integer
    Description

    The status code of the payment initiation. Available options: 0, 1.

  • Name
    links
    Type
    object
    Description

    Links associated with the response.

Request

POST
/v1/{payment-service}/{payment-product}
curl -X POST /v1/{payment-service}/{payment-product} \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'pSUIPAddress: string' \
-H 'PSU_ID: string' \
-H 'consentID: string' \
-H 'Ocp-Apim-Subscription-Key: string' \
-d '{"endToEndIdentification":"string","debtorAccount":{"iban":"string","bban":"string","pan":"string","maskedPan":"string","msisdn":"string","currency":"string"},"instructedAmount":{"currency":"string","Amount":"string"},"creditorAccount":{"iban":"string","bban":"string","pan":"string","maskedPan":"string","msisdn":"string","currency":"string"},"creditorAgent":"string","creditorAgentName":"string","creditorName":"string","creditorAddress":{"street":"string","buildingNumber":"string","city":"string","postalCode":"string","country":"string"},"remittanceInformationUnstructured":"string"}'

Response examples

{
"transactionStatus": 0,
"paymentId": "",
"transactionFees": {
"currency": "",
"Amount": ""
},
"transactionFeeIndicator": false,
"scaMethods": [
{
  "authenticationType": 0,
  "authenticationVersion": "",
  "authenticationMethodId": "",
  "name": "",
  "explanation": ""
}
],
"chosenScaMethod": {
"authenticationType": 0,
"authenticationVersion": "",
"authenticationMethodId": "",
"name": "",
"explanation": ""
},
"challengeData": {
"image": "",
"data": [
  ""
],
"imageLink": "",
"otpMaxLength": "",
"otpFormat": 0,
"additionalInformation": ""
},
"links": "",
"psuMessage": "",
"tppMessages": [
{
  "category": 0,
  "code": 0,
  "path": "",
  "text": ""
}
],
"paymentService": "",
"paymentProduct": "",
"customerPhone": ""
}

Responses

StatusDescription
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict
DELETE/v1/{payment-service}/{payment-product}/{paymentId}

Cancel payment

Cancel a payment transaction. Stop a payment process and handle any necessary follow-up actions.

Path parameters

  • Name
    payment-service
    Type
    string
    Description

    The payment service that is used to initiate the payment. Available options: payments.

  • Name
    payment-product
    Type
    string
    Description

    The addressed payment product endpoint, e.g., for SEPA Credit Transfers (SCT). Available options: internal-transfers, sepa-credit-transfers.

  • Name
    paymentId
    Type
    string
    Description

    The payment ID of the payment to be cancelled.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate of the TPP.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the TPP.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    transactionStatus
    Type
    string
    Description

    Indicates the status of the transaction after the cancellation request. Available options: RECEIVED, STARTED, INITIATED, STARTED, SUCCESS, FAILED, CANCELLED, PARTIALLY_SUCCESS, PARTIALLY_FAILED, PARTIALLY_CANCELLED, PARTIALLY_RECEIVED, PARTIALLY_INITIATED, PARTIALLY_STARTED, PARTIALLY_COMPLETED.

  • Name
    scaMethods
    Type
    array
    Description

    A list of Strong Customer Authentication (SCA) methods available for the user to authenticate the cancellation request. Each method in the list has the following attributes:

    • authenticationType: The type of authentication used, such as SMS OTP, push notification, etc. Available options: 0 - 3.
    • authenticationVersion: The version of the authentication method implemented.
    • authenticationMethodId: The ID of the authentication method.
    • name: A human-readable name for the authentication method.
    • explanation: A brief explanation or description of the authentication method.
  • Name
    chosenScaMethod
    Type
    object
    Description

    The selected Strong Customer Authentication (SCA) method to authenticate the cancellation. It includes:

    • authenticationMethodId: The ID of the authentication method.
    • authenticationType: The type of the authentication method. Available options: (0)SMS_OTP, (1)SMS_OTP_AND_PIN, (2)SMS_OTP_AND_PASSWORD, (3)SMS_OTP_AND_BIOMETRIC.
    • authenticationVersion: The version of the authentication method.
    • name: A human-readable name for the authentication method.
    • explanation: A brief explanation or description of the authentication method.
  • Name
    challengeData
    Type
    object
    Description

    Contains data related to the challenge issued by the ASPSP (Account Servicing Payment Service Provider). It includes:

    • image: An image associated with the payment.
    • data: Data related to the payment.
    • imageLink: A link to an image associated with the payment.
    • otpMaxLength: The maximum length of the OTP for authentication.
    • otpFormat: The format of the OTP (One-Time Password) used for authentication. Available options: (0)CHARACTERS, (1)INTEGER.
    • additionalInformation: Extra details or supplementary information about the payment.
  • Name
    links
    Type
    object
    Description

    A collection of hyperlinks related to the API call. This includes links to related resources or actions that can be taken following the cancellation request.

  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response. Available options: 0, 1.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category: The message category of the error. Available options: 0, 1.
    • code: The code of the error.
    • path: The path associated with the error.
    • text: The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

DELETE
/v1/{payment-service}/{payment-product}/{paymentId}
curl -X DELETE /v1/{payment-service}/{payment-product}/{paymentId} \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"transactionStatus": 0,
"scaMethods": [
{
  "authenticationType": 0,
  "authenticationVersion": "",
  "authenticationMethodId": "",
  "name": "",
  "explanation": ""
}
],
"chosenScaMethod": {
"authenticationType": 0,
"authenticationVersion": "",
"authenticationMethodId": "",
"name": "",
"explanation": ""
},
"challengeData": {
"image": "",
"data": [
  ""
],
"imageLink": "",
"otpMaxLength": "",
"otpFormat": 0,
"additionalInformation": ""
},
"links": ""
}

Responses

StatusDescription
202Accepted
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict
GET/v1/{payment-service}/{payment-product}/{paymentId}

Fetch payment data

Retrieve detailed payment information, including creditor and debtor account details, transaction status and remittance information.

Gather essential data related to a specific payment transaction without the need for manual data retrieval or processing.

Path parameters

  • Name
    payment-service
    Type
    string
    Description

    The payment service that is used to initiate the payment. Available options: payments.

  • Name
    payment-product
    Type
    string
    Description

    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. Available options: internal-transfers, sepa-credit-transfers.

  • Name
    paymentId
    Type
    string
    Description

    The payment ID of the payment to retrieve.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate of the TPP.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the TPP.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    endToEndIdentification
    Type
    string
    Description

    A unique identifier assigned by the initiating party to unambiguously identify the transaction. This identifier will be passed unaltered through the entire chain of the payment.

  • Name
    debtorAccount
    Type
    object
    Description

    An object containing information about the debtor's account. It includes:

    • iban: The International Bank Account Number (IBAN) of the debtor's account.
    • bban: The Basic Bank Account Number (BBAN) of the debtor's account.
    • pan: The Primary Account Number (PAN) of the debtor's account.
    • maskedPan: The masked PAN of the debtor's account.
    • msisdn: The Mobile Station International Subscriber Directory Number (MSISDN) of the debtor's account, which is a number uniquely identifying a subscription in a GSM or a UMTS mobile network.
    • currency: The currency of the account.
  • Name
    instructedAmount
    Type
    object
    Description

    An object specifying the amount of the payment. It includes:

    • currency: The currency of the payment amount.
    • Amount: The amount of the payment.
  • Name
    creditorAccount
    Type
    object
    Description

    An object containing information about the creditor's account. It includes the same fields as the debtorAccount object.It includes:

    • iban: The International Bank Account Number (IBAN) of the creditor's account.
    • bban: The Basic Bank Account Number (BBAN) of the creditor's account.
    • pan: The Primary Account Number (PAN) of the creditor's account.
    • maskedPan: The masked PAN of the creditor's account.
    • msisdn: The Mobile Station International Subscriber Directory Number (MSISDN) of the creditor's account, which is a number uniquely identifying a subscription in a GSM or a UMTS mobile network.
    • currency: The currency of the account.
  • Name
    creditorAgent
    Type
    string
    Description

    The financial institution servicing an account for the creditor.

  • Name
    creditorName
    Type
    string
    Description

    The name of the creditor.

  • Name
    creditorAddress
    Type
    object
    Description

    An object containing the address of the creditor. It includes:

    • street: The street name in the creditor's address.
    • buildingNumber: The building number in the creditor's address.
    • city: The city in the creditor's address.
    • postalCode: The postal code in the creditor's address.
    • country: The country in the creditor's address.
  • Name
    remittanceInformationUnstructured:
    Type
    string
    Description

    Unstructured remittance information for the creditor to identify the transaction.

  • Name
    transactionStatus
    Type
    string
    Description

    The status of the transaction. Valid options: ACCC, ACCP, ACSC, ACSP, ACTC, ACWC, ACWP, RCVD, PDNG, RJCT, CANC, ACFC, PATC, PART.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response. Available options: 0, 1.

  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/{payment-service}/{payment-product}/{paymentId}
curl -X GET /v1/{payment-service}/{payment-product}/{paymentId} \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"endToEndIdentification": "",
"debtorAccount": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"instructedAmount": {
"currency": "",
"Amount": ""
},
"creditorAccount": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"creditorAgent": "",
"creditorName": "",
"creditorAddress": {
"street": "",
"buildingNumber": "",
"city": "",
"postalCode": "",
"country": ""
},
"remittanceInformationUnstructured": "",
"transactionStatus": 0
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict
GET/v1/{payment-service}/{payment-product}/{paymentId}/authorisations

Fetch authorisation data

Retrieve authorisation details for a specific payment transaction.

Obtain necessary authorisation IDs and related information to facilitate seamless payment processing.

Path parameters

  • Name
    payment-service
    Type
    string
    Description

    The payment service that is used to initiate the payment. Available options: payments.

  • Name
    payment-product
    Type
    string
    Description

    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. Available options: internal-transfers, sepa-credit-transfers.

  • Name
    paymentId
    Type
    string
    Description

    The payment ID of the payment to retrieve.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate of the TPP.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the TPP.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    authorisationIds
    Type
    array
    Description

    The authorisation IDs of the related consent, which was performed prior to this payment initiation.

  • Name
    statusCode
    Type
    integer
    Description

    The status code of the payment initiation. Available options: 0, 1.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/{payment-service}/{payment-product}/{paymentId}/authorisations
curl -X GET /v1/{payment-service}/{payment-product}/{paymentId}/authorisations \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"authorisationIds": [
""
]
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict
POST/v1/{payment-service}/{payment-product}/{paymentId}/authorisations

Start payment authorisation

Initiate the authorisation process for a payment transaction.

Trigger the authorisation flow, receive authentication methods and select a preferred authentication method for completing the transaction.

Path parameters

  • Name
    payment-service
    Type
    string
    Description

    The payment service that is used to initiate the payment. Available options: payments.

  • Name
    payment-product
    Type
    string
    Description

    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. Available options: internal-transfers, sepa-credit-transfers.

  • Name
    paymentId
    Type
    string
    Description

    The payment ID of the payment to retrieve.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate of the TPP.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the TPP.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    scaStatus
    Type
    string
    Description

    The status of the Strong Customer Authentication (SCA) process. Available options: received | psuIdentified | psuAuthenticated | scaMethodSelected | started | finalised | failed | exempted | psuInError | psuKnows | scaMethodConfirmed | psuAuthenticationFailed | psuAuthenticationCancelled | psuAuthenticationTimeout | _psuAuthorisation. | psuAuthorisationCancelled | psuAuthorisationTimeout | psuAuthorisationFailed | psuAccountDisabled | psuAccountBlocked | psuInMaintenance | psuProductNotSupported | psuInvalidPaymentProduct | psuInvalidPaymentId | psuPaymentCancellationFailed | psuPaymentCancellationTimeout | psuPaymentCancellationNotSupported | psuPaymentCancellationInvalid | psuPaymentCancellationUnknown | psuPaymentCancellation

  • Name
    authorisationId
    Type
    string
    Description

    The ID of the authorisation process.

  • Name
    scaMethods
    Type
    object
    Description

    The list of SCA methods, including:

    • authenticationType (string): The authentication type of the SCA method.
    • authenticationVersion (string): The authentication version of the SCA method.
    • authenticationMethodId (boolean): The authentication method ID of the SCA method.
    • name (string): The name of the SCA method.
    • explanation (string): The description of the SCA method.
  • Name
    chosenScaMethod
    Type
    object
    Description

    The chosen SCA method, including:

    • authenticationType (string): The authentication type of the SCA method.
    • authenticationVersion (string): The authentication version of the SCA method.
    • authenticationMethodId (boolean): The authentication method ID of the SCA method.
    • name (string): The name of the SCA method.
    • explanation (string): The description of the SCA method.
  • Name
    challengeData
    Type
    object
    Description

    The challenge data, including:

    • image (string): The image of the challenge.
    • data (array): The data of the challenge.
    • imageLink (string): The link of the challenge.
    • otpMaxLength (string): The maximum length of the challenge.
    • otpFormat (string): The format of the challenge.
    • additionalInformation (string): The additional information of the challenge.
  • Name
    links
    Type
    string
    Description

    Links associated with the payment initiation.

  • Name
    psuMessage
    Type
    string
    Description

    The message for the PSU.

  • Name
    statusCode
    Type
    integer
    Description

    The status code of the payment initiation. Available options: 0, 1.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

POST
/v1/{payment-service}/{payment-product}/{paymentId}/authorisations
curl -X POST /v1/{payment-service}/{payment-product}/{paymentId}/authorisations \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"scaStatus": "",
"authorisationId": "",
"scaMethods": [
{
  "authenticationType": 0,
  "authenticationVersion": "",
  "authenticationMethodId": "",
  "name": "",
  "explanation": ""
}
],
"chosenScaMethod": {
"authenticationType": 0,
"authenticationVersion": "",
"authenticationMethodId": "",
"name": "",
"explanation": ""
},
"challengeData": {
"image": "",
"data": [
  ""
],
"imageLink": "",
"otpMaxLength": "",
"otpFormat": 0,
"additionalInformation": ""
},
"links": "",
"psuMessage": ""
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict
GET/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}

Check security status

Retrieve the Strong Customer Authentication status of a specific payment authorisation.

Check the current status of the authorisation process and take appropriate actions based on the returned status information.

Path parameters

  • Name
    payment-service
    Type
    string
    Description

    The payment service that is used to initiate the payment. Available options: payments.

  • Name
    payment-product
    Type
    string
    Description

    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. Available options: internal-transfers, sepa-credit-transfers.

  • Name
    paymentId
    Type
    string
    Description

    The payment ID of the payment to retrieve.

  • Name
    authorisationId
    Type
    string
    Description

    The authorisation ID of the authorisation to retrieve.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate of the TPP.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the TPP.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    scaStatus
    Type
    integer
    Description

    The status of the SCA performed by the ASPSP. Available options: 0 - 7.

  • Name
    statusCode
    Type
    integer
    Description

    The status code of the payment initiation. Available options: 0, 1.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId}
curl -X GET /v1/{payment-service}/{payment-product}/{paymentId}/authorisations/{authorisationId} \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"scaStatus": 0
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict
GET/v1/{payment-service}/{payment-product}/{paymentId}/status

Check payment status

Retrieve the current status of a payment initiation, providing information on the availability of funds and transaction status.

Obtain information about the transaction status and fund availability and track the progress of payment requests.

Path parameters

  • Name
    payment-service
    Type
    string
    Description

    The payment service that is used to initiate the payment. Available options: payments.

  • Name
    payment-product
    Type
    string
    Description

    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. Available options: internal-transfers, sepa-credit-transfers.

  • Name
    paymentId
    Type
    string
    Description

    The payment ID of the payment to retrieve.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate of the TPP.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the TPP.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    fundsAvailable
    Type
    boolean
    Description

    Indicates whether the funds are available for the payment initiation. Available options: true, false.

  • Name
    transactionStatus
    Type
    integer
    Description

    The status of the payment initiation. Available options:

    • 0 - The payment initiation is not known.
    • 1 - The payment initiation is received.
    • 2 - The payment initiation is accepted for execution.
    • 3 - The payment initiation is rejected.
    • 4 - The payment initiation is successful.
    • 5 - The payment initiation is failed.
    • 6 - The payment initiation is cancelled.
    • 7 - The payment initiation is expired.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the payment initiation. Available options: 0, 1.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/{payment-service}/{payment-product}/{paymentId}/status
curl -X GET /v1/{payment-service}/{payment-product}/{paymentId}/status \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"transactionStatus": 0,
"fundsAvailable": false
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict