ZEN Payments

https://docs.zen.com/payments/
Admin
ZEN Payments is a fintech platform offering payment solutions including multi-currency accounts,...
Tokens:199,914
Snippets:1,376
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Subscription List Response Example

Source: https://docs.zen.com/payments/api-reference/fetch-subscription-list

This example shows the structure of a successful response when fetching a list of subscriptions. It includes customer data and pagination metadata.

```json
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "merchantCustomerId": "string",
            "status": "new",
            "firstName": "string",
            "lastName": "string",
            "userName": "string",
            "description": "string",
            "email": "user@example.com",
            "dragonTermsAccepted": true,
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "createdAt"
    }
}
```

--------------------------------

### 200 OK Response Example

Source: https://docs.zen.com/payments/api-reference/update-payout-card

This example shows the structure of a successful response when a payout card is updated. It includes all fields that can be returned.

```json
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "cardName": "string",
    "recipientFirstName": "string",
    "recipientLastName": "string",
    "last4": "stri",
    "fundsAvailability": "string",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}
```

--------------------------------

### 200 OK Response Example

Source: https://docs.zen.com/payments/api-reference/fetch-card

This example shows the structure of a successful response when fetching card details. It includes all possible fields returned by the API.

```json
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
    "cardName": "string",
    "cardHolderName": "string",
    "cardHolder": {
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "birthDate": "string"
    },
    "addressLine1": "string",
    "addressLine2": "string",
    "addressCity": "string",
    "addressCountry": "string",
    "addressState": "string",
    "addressZip": "string",
    "organization": "string",
    "brand": "string",
    "bank": "string",
    "country": "str",
    "tokenizationMethod": "apple_pay",
    "last4": "stri",
    "expMonth": "st",
    "expYear": "stri",
    "isDefault": true,
    "eea": true,
    "commercial": true,
    "createdAt": "2019-08-24T14:15:22.123Z"
}
```

--------------------------------

### 200 OK Response Example

Source: https://docs.zen.com/payments/api-reference/fetch-payout-card-list

This is an example of a successful response when fetching a list of payout cards. It includes the 'data' array containing card details and 'meta' for pagination information.

```json
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
            "cardName": "string",
            "recipientFirstName": "string",
            "recipientLastName": "string",
            "last4": "stri",
            "fundsAvailability": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "createdAt"
    }
}
```

--------------------------------

### Example Flat Form Request

Source: https://docs.zen.com/payments/checkout-integration/signature

This is an example of a flat form request before signature generation. It includes various parameters for a transaction.

```text
amount=1000&billingaddress.buildingnumber=1&billingaddress.city=cityname&billingaddress.companyname=company name&billingaddress.country=pl&billingaddress.countrystate=statename&billingaddress.firstname=john&billingaddress.id=baid1&billingaddress.lastname=doe&billingaddress.phone=+48555555555&billingaddress.postcode=23-232&billingaddress.province=provincename&billingaddress.roomnumber=11&billingaddress.street=streetname&billingaddress.taxid=12345678&currency=pln&customer.email=john.doe@test.com&customer.firstname=john&customer.id=customerid328642&customer.lastname=doe&customipnurl=https://backtoshop/notiify&items[0].category=itemcategory1&items[0].code=itemcode1&items[0].lineamounttotal=400&items[0].name=itemname1&items[0].price=200&items[0].quantity=2&items[1].category=itemcategory2&items[1].code=itemcode2&items[1].lineamounttotal=600&items[1].name=itemname2&items[1].price=300&items[1].quantity=2&language=pl&merchanttransactionid=trasaction1&shippingaddress.buildingnumber=1&shippingaddress.city=cityname&shippingaddress.companyname=company name&shippingaddress.country=pl&shippingaddress.countrystate=statename&shippingaddress.firstname=john&shippingaddress.id=sa1&shippingaddress.lastname=doe&shippingaddress.phone=+48555555555&shippingaddress.postcode=11&shippingaddress.province=provincename&shippingaddress.roomnumber=11&shippingaddress.street=streetname&terminaluuid=05b692d0-00b9-48f7-92ca-1509f055df2e&urlfailure=https://backtoshop/failure&urlredirect=https://backtoshop/redirect&urlsuccess=https://backtoshop/success
```

--------------------------------

