Payment status

GET

/api/v2/payments/{paymentId}/status

Code sample: Shell / cURL

curl --request GET \
  --url https://api.ztlpay.io/api/v2/payments/7c628b2e-9094-4bf8-af23-1d517c6fc4f5/status \
  --header 'Authorization: Bearer <token>'

• Production environment
• Sandbox environment for testing

Retrieves latest payments status.

Authorizations

• OAuth2Sandbox
  api://ac0d1aea-5e3a-463f-9dd1-194898ee5820/.default
• OAuth2Production
  api://1f115cad-5576-4db9-a7f9-8921c47a86e4/.default

Parameters

Path Parameters

paymentId

required

string format: uuid

Id received when creating the payment

Example

7c628b2e-9094-4bf8-af23-1d517c6fc4f5

Responses

200

Payment status

Media typeapplication/json

The initial payment status indicates if the payment was accepted, and if it needs to be signed before it will be executed in the bank

object

status

required

• Unsigned The user must approve the transaction.
• InProgress The payment is ongoing.
• Completed The payment has been completed by the bank.
• Rejected The bank rejected the payment.
• Cancelled The payment has been cancelled.
• CustomerActionRequired The payment requires further action from the user. See statusReason for details.

string

Allowed values: Unsigned InProgress Completed Rejected Cancelled CustomerActionRequired

statusReason

• PartlySigned Indicates that the payments needs additional signing. This requirement may be set up for the bank account.
• SmsConfirmationRequired The user needs additional confirmation with responding SMS received. Only used by a few banks
• InsufficientFunds The payment has been stopped by the bank due to lack of funds

string

Allowed values: PartlySigned SmsConfirmationRequired InsufficientFunds

statusReasonText

Payment status reason, unmapped reason text from bank.

string

timestamp

required

Timestamp when the status was fetched from bank

string

Example

{
  "status": "Unsigned",
  "statusReason": "PartlySigned",
  "timestamp": "2024-03-19T09:34:57.657733682+01:00"
}

400

Bad Request

Media typeapplication/json

object

failure

• INVALID_CONSENT Consent is invalid
• AUTHENTICATION_TEMPORARY_UNAVAILABLE Authentication service is temporary unavailable, most likely due to user already has started another concurrent authentication process
• UNSUPPORTED_PRODUCT_BY_BANK Product is not supported by bank
• ACCESS_DENIED User does not have sufficient permissions

string

Allowed values: INVALID_CONSENT AUTHENTICATION_TEMPORARY_UNAVAILABLE UNSUPPORTED_PRODUCT_BY_BANK ACCESS_DENIED

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "failure": "INVALID_CONSENT",
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid Bban"
}

403

Forbidden

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

404

Not found

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

409

Conflict

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

500

Internal server error

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

503

Service unavailable

Media typeapplication/json

object

ztlRequestId

required

Unique RequestId, please provide this Id in case of support requests

string format: uuid

message

required

The underlying reason for the error

string

Example

{
  "ztlRequestId": "3a797348-ef0c-4f52-b821-fdfcdb98c4d9",
  "message": "Invalid account"
}

Headers

ztl-request-id

string format: uuid

Unique RequestId, please provide this Id in case of support requests

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9