Unlimit API

https://integration.unlimit.com/api-reference/
Admin
The Unlimit API is a RESTful payment API that allows merchants to process online payments, refunds,...
Tokens:81,704
Snippets:544
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get payment and payout methods response example

Source: https://integration.unlimit.com/api-reference/3a07b2e28ab37-get-payment-and-payout-methods

Example JSON response showing the structure of payment and payout methods, including categories and supported methods.

```json
1
{
2
  "payment_methods": [
3
    {
4
      "category": "eWallet",
5
      "name": "ALIPAYPLUS",
6
      "supported_payment_methods": [
7
        {
8
          "logo": "https://gw.alipay.com/icon/medium/default/GCASH.svg",
9
          "name": "GCash"
10
        }
11
      ]
12
    }
13
  ],
14
  "payout_methods": [
15
    {
16
      "category": "eWallet",
17
      "name": "ALIPAYPLUS"
18
    }
19
  ]
20
}
```

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

### Get plans information response example

Source: https://integration.unlimit.com/api-reference/4e6f0833f6219-get-plans-information

Example JSON response returned by the API when successfully retrieving recurring plans.

```json
1
{
2
  "data": [
3
    {
4
      "id": "327373",
5
      "name": "Plan name",
6
      "created": "2018-08-28T09:09:49Z",
7
      "status": "ACTIVE",
8
      "period": "month",
9
      "interval": 1,
10
      "currency": "USD",
11
      "amount": 100,
12
      "retries": 3,
13
      "pricing_model": "string",
14
      "quantity": {
15
        "starting_quantity": 1,
16
        "ending_quantity": 1,
17
        "price_per_unit": 0
18
      },
19
      "subscription_decline_logic": {
20
        "status_to": "string",
21
        "duration": 0,
22
        "continue_retries": true
23
      }
24
    }
25
  ],
26
  "has_more": true,
27
  "subscription_decline_logic": {
28
    "status_to": "string",
29
    "duration": 0,
30
    "continue_retries": true
31
  }
32
}
```

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

### Get list of refunds response example

Source: https://integration.unlimit.com/api-reference/7fa126bc9f1b2-get-list-of-refunds

A sample JSON response body returned by the GET /api/refunds endpoint.

```json
1
{
2
  "data": [
3
    {
4
      "card_account": {
5
        "card_brand": "Visa",
6
        "card_type": "DEBIT",
7
        "issuer": "Bank Issuer",
8
        "issuing_country_code": "US",
9
        "masked_pan": "400000...0002"
10
      },
11
      "customer": {
12
        "email": "customer@example.com",
13
        "id": "373278232",
14
        "ip_country": "CY",
15
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_1_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1.2 Mobile/15E148 Safari/604"
16
      },
17
      "ewallet_account": {
18
        "id": "string"
19
      },
20
      "merchant_order": {
21
        "description": "Premium Cotton T-Shirt",
22
        "id": "256437"
23
      },
24
      "payment_data": {
25
        "id": "373278232",
26
        "remaining_amount": 10.43
27
      },
28
      "payment_method": "BANKCARD",
29
      "refund_data": {
30
        "amount": 21.12,
31
        "arn": "12345678901234567890123",
32
        "auth_code": "AB73F9",
33
        "created": "2018-08-28T09:09:49Z",
34
        "currency": "USD",
35
        "decline_code": "02",
36
        "decline_reason": "Cancelled by customer",
37
        "extended_decline_reason": "05: Do not honor transaction",
38
        "id": "299150",
39
        "is_3d": true,
40
        "rrn": "4367237627623",
41
        "status": "DECLINED"
42
      }
43
    }
44
  ],
45
  "has_more": true
46
}
```

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

### Get limits information response example

Source: https://integration.unlimit.com/api-reference/0b02f66b9bd45-get-limits-information

Example of the JSON response body containing the remaining withdrawal limits.

```json
1
{
2
  "remaining_limits": {
3
    "EUR": 100,
4
    "USD": 200
5
  }
6
}
```

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