### Example Response for Fetch Saved Payout Card V3

Source: https://docs.zen.com/payments/api-reference/api-11695220

Example JSON response when a customer's saved payout card is successfully fetched.

```JSON
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "cardName": "string",
    "last4": "stri",
    "organization": "string",
    "createdAt": "2019-08-24T14:15:22.123Z"
}
```

--------------------------------

### Payout Transaction Example

Source: https://docs.zen.com/payments/api-reference/create-payout-transaction

This example demonstrates the structure of a payout transaction, including all relevant fields for initiating and tracking a payout.

```APIDOC
## Create Payout Transaction

### Description
Initiates a payout transaction, providing details about the amount, currency, and associated merchant and customer information.

### Method
POST

### Endpoint
/transactions/payout

### Request Body
- **merchantTransactionId** (string) - Required - Unique identifier for the transaction from the merchant's perspective.
- **amount** (string) - Required - The amount to be paid out.
- **currency** (string) - Required - The currency of the payout amount (ISO 4217 code).
- **customer** (object) - Required - Information about the customer receiving the payout.
  - **id** (string) - Required - Unique identifier for the customer.
  - **firstName** (string) - Required - Customer's first name.
  - **lastName** (string) - Required - Customer's last name.
  - **email** (string) - Required - Customer's email address.
  - **phone** (string) - Optional - Customer's phone number.
  - **information** (string) - Optional - Additional information about the customer.
  - **ip** (string) - Optional - Customer's IP address.
- **meta** (object) - Optional - Additional metadata for the transaction.
  - **returnUrl** (string) - Optional - URL to redirect the customer after the transaction.
  - **customIpnUrl** (string) - Optional - Custom URL for Instant Payment Notifications (IPN).
  - **destinationAddress** (string) - Required for crypto payouts - The destination address for the cryptocurrency payout.
  - **destinationCurrency** (string) - Required for crypto payouts - The cryptocurrency to be paid out (e.g., BTC, ETH).
  - **cryptoAmount** (string) - Required for crypto payouts - The amount in cryptocurrency to be paid out.
  - **cryptoNetworkFee** (string) - Optional - The network fee for the cryptocurrency transaction.

### Request Example
```json
{
    "merchantTransactionId": "string",
    "amount": "123.04",
    "currency": "PLN",
    "customer": {
        "id": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@zen.com",
        "phone": "+48 000 000 000",
        "information": "Some information",
        "ip": "127.0.0.1"
    },
    "meta": {
        "destinationAddress": "1HB5XDDddDDdDDDj6mfBsbifRoD4miY36v",
        "destinationCurrency": "BTC",
        "cryptoAmount": "10",
        "returnUrl": "https://pay.g2a.com/checkout?",
        "customIpnUrl": "https://ipn-pay.g2a.com/ipn"
    }
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the payout transaction.
- **merchantTransactionId** (string) - The merchant's unique transaction identifier.
- **status** (string) - The current status of the payout transaction (e.g., ACCEPTED, PENDING, FAILED).
- **createdAt** (string) - The timestamp when the transaction was created.
- **redirectUrl** (string) - URL to redirect the user if an intermediate step is required.
- **imageUrl** (string) - URL for an image associated with the transaction.
- **merchantAction** (object) - Details on the action the merchant needs to take.
  - **action** (string) - The type of action (e.g., REDIRECT, COMPLETE).
  - **data** (object) - Data associated with the action.
    - **redirectUrl** (string) - The URL for redirection.

#### Response Example
```json
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantTransactionId": "string",
    "status": "ACCEPTED",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "redirectUrl": "https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=",
    "imageUrl": "https://notifications.zen-test.com/eps/image/567afec2-6189-4731-9cb3-c6d4bb4fd345/1579592876",
    "merchantAction": {
        "action": "REDIRECT",
        "data": {
            "redirectUrl": "http://example.com"
        }
    }
}
```
```

--------------------------------

### Create Purchase Transaction Example

Source: https://docs.zen.com/payments/api-reference/create-purchase-transaction

This example demonstrates the structure of a request to create a purchase transaction. It includes authorization, source, merchant IDs, payment channel, amount, currency, custom IPN URL, comment, fraud fields, terms ID, item details, customer information, and browser details for payment-specific data.

```json
{
    "authorization": {
        "amount": "123.04",
        "currency": "PLN",
        "sessionId": "string",
        "type": "DIRECT"
    },
    "source": {
        "channel": "PTS_ZEN_API",
        "pluginName": "string",
        "pluginVersion": "string",
        "platformName": "string",
        "platformVersion": "string",
        "processId": "string",
        "processName": "string"
    },
    "merchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
    "originMerchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
    "paymentChannel": "PCL_CARD",
    "amount": "123.04",
    "currency": "PLN",
    "customIpnUrl": "https://ipn-pay.g2a.com/ipn",
    "comment": "string",
    "fraudFields": {
        "property1": "string",
        "property2": "string"
    },
    "termsId": "string",
    "items": [
        {
            "code": "IDS123",
            "category": "cars",
            "type": "physical",
            "name": "Multipla",
            "price": "123.04",
            "quantity": 1,
            "lineAmountTotal": "123.04"
        }
    ],
    "customer": {
        "id": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@zen.com",
        "phone": "+48 000 000 000",
        "information": "Some information",
        "ip": "127.0.0.1"
    },
    "paymentSpecificData": {
        "browserDetails": {
            "acceptHeader": "string",
            "colorDepth": "string",
            "javaEnabled": true,
            "javascriptEnabled": true,
            "lang": "string",
            "screenHeight": "strin",
            "screenWidth": "strin",
            "timezone": "strin",
            "windowSize": "01",
            "userAgent": "string"
        }
    }
}
```

--------------------------------

### Example JSON Response for Available Payment Methods

Source: https://docs.zen.com/payments/api-integration/available-payment-methods

This is an example of the JSON response you will receive when querying the /v3/terminals endpoint. It includes metadata and a list of payment methods, each with its associated payment channels and supported currencies.

```json
{
    "meta": {
        "limit": 100,
        "offset": 0,
        "direction": "asc",
        "hasMore": false,
        "currencies": [
            "EUR",
            "AED",
            "AUD",
            "BGN",
            "CAD",
            "CHF",
            "CNY",
            "CZK",
            "DKK",
            "GBP",
            "HKD",
            "HUF",
            "ILS",
            "JPY",
            "KES",
            "MXN",
            "NOK",
            "NZD",
            "PLN",
            "QAR",
            "RON",
            "SAR",
            "SEK",
            "SGD",
            "THB",
            "TRY",
            "UGX",
            "USD",
            "ZAR",
            "ISK"
        ]
    },
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentMethodName": "Card",
            "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/card.svg",
            "paymentChannels": [
                {
                    "paymentChannel": "PCL_APPLEPAY",
                    "paymentChannelName": "Apple Pay",
                    "currencies": [
                        "AED",
                        "AUD",
                        "BGN",
                        "CAD",
                        "CHF",
                        "CNY",
                        "CZK",
                        "DKK",
                        "EUR",
                        "GBP",
                        "HKD",
                        "HUF",
                        "ILS",
                        "JPY",
                        "KES",
                        "MXN",
                        "NOK",
                        "NZD",
                        "PLN",
                        "QAR",
                        "RON",
                        "SAR",
                        "SEK",
                        "SGD",
                        "THB",
                        "TRY",
                        "UGX",
                        "USD",
                        "ZAR"
                    ],
                    "cryptoCurrencies": [],
                    "cardOrganizations": [],
                    "channelLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/applepay.svg",
                    "lastUsed": false,
                    "hasAuthorizationFee": false,
                    "hasCashback": false
                }
            ]
        },
        {
            "paymentMethod": "PME_CARD",
            "paymentMethodName": "Card",
            "methodLogoUrl": "https://www.zen.com/hubfs/Assets/CheckoutPME/card.svg",
            "paymentChannels": [
                {
                    "paymentChannel": "PCL_CARD",
                    "paymentChannelName": "Card",
                    "currencies": [

```

--------------------------------

### Add Payout Card Request Example

Source: https://docs.zen.com/payments/api-reference/add-payout-card

This cURL example demonstrates how to add a payout card by sending a POST request to the Zen API. Ensure you include the necessary authorization headers and the correct JSON payload.

```Shell
curl --location 'https://api.zen.com/v2/payout-profiles/card' \
--header 'request-id;' \
--header 'external-customer-id;' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{ \
    "card": { \
        "number": 4111111111111111, \
        "expiryDate": "0620", \
        "cvv": 123 \
    }, \
    "recipientFirstName": "string", \
    "recipientLastName": "string", \
    "cardAlias": "string" \
}'
```

--------------------------------

### Example Flat Form Request with paywallSecret

Source: https://docs.zen.com/payments/checkout-integration/signature

This example shows the flat form request with the Merchant's `paywallSecret` parameter appended. This is a crucial step before encoding.

```text
amount=1000&billingaddress.buildingnumber=1&billingaddress.city=cityname&billingaddress.companyname=company name&billingaddress.country=pl&billingaddress.countrystate=statename&billingaddress.firstname=john&billingaddress.id=baid1&billingaddress.lastname=doe&billingaddress.phone=+48555555555&billingaddress.postcode=23-232&billingaddress.province=provincename&billingaddress.roomnumber=11&billingaddress.street=streetname&billingaddress.taxid=12345678&currency=pln&customer.email=john.doe@test.com&customer.firstname=john&customer.id=customerid328642&customer.lastname=doe&customipnurl=https://backtoshop/notiify&items[0].category=itemcategory1&items[0].code=itemcode1&items[0].lineamounttotal=400&items[0].name=itemname1&items[0].price=200&items[0].quantity=2&items[1].category=itemcategory2&items[1].code=itemcode2&items[1].lineamounttotal=600&items[1].name=itemname2&items[1].price=300&items[1].quantity=2&language=pl&merchanttransactionid=trasaction1&shippingaddress.buildingnumber=1&shippingaddress.city=cityname&shippingaddress.companyname=company name&shippingaddress.country=pl&shippingaddress.countrystate=statename&shippingaddress.firstname=john&shippingaddress.id=sa1&shippingaddress.lastname=doe&shippingaddress.phone=+48555555555&shippingaddress.postcode=11&shippingaddress.province=provincename&shippingaddress.roomnumber=11&shippingaddress.street=streetname&terminaluuid=05b692d0-00b9-48f7-92ca-1509f055df2e&urlfailure=https://backtoshop/failure&urlredirect=https://backtoshop/redirect&urlsuccess=https://backtoshop/successc8c93c452d38acf3183d2f08fee60aa7
```

--------------------------------

### Fetch Saved Payout Card List V3 Response Example

Source: https://docs.zen.com/payments/api-reference/api-11695218

This is an example of a successful JSON response when fetching the list of saved payout cards. It includes card details and pagination metadata.

```JSON
{
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
            "cardName": "string",
            "last4": "stri",
            "organization": "string",
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "createdAt"
    }
}
```

--------------------------------

### 200 OK Response Example

Source: https://docs.zen.com/payments/api-reference/api-17368008

This is an example of a successful response body for a request that returns a list of payment methods. It includes fields like id, merchantCustomerId, alias, active status, last4 digits of the card, and timestamps.

```json
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantCustomerId": "string",
    "alias": "string",
    "active": true,
    "last4": "string",
    "lastUsedAt": "string",
    "lastUsedCurrency": "string",
    "organization": "string",
    "paymentMethod": "string",
    "paymentChannel": "string",
    "channelLogoUrl": "string",
    "organizationLogoUrl": "string",
    "createdAt": "string"
}
```

--------------------------------

### Calculate Cashback Request Example

Source: https://docs.zen.com/payments/api-reference/calculate-cashback

Use this cURL command to send a request to the calculate cashback API. Ensure you replace `<api-key>` with your actual API key and provide the correct amount, currency, and transaction details.

```Shell
curl --location 'https://api.zen.com/v1/cashback/calculate' \
--header 'request-id;' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{ 
    "amount": "string",
    "currency": "string",
    "transactionType": "TRT_PURCHASE",
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentChannel": "PCL_CARD",
            "cardOrganization": "COR_VISA"
        }
    ]
}'
```

--------------------------------

### Get Transaction Details by Merchant ID

Source: https://docs.zen.com/payments/api-integration/purchase-transaction

Retrieve the details of a transaction using the merchant's order ID. This is a GET request.

```json
{
  "order_id": "your_order_id"
}
```

--------------------------------

### Refund Transaction Response Example

Source: https://docs.zen.com/payments/api-reference/create-refund-transaction

This is an example of a successful refund transaction response. It includes details about the original transaction, refund information, and status.

```json
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "parentTransactionId": "f8033cf6-befa-47f4-a48a-b915b8c72a71",
    "redirectUrl": "https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=",
    "imageUrl": "https://notifications.zen-test.com/eps/image/567afec2-6189-4731-9cb3-c6d4bb4fd345/1579592876",
    "merchantAction": {
        "action": "REDIRECT",
        "data": {
            "redirectUrl": "http://example.com"
        }
    },
    "merchantTransactionId": "string",
    "originMerchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
    "amount": "123.04",
    "currency": "PLN",
    "fee": {
        "amount": "123.04",
        "currency": "EUR"
    },
    "subsidiaryData": {
        "feeAmount": "123.04",
        "grossAmount": "123.04"
    },
    "authorization": {
        "amount": "string",
        "currency": "string",
        "fee": "string"
    },
    "createdAt": "2019-08-24T14:15:22.123Z",
    "modifiedAt": "2019-08-24T14:15:22.123Z",
    "type": "TRT_REFUND",
    "status": "ACCEPTED",
    "topupTransferStatus": "ACCEPTED",
    "paymentChannel": "PCL_CARD",
    "actions": {
        "refund": false,
        "cancel": false,
        "capture": true,
        "redirect": true,
        "authorization": true,
        "selectOffer": true,
        "renewOffers": true
    },
    "fraudFields": {
        "property1": "string",
        "property2": "string"
    },
    "rejectCode": "E40199",
    "rejectReason": "Client doesn't have enough money.",
    "refunds": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "merchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
            "originMerchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
            "amount": "123.04",
            "currency": "PLN",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "status": "ACCEPTED"
        }
    ],
    "meta": {
        "selectedOffer": {
            "pspId": "string",
            "expirationDate": "string",
            "amountToWithdraw": "string",
            "cryptoAmount": "string",
            "cryptoNetworkFee": "string",
            "termsUrl": "string",
            "blikBuid": "string"
        },
        "payoutBtcAddress": "1HB5XDDddDDdDDDj6mfBsbifRoD4miY36v",
        "btcAmount": "10",
        "feeOwner": "partner",
        "returnUrl": "https://pay.g2a.com/checkout?",
        "customIpnUrl": "https://ipn-pay.g2a.com/ipn",
        "returnVerifyUrl": "https://zen.com/returnUrlAfter3ds",
        "avsResult": "string",
        "cvvResult": "string",
        "authorisationCode": "string",
        "resultCode": "string",
        "threeDs": {
            "xid": "string",
            "version": "string",
            "eci": "string",
            "cavv": "string",
            "cavvAlgorithm": "string",
            "emv3DSFlow": "string",
            "status": "string",
            "cardHolderInfo": "string",
            "errorData": {
                "component": "string",
                "description": "string",
                "detail": "string"
            }
        },
        "destinationCurrency": "string",
        "destinationAddress": "string",
        "destinationAddressMemo": "string",
        "travelRuleData": {
            "entityType": "individual",
            "vaspName": "string",
            "firstName": "string",
            "lastName": "string"
        }
    }
}
```

--------------------------------

### Example of Elements Converted to Lowercase

Source: https://docs.zen.com/payments/checkout-integration/signature

This example shows the result of converting all flattened attribute names and values to lowercase as part of the signature generation process.

```text
billingAddress.firstName=Jan → billingaddress.firstname=john
```

--------------------------------

### Example of Joined Elements

Source: https://docs.zen.com/payments/checkout-integration/signature

Demonstrates the final string format after flattening, lowercasing, sorting, and joining all elements with an ampersand, before appending the paywall secret.

```text
amount=1000&billingaddress.buildingnumber=1&billingaddress.city=cityname
```

--------------------------------

### Fetch Payment Links List using cURL

Source: https://docs.zen.com/payments/api-reference/fetch-payment-link-list

Demonstrates how to fetch a list of payment links using cURL. Includes optional parameters for filtering and pagination. Ensure the 'request-id' header is provided and 'Authorization' header is correctly set.

```curl
curl --location 'https://api.zen.com/v1/payment-links?customerEmail=undefined&status=undefined&currency=undefined&creationDateFrom=undefined&creationDateTo=undefined&showHidden=true%2C%20false&itemsPerPage=undefined&page=undefined' \
--header 'request-id;' \
--header 'Authorization: <api-key>'
```

--------------------------------

### Example JSON Request for Signature Generation

Source: https://docs.zen.com/payments/checkout-integration/signature

This is an example of the JSON object that needs to be prepared for a checkout request. It includes various parameters for transaction details, customer information, and addresses.

```json
{
   "terminalUuid":"05b692d0-00b9-48f7-92ca-1509f055df2e",
   "amount":1000,
   "currency":"PLN",
   "merchantTransactionId":"trasaction1",
   "customer":{
      "id":"CustomerId328642",
      "firstName":"John",
      "lastName":"Doe",
      "email":"john.doe@test.com"
   },
   "items":[
      {
         "code":"itemCode1",
         "category":"itemCategory1",
         "name":"itemName1",
         "price":200,
         "quantity":2,
         "lineAmountTotal":400
      },
      {
         "code":"itemCode2",
         "category":"itemCategory2",
         "name":"itemName2",
         "price":300,
         "quantity":2,
         "lineAmountTotal":600
      }
   ],
   "billingAddress":{
      "id":"bAId1",
      "firstName":"John",
      "lastName":"Doe",
      "country":"PL",
      "street":"streetName",
      "city":"cityName",
      "countryState":"stateName",
      "province":"provinceName",
      "buildingNumber":"1",
      "roomNumber":"11",
      "postcode":"23-232",
      "companyName":"Company Name",
      "phone":"+48555555555",
      "taxId":"12345678"
   },
   "shippingAddress":{
      "id":"sA1",
      "firstName":"John",
      "lastName":"Doe",
      "country":"PL",
      "street":"streetName",
      "city":"cityName",
      "countryState":"stateName",
      "province":"provinceName",
      "buildingNumber":"1",
      "roomNumber":"11",
      "postcode":"11",
      "companyName":"Company Name",
      "phone":"+48555555555"
   },
   "urlFailure":"https://backtoshop/failure",
   "urlRedirect":"https://backtoshop/redirect",
   "urlSuccess":"https://backtoshop/success",
   "customIpnUrl":"https://backtoshop/notiify",
   "language":"pl"
}
```

--------------------------------

### Payment Methods Response Example (JSON)

Source: https://docs.zen.com/payments/api-reference/payment-methods

This JSON structure represents a successful response (200 OK) when querying for payment methods. It includes metadata about the request and a list of available payment methods with their details.

```json
{
    "meta": {
        "limit": 10,
        "offset": 0,
        "direction": "desc",
        "hasMore": false,
        "currencies": [
            "PLN"
        ]
    },
    "data": [
        {
            "paymentMethod": "PME_CARD",
            "paymentMethodName": "string",
            "methodLogoUrl": "string",
            "customerCountry": "PL",
            "paymentChannels": [
                {
                    "paymentChannel": "PCL_CARD",
                    "paymentChannelName": "string",
                    "currencies": [
                        "PLN",
                        "EUR",
                        "USD",
                        "GBP"
                    ],
                    "externalSubmerchantId": "string",
                    "cryptoCurrencies": [
                        {
                            "walletCurrency": "BTC",
                            "currencyName": "Bitcoin",
                            "currencyCode": "BTC_LIGHTNING",
                            "network": "Lightning Network",
                            "networkLogoUrl": "https://www.zen.com/hubfs/Assets/Top-up/Lightning%20Network.png",
                            "networkCode": "LIGHTNING",
                            "minAmount": "12.03",
                            "maxAmount": "123.04"
                        }
                    ],
                    "cardOrganizations": [
                        {
                            "organization": "COR_VISA",
                            "logoUrl": "string"
                        }
                    ],
                    "channelLogoUrl": "string",
                    "lastUsed": true,
                    "hasAuthorizationFee": true,
                    "hasCashback": true
                }
            ]
        }
    ]
}
```

--------------------------------

### Create Customer Response Body Example (200 OK)

Source: https://docs.zen.com/payments/api-reference/create-customer

This JSON object shows a successful response when a customer is created. It includes the unique ID assigned by Zen, customer details, and creation timestamp.

```json
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "merchantCustomerId": "string",
    "status": "new",
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "description": "string",
    "email": "user@example.com",
    "dragonTermsAccepted": true,
    "createdAt": "2019-08-24T14:15:22.123Z"
}
```

--------------------------------

### Get Payout Transaction Details

Source: https://docs.zen.com/payments/api-reference/payout-transaction-details-zen-id

Retrieves the details of a specific payout transaction.

```APIDOC
## GET /payout-transaction-details/{zenId}

