Cancel payroll

POST

/api/v2/payroll/cancel

Shell / cURL

curl --request POST \
  --url https://api.ztlpay.io/api/v2/payroll/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'PSU-IP-Address: 192.158.1.38' \
  --header 'PSU-User-Agent: Mozilla/5.0 (Windows NT 10.0; …) Gecko/20100101 Firefox/63.0' \
  --header 'consent-id: 3a797348-ef0c-4f52-b821-fdfcdb98c4d9' \
  --data '{ "payrollId": "7c628b2e-9094-4bf8-af23-1d517c6fc4f5", "callbackUrl": "https://www.google.com" }'

Cancels a payroll. May require approval.

Authorizations

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

Parameters

Header Parameters

consent-id

required

string format: uuid

Example

3a797348-ef0c-4f52-b821-fdfcdb98c4d9

A valid consentId

PSU-IP-Address

string

Example

192.158.1.38

AAA IP Address of the end-user initiating the payment. DO NOT use any other IP address than what you can collect from the current user session that uses your system (don’t use something stored in your DB). This information is used by the banks to manage traffic and handle security.

PSU-User-Agent

string

The forwarded Agent header field of the HTTP request between PSU and TPP.

Example

Mozilla/5.0 (Windows NT 10.0; …) Gecko/20100101 Firefox/63.0

Request Body

application/json

object

payrollId

required

Payroll id to be cancelled

string

Example

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

callbackUrl

required

Callback url for redirect authentication

string

Example

https://www.google.com

Responses

200

Payroll cancellation created, check status

application/json

object

An ID that can be used to identify the cancellation attempt

string format: uuid

sca

redirect

object

type

required

Redirect link to redirect authorization flow.

string

Allowed values: redirect

url

required

Url to start authorization redirect flow

string

cancellationRequestStatus

required

Status of the cancellation, note that this is not the same as payroll status. * ACCEPTED the cancellation has been successfully

REJECTED the cancellation was rejected
AUTHORIZATION_REQUIRED the cancellation requires approval/signing

string

Allowed values: ACCEPTED REJECTED AUTHORIZATION_REQUIRED

currentPayrollStatus

required

Latest status of the payroll after the cancellation request has been accounted for

string

Allowed values: Unsigned InProgress Completed Rejected Cancelled CustomerActionRequired

reason

Additional information

string

Example

{
  "sca": {
    "type": "redirect",
    "url": "https://api.ztlpay.io/api/v2/consents/sca/redirect/start/6212d401-1785-4739-8843-55fe4eb9dad4"
  },
  "cancellationRequestStatus": "ACCEPTED",
  "currentPayrollStatus": "Unsigned",
  "reason": null
}

400

Bad Request

application/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

string

Allowed values: INVALID_CONSENT AUTHENTICATION_TEMPORARY_UNAVAILABLE UNSUPPORTED_PRODUCT_BY_BANK

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

application/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

application/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

application/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

application/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

application/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