### Get invoice information response example

Source: https://integration.unlimit.com/api-reference/2d7ebbb058a2b-get-invoice-information

A sample JSON response returned by the API when successfully retrieving invoice details.

```json
{
  "invoice_data": {
    "id": "nxrHnLJ1",
    "amount": 12.23,
    "currency": "EUR",
    "expire_at": "2022-08-09T18:31:42+03:30",
    "status": "ACTIVE"
  },
  "merchant_order": {
    "id": "12233454",
    "items": [
      {
        "name": "string",
        "price": 12.23,
        "count": 1
      }
    ]
  },
  "customer": {
    "phone": "9008003435",
    "email": "example@mail.com"
  },
  "invoice_url": "https://unlimint.com/invoice/nxrHnLJ1"
}
```

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

### Subscription Response Example

Source: https://integration.unlimit.com/api-reference/721c84709a57e-get-subscriptions-information

Example JSON response body returned when successfully querying the subscriptions list.

```json
1
{
2
  "data": [
3
    {
4
      "amount_due": 100,
5
      "amount_total": 100,
6
      "created": "2018-10-28T09:09:53Z",
7
      "currency": "USD",
8
      "customer": {
9
        "email": "customer@example.com",
10
        "id": "ABCXYZ1234567890"
11
      },
12
      "description": "Service subscription",
13
      "id": "32323223",
14
      "interval": 1,
15
      "is_payment_date_shifted": true,
16
      "next_payment": {
17
        "date": "2019-04-22"
18
      },
19
      "payments_due": 10,
20
      "pending_plan_update": {
21
        "date": "2023-04-22",
22
        "id": "pX1527CS"
23
      },
24
      "period": "month",
25
      "plan": {
26
        "id": "lj1169BJ"
27
      },
28
      "retries": 3,
29
      "status": "INACTIVE",
30
      "status_reason": "Common decline",
31
      "subscription_start": "2019-04-22",
32
      "type": "ONECLICK",
33
      "units": 0
34
    }
35
  ],
36
  "has_more": true
37
}
```

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

### X-Sign Calculation and Authorization Header Example

Source: https://integration.unlimit.com/api-reference/5587sjsdwg45e-api-tokens-obtaining

This example demonstrates the calculation of the X-Sign hash using the specified parameters and the resulting Authorization header format.

```text
X-Sign = sha256( 'f23bf4b2-4887-4160-95b6-a4024761683c' + '/api/payments/29574221' + '' + 'queryString' + '5d69de1e-f433-4561-a3e4-0b6bdbf51ca1') = d028c0b0c54b28af4e4fa6f65ce03a28621da70d5ece99f8832d6953f9f0af78
Authorization: Signature 13123,c8033ff0-7ea4-4cad-90e6-17c69b67a851,f23bf4b2-4887-4160-95b6-a4024761683c,d028c0b0c54b28af4e4fa6f65ce03a28621da70d5ece99f8832d6953f9f0af78
```

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

### Update Payment Response Example

Source: https://integration.unlimit.com/api-reference/99a98b3f0344d-update-payment

A JSON example of the response returned after an update payment request.

```json
{
  "merchant_order": {
    "description": "Premium Cotton T-Shirt",
    "id": "256437"
  },
  "operation": "CHANGE_STATUS",
  "payment_data": {
    "details": "Declined by bank",
    "id": "32444533434",
    "is_executed": false,
    "status": "DECLINED",
    "status_to": "REVERSE",
    "updated": "2018-10-28T09:09:53Z"
  }
}
```

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

### Get plan information response example

Source: https://integration.unlimit.com/api-reference/433ba39d50c4e-get-plan-information

This JSON object represents the structure of the response returned when successfully querying a recurring plan.

