Skip to content
ZTLDeveloper Portal

Payment Progress PDF

GET
/api/v2/payments/{paymentId}/progress-pdf
Code sample: Shell / cURL
curl --request GET \
  --url https://api.ztlpay.io/api/v2/payments/7c628b2e-9094-4bf8-af23-1d517c6fc4f5/progress-pdf \
  --header 'Authorization: Bearer <token>'

Generates a PDF report detailing the current progress of a payment.

A PDF report can only be generated for cross-border payments with an exchange and payment status is in one of the following states:

  • InProgress

    When the payment is in the ‘InProgress’ state and funds have not yet been received by ZTL, the PDF will show payment status “Scheduled”

    When the payment is in the ‘InProgress’ state and funds have been received by ZTL, the PDF will show payment status “In progress”

  • Completed

    When the payment is in the ‘Completed’ state, the PDF will show payment status “Sent to bank”

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
paymentId
required
string format: uuid

Id received when creating the payment

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

Responses

Section titled “Responses”

200

Section titled “200”

Successfully generated payment progress PDF

Media typeapplication/pdf
string format: binary

Headers

Section titled “Headers”
ztlRequestId
string format: uuid

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

Example
3a797348-ef0c-4f52-b821-fdfcdb98c4d9

400

Section titled “400”

Bad request

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
message
required

The underlying reason for the error

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

Headers

Section titled “Headers”
ztl-request-id
string format: uuid

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

Example
3a797348-ef0c-4f52-b821-fdfcdb98c4d9

403

Section titled “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
message
required

The underlying reason for the error

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

Headers

Section titled “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

Section titled “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
message
required

The underlying reason for the error

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

Headers

Section titled “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

Section titled “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
message
required

The underlying reason for the error

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

Headers

Section titled “Headers”
ztl-request-id
string format: uuid

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

Example
3a797348-ef0c-4f52-b821-fdfcdb98c4d9