### Description
Retrieves the details of a specific payout transaction using its Zen ID.

### Method
GET

### Endpoint
/payout-transaction-details/{zenId}

### Parameters
#### Path Parameters
- **zenId** (string) - Required - The unique identifier for the payout transaction.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the transaction.
- **parentTransactionId** (string) - The ID of the parent transaction, if applicable.
- **redirectUrl** (string) - The URL for redirecting the customer.
- **imageUrl** (string) - URL for an associated image.
- **merchantAction** (object) - Information about the merchant's action.
  - **action** (string) - The type of action.
  - **data** (object) - Data associated with the action.
    - **redirectUrl** (string) - The redirect URL for the action.
- **merchantTransactionId** (string) - The merchant's transaction identifier.
- **originMerchantTransactionId** (string) - The original merchant transaction identifier.
- **amount** (string) - The transaction amount.
- **currency** (string) - The transaction currency.
- **fee** (object) - Information about the transaction fee.
  - **amount** (string) - The fee amount.
  - **currency** (string) - The fee currency.
- **subsidiaryData** (object) - Subsidiary data for the transaction.
  - **feeAmount** (string) - The fee amount in subsidiary currency.
  - **grossAmount** (string) - The gross amount in subsidiary currency.
- **authorization** (object) - Authorization details.
  - **amount** (string) - The authorized amount.
  - **currency** (string) - The authorized currency.
  - **fee** (string) - The authorized fee.
