POLi
CT Integration option
Info
This integration option supports only NZD
currency.
Payment
Payment flow
- The customer initiates the payment on the merchant's website.
- The merchant sends a payment request to PaySage.io.
- PaySage.io returns a response containing a
form.action
parameter with a URL where the customer needs to be redirected. - The merchant redirects the customer to the URL from the response.
- The customer completes the payment.
- PaySage.io sends a webhook notification with the payment status to the merchant.
Request
Send a payment request with the following additional parameters:
Parameter | Type | Description |
---|---|---|
request | object | |
return_url * required |
string | URL to return the customer to when the transaction is completed. |
customer | object | A section of the customer details. |
first_name * required |
string | The customer's first name. |
last_name * required |
string | The customer's last name. |
email * required |
string | The customer's email address. |
device_id | string | The customer's device ID. |
method | object | A section of the payment method information. |
type * required |
string | poli |
additional_data | object | |
customer | object | |
id | string | Unique customer identifier in the merchant's system. It is recommended to use the version 4 UUID format. |
Request example
{
"request": {
"amount": 22000,
"currency": "NZD",
"description": "description",
"test": false,
"return_url": "https://your_return_url.com",
"method": {
"type": "poli"
},
"customer": {
"first_name": "John",
"last_name": "Doe",
"email": "example@example.com"
},
"additional_data": {
"customer": {
"id": "ff04170a-2590-49a8-9583-a3f758227107"
}
}
}
}
Response
Redirect your customer to the URL received as the value of the form.action
parameter.
Response example
{
"transaction": {
"uid": "55956a19-d5e6-4894-a5f0-67a0b6eea20d",
"type": "payment",
"status": "pending",
"amount": 22000,
"currency": "NZD",
"description": "description",
"created_at": "2024-05-30T14:43:39Z",
"updated_at": "2024-05-30T14:43:39Z",
"method_type": "poli",
"receipt_url": "https://backoffice.paysage.io/customer/transactions/55956a19-d5e6-4894-a5f0-67a0b6eea20d/2036ae51c64d7f9f45cd601ee18c397acd3104668ce521295bfdf3159d868a71",
"payment": {
"status": "pending",
"gateway_id": 4057,
"ref_id": "ea21741a-a275-4c0b-b933-4eb483d6dded",
"message": "Transaction was initialized."
},
"poli": {
"type": "poli"
},
"customer": {
"email": "example@example.com",
"last_name": "Doe",
"first_name": "John",
"ip": null
},
"manually_corrected_at": null,
"message": "Transaction was initialized.",
"test": false,
"billing_address": {
"email": "example@example.com",
"last_name": "Doe",
"first_name": "John"
},
"additional_data": {
"customer": {
"id": "ff04170a-2590-49a8-9583-a3f758227107"
},
"payment_method": {
"type": "alternative"
}
},
"gateway": {
"iframe": true
},
"form": {
"action": "https://paywith.ct.com/?paymentId=ea21741a-a275-4c0b-b933-4eb483d6888j",
"method": "GET",
"fields": []
}
}
}