```json
1
{
2
  "plan_data": {
3
    "id": "327373",
4
    "name": "Plan name",
5
    "created": "2018-08-28T09:09:49Z",
6
    "status": "ACTIVE",
7
    "period": "month",
8
    "interval": 1,
9
    "currency": "USD",
10
    "amount": 100,
11
    "retries": 3,
12
    "pricing_model": "string",
13
    "quantity": {
14
      "starting_quantity": 1,
15
      "ending_quantity": 1,
16
      "price_per_unit": 0
17
    },
18
    "subscription_decline_logic": {
19
      "status_to": "string",
20
      "duration": 0,
21
      "continue_retries": true
22
    }
23
  }
24
}
```

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

### Get Card Information Response Example

Source: https://integration.unlimit.com/api-reference/0567f2013c8ec-get-card-information

The expected JSON response containing an array of card details including brand, issuer, type, and country.

```json
[
  {
    "bin": "12345678",
    "card_brand": "VISA",
    "card_issuer": "CJSC NGA BANK",
    "card_type": "DEBIT",
    "country": "NG"
  }
]
```

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

### Get Banks List Request

Source: https://integration.unlimit.com/api-reference/dk50x8tu2w259-banks-list

Example cURL request to retrieve the list of banks for a specified method and currency.

```shell
curl --request GET \
  --url 'https://sandbox.cardpay.com/api/banks/method/currency?country=CY' \
  --header 'Accept: application/json'
```

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

### Get Banks List Response

Source: https://integration.unlimit.com/api-reference/dk50x8tu2w259-banks-list

Example JSON response body containing the list of banks.

```json
1
{
2
  "bank_list": [
3
    {
4
      "bank_code": 1052,
5
      "bank_name": "BANCO AV VILLAS"
6
    }
7
  ]
8
}
```

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

### Refund Response Example

Source: https://integration.unlimit.com/api-reference/32dc9d1915c76-create-refund

Example of a JSON response returned by the API, showing the status of the refund.

```json
{
  "card_account": {
    "card_brand": "Visa",
    "card_type": "DEBIT",
    "issuer": "Bank Issuer",
    "issuing_country_code": "US",
    "masked_pan": "400000...0002"
  },
  "customer": {
    "email": "customer@example.com",
    "id": "373278232",
    "ip_country": "CY",
    "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_1_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1.2 Mobile/15E148 Safari/604"
  },
  "ewallet_account": {
    "id": "string"
  },
  "merchant_order": {
    "description": "Premium Cotton T-Shirt",
    "id": "256437"
  },
  "payment_data": {
    "id": "373278232",
    "remaining_amount": 10.43
  },
  "payment_method": "BANKCARD",
  "refund_data": {
    "amount": 21.12,
    "arn": "12345678901234567890123",
    "auth_code": "AB73F9",
    "created": "2018-08-28T09:09:49Z",
    "currency": "USD",
    "decline_code": "02",
    "decline_reason": "Cancelled by customer",
    "extended_decline_reason": "05: Do not honor transaction",
    "id": "299150",
    "is_3d": true,
    "rrn": "4367237627623",
    "status": "DECLINED"
  }
}
```

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

### Gateway Mode Response Example

Source: https://integration.unlimit.com/api-reference/83ac95d0eaa7a-create-payment

Example response received when using Gateway mode, containing the redirect URL and payment ID.

```json
{
  "redirect_url": "https://sandbox.cardpay.com/MI/payments/redirect?token=B7cfhc65D0Eb7beg5af2FCbb",
  "payment_data": {
    "id": "15554619"
  }
}
```

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

### Initiate Reports Preparation cURL Request

Source: https://integration.unlimit.com/api-reference/07a0b977e4ab8-initiate-the-reports-preparation

Example cURL command to initiate the reports preparation process by sending a POST request to the sandbox environment.

```bash
curl --request POST \
  --url https://sandbox.cardpay.com/api/reports \
  --header 'Accept: */*' \
  --header 'Content-Type: application/json' \
  --data '{
  "callback_url": "https://www.example.com/report-url",
  "reports_data": {
    "end_date": "2021-03-08",
    "report_type": [
      "regular_settlement",
      "icpp_settlement"
    ],
    "start_date": "2021-03-01"
  },
  "request": {
    "id": "1",
    "time": "2022-03-20T09:09:49Z"
  }
}'
```

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