- **createdAt** (string) - The timestamp when the transaction was created.
- **modifiedAt** (string) - The timestamp when the transaction was last modified.
- **type** (string) - The type of transaction (e.g., TRT_REFUND).
- **status** (string) - The current status of the transaction.
- **topupTransferStatus** (string) - The status of the top-up transfer.
- **paymentChannel** (string) - The payment channel used.
- **actions** (object) - Available actions for the transaction.
  - **refund** (boolean) - Indicates if a refund is possible.
  - **cancel** (boolean) - Indicates if the transaction can be cancelled.
  - **capture** (boolean) - Indicates if the transaction can be captured.
  - **redirect** (boolean) - Indicates if a redirect is possible.
  - **authorization** (boolean) - Indicates if authorization is possible.
  - **selectOffer** (boolean) - Indicates if selecting an offer is possible.
  - **renewOffers** (boolean) - Indicates if renewing offers is possible.
- **fraudFields** (object) - Fields related to fraud detection.
  - **property1** (string) - Example fraud field.
  - **property2** (string) - Example fraud field.
- **rejectCode** (string) - The code for transaction rejection, if applicable.
- **rejectReason** (string) - The reason for transaction rejection, if applicable.
- **refunds** (array) - A list of refund objects associated with the transaction.
  - **id** (string) - The refund identifier.
  - **merchantTransactionId** (string) - The merchant's transaction ID for the refund.
  - **originMerchantTransactionId** (string) - The original merchant transaction ID for the refund.
  - **amount** (string) - The refund amount.
  - **currency** (string) - The refund currency.
  - **createdAt** (string) - The timestamp when the refund was created.
  - **status** (string) - The status of the refund.