### Create Payment cURL Request

Source: https://integration.unlimit.com/api-reference/83ac95d0eaa7a-create-payment

Example cURL command to initiate a payment request to the sandbox environment.

```bash
curl --request POST \
  --url https://sandbox.cardpay.com/api/payments \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "request": {
    "id": "297c47e8-bc75-4189-80ec-da66e18cab55",
    "time": "2023-11-28T18:13:47.509Z"
  },
  "merchant_order": {
    "id": "ad466842-4b74-4c18-9314-e3f8f15ed183",
    "description": "Postman Collection Order ('\''Create payment with card tokenization'\'')"
  },
  "payment_method": "BANKCARD",
  "payment_data": {
    "amount": "12.35",
    "currency": "USD",
    "generate_token": true
  },
  "customer": {
    "email": "customer@email.com"
  },
  "card_account": {
    "card": {
      "pan": "4000000000000085",
      "holder": "Mrs. Rolando Kuhic",
      "expiration": "11/2028",
      "security_code": "100"
    }
  }
}'
```

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

### Get payments information default response

Source: https://integration.unlimit.com/api-reference/cf370d816486e-get-payments-information

An example of the default JSON response structure returned by the API.

```json
1
{
2
  "data": [
3
    {
4
      "payment_method": "BANKCARD",
5
      "merchant_order": {
6
        "id": "614f7908-00b0-4547-880e-57ee86c26588",
7
        "description": "Sandbox order"
8
      },
9
      "payment_data": {
10
        "id": "16868709\",
11
        "type": "PAYMENT",
12
        "status": "DECLINED",
13
        "amount": 12.34,
14
        "currency": "USD",
15
        "created": "2024-08-27T16:30:46Z",
16
        "decline_reason": "Cancelled by customer",
17
        "decline_code": 2,
18
        "is_3d": false,
19
        "original_amount": 12
20
      },
21
      "card_account": {
22
        "masked_pan": "400000...0077",
23
        "holder": "STELLA CHANEY",
24
        "issuing_country_code": "US"
25
      },
26
      "customer": {
27
        "email": "customer@email.com",
28
        "ip": "45.93.134.49\",
29
        "locale": "en"
30
      }
31
    }
32
  ]
33
}
```

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

### Update Refund Response Example

Source: https://integration.unlimit.com/api-reference/d5a1a7413ae71-update-refund

A sample JSON response returned after a successful or processed update request.

```json
1
{
2
  "merchant_order": {
3
    "description": "Premium Cotton T-Shirt",
4
    "id": "256437"
5
  },
6
  "refund_data": {
7
    "details": "Declined by bank",
8
    "id": "32444533434",
9
    "is_executed": false,
10
    "status": "DECLINED",
11
    "status_to": "REVERSE",
12
    "updated": "2018-10-28T09:09:53Z"
13
  }
14
}
```

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

### Get change subscription status claim response

Source: https://integration.unlimit.com/api-reference/562ae11c0d0f2-get-information-about-change-subscription-status-claim

Example JSON response body returned when successfully querying a change subscription status claim.

```json
{
  "created": "2019-04-22",
  "details": "Change details",
  "id": "322323",
  "status": "IN_PROCESS",
  "subscription_data": {
    "id": "234432323",
    "status_to": "ACTIVE"
  },
  "updated": "2019-04-23"
}
```

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

### Create Payout Response Example

Source: https://integration.unlimit.com/api-reference/7c2fed10fa5c4-create-payout

This JSON object represents a sample response for a payout request that has been declined.