- **meta** (object) - Additional metadata for the transaction.
  - **selectedOffer** (object) - Details about the selected offer.
    - **pspId** (string) - The PSP ID for the offer.
    - **expirationDate** (string) - The expiration date of the offer.
    - **amountToWithdraw** (string) - The amount to withdraw for the offer.
    - **cryptoAmount** (string) - The cryptocurrency amount for the offer.
    - **cryptoNetworkFee** (string) - The network fee for the cryptocurrency.
    - **termsUrl** (string) - The URL for the offer terms.
    - **blikBuid** (string) - The BLIK BU ID.
  - **payoutBtcAddress** (string) - The Bitcoin payout address.
  - **btcAmount** (string) - The Bitcoin amount.
  - **feeOwner** (string) - The owner of the fee.
  - **returnUrl** (string) - The return URL for the transaction.
  - **customIpnUrl** (string) - A custom URL for Instant Payment Notifications.
  - **returnVerifyUrl** (string) - The URL for returning after verification.
  - **avsResult** (string) - The AVS (Address Verification System) result.
  - **cvvResult** (string) - The CVV (Card Verification Value) result.
  - **authorisationCode** (string) - The authorization code.
  - **resultCode** (string) - The result code of the transaction.
  - **threeDs** (object) - Details about the 3D Secure authentication.
    - **xid** (string) - The 3D Secure transaction ID.
    - **version** (string) - The 3D Secure version.
    - **eci** (string) - The ECI (Electronic Commerce Indicator).
    - **cavv** (string) - The CAVV (Cardholder Authentication Verification Value).
    - **cavvAlgorithm** (string) - The CAVV algorithm used.
    - **emv3DSFlow** (string) - The EMV 3-D Secure flow.
    - **status** (string) - The 3D Secure status.
    - **cardHolderInfo** (string) - Information about the cardholder.
    - **errorData** (object) - Data related to 3D Secure errors.
      - **component** (string) - The component where the error occurred.
      - **description** (string) - A description of the error.
      - **detail** (string) - Detailed information about the error.
  - **destinationCurrency** (string) - The destination currency for the transaction.