```json
{
  "card_account": {
    "card_brand": "Visa",
    "card_type": "DEBIT",
    "expiration": "11/2022",
    "holder": "John Smith",
    "issuer": "Bank Issuer",
    "issuing_country_code": "US",
    "masked_pan": "400000...0002",
    "token": "C526Hg8h0e5BBeD42g7CFhf24RfgVb29aXcv"
  },
  "customer": {
    "email": "customer@example.com",
    "id": "373278232",
    "ip_country": "CY",
    "phone": "+15417543010",
    "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_1_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1.2 Mobile/15E148 Safari/604"
  },
  "ewallet_account": {
    "id": "34346363623"
  },
  "payment_data": {
    "id": "362727264"
  },
  "payout_data": {
    "amount": 24.36,
    "arn": "12345678901234567890123",
    "created": "2018-08-27T09:10:51Z",
    "currency": "EUR",
    "decline_code": "02",
    "decline_reason": "Cancelled by customer",
    "extended_decline_reason": "05: Do not honor transaction",
    "id": "4237264",
    "note": "Payout note",
    "rrn": "324343834382",
    "status": "DECLINED"
  },
  "redirect_url": "http://www.example.com",
  "payment_method": "BANKCARD",
  "merchant_order": {
    "description": "Premium Cotton T-Shirt",
    "id": "256437"
  },
  "additional_data": {
    "extra_key_1": "string",
    "extra_key_2": "string"
  }
}
```

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

### Get disputes information by payment id response example

Source: https://integration.unlimit.com/api-reference/6c20759a66d0e-get-disputes-information-by-payment-id

This JSON object represents the successful response structure containing a list of dispute data for the requested payment.

```json
1
{
2
  "data": [
3
    {
4
      "card_account": {
5
        "card": {
6
          "card_brand": "visa",
7
          "masked_pan": "400000...0002"
8
        }
9
      },
10
      "customer": {
11
        "email": "customer@example.com"
12
      },
13
      "dispute_data": {
14
        "due_time": "2020-11-08T09:09:49Z",
15
        "group_id": "1234567",
16
        "reason_code": "12.2",
17
        "reason_description": "Incorrect Transaction Code",
18
        "reg_time": "2020-10-28T09:09:49Z",
19
        "result_time": "2020-11-28T09:09:49Z",
20
        "stage": "Chargeback",
21
        "status": "Open",
22
        "type": "CB"
23
      },
24
      "merchant_order": {
25
        "id": "3273282",
26
        "website_url": "example.website.com"
27
      },
28
      "payment_data": {
29
        "amount": "123.12",
30
        "arn": "string",
31
        "auth_code": "string",
32
        "created": "2020-08-28T09:09:49Z",
33
        "currency": "EUR",
34
        "id": "1234567"
35
      }
36
    }
37
  ],
38
  "has_more": true
39
}
```

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

### Barcode Extended Data Example

Source: https://integration.unlimit.com/api-reference/9j4rmuhuxj8ub-extended-data-for-extended-payment-response

Example JSON structure containing barcode-related fields for BOLETO payments.

```json
{
  "barcode": "0339955734548000000091234554420000030050",
  "due_date": "2022-04-22",
  "pdf_url": "https://sandbox.cardpay.com/pdf-url",
  "typeable_line": "34191.75462 24615.783234 41534.510700 3 83840080003090"
}
```

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

### Create Refund Request

Source: https://integration.unlimit.com/api-reference/32dc9d1915c76-create-refund

Use this cURL command to initiate a refund request to the sandbox environment.

```bash
curl --request POST \
  --url https://sandbox.cardpay.com/api/refunds \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "request": {
    "id": "1",
    "time": "2022-03-20T09:09:49Z"
  },
  "customer": {
    "email": "customer@example.com",
    "full_name": "John Smith",
    "identity": "231.002.999-00"
  },
  "ewallet_account": {
    "bank_branch": "7197",
    "bank_code": "001",
    "id": "47634374834",
    "type": "1"
  },
  "merchant_order": {
    "description": "Return order",
    "id": "4333232"
  },
  "payment_data": {
    "id": "362727264"
  },
  "refund_data": {
    "amount": 10.45,
    "currency": "USD"
  }
}'
```
Tokens:
Raw