#### Response Example
```json
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "parentTransactionId": "f8033cf6-befa-47f4-a48a-b915b8c72a71",
    "redirectUrl": "https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet?mid=",
    "imageUrl": "https://notifications.zen-test.com/eps/image/567afec2-6189-4731-9cb3-c6d4bb4fd345/1579592876",
    "merchantAction": {
        "action": "REDIRECT",
        "data": {
            "redirectUrl": "http://example.com"
        }
    },
    "merchantTransactionId": "string",
    "originMerchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
    "amount": "123.04",
    "currency": "PLN",
    "fee": {
        "amount": "123.04",
        "currency": "EUR"
    },
    "subsidiaryData": {
        "feeAmount": "123.04",
        "grossAmount": "123.04"
    },
    "authorization": {
        "amount": "string",
        "currency": "string",
        "fee": "string"
    },
    "createdAt": "2019-08-24T14:15:22.123Z",
    "modifiedAt": "2019-08-24T14:15:22.123Z",
    "type": "TRT_REFUND",
    "status": "ACCEPTED",
    "topupTransferStatus": "ACCEPTED",
    "paymentChannel": "PCL_CARD",
    "actions": {
        "refund": false,
        "cancel": false,
        "capture": true,
        "redirect": true,
        "authorization": true,
        "selectOffer": true,
        "renewOffers": true
    },
    "fraudFields": {
        "property1": "string",
        "property2": "string"
    },
    "rejectCode": "E40199",
    "rejectReason": "Client doesn't have enough money.",
    "refunds": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "merchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
            "originMerchantTransactionId": "23beb187-f8a3-44b8-9ef8-b31180358dd3",
            "amount": "123.04",
            "currency": "PLN",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "status": "ACCEPTED"
        }
    ],
    "meta": {
        "selectedOffer": {
            "pspId": "string",
            "expirationDate": "string",
            "amountToWithdraw": "string",
            "cryptoAmount": "string",
            "cryptoNetworkFee": "string",
            "termsUrl": "string",
            "blikBuid": "string"
        },
        "payoutBtcAddress": "1HB5XDDddDDdDDDj6mfBsbifRoD4miY36v",
        "btcAmount": "10",
        "feeOwner": "partner",
        "returnUrl": "https://pay.g2a.com/checkout?",
        "customIpnUrl": "https://ipn-pay.g2a.com/ipn",
        "returnVerifyUrl": "https://zen.com/returnUrlAfter3ds",
        "avsResult": "string",
        "cvvResult": "string",
        "authorisationCode": "string",
        "resultCode": "string",
        "threeDs": {
            "xid": "string",
            "version": "string",
            "eci": "string",
            "cavv": "string",
            "cavvAlgorithm": "string",
            "emv3DSFlow": "string",
            "status": "string",
            "cardHolderInfo": "string",
            "errorData": {
                "component": "string",
                "description": "string",
                "detail": "string"
            }
        },
        "destinationCurrency": "string"
    }
}
```

```
Tokens:
Raw