Hello Clever Developer Docs

POST

payin_links

curl --request POST \
  --url https://api.cleverhub.co/api/v3/payin_links \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "amount": 100000,
  "payin_method_code": "vn_vietqr_vnd",
  "expires_in": null,
  "description": "Top-up wallet",
  "external_id": "123456",
  "redirect_url": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "webhook_notification": {
    "endpoint_url": "https://example.com/webhook",
    "authorization_header": "Header 123456789"
  },
  "sender_info": {
    "email": "email@gmail.com",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "male",
    "contact_type": "individual",
    "dob": "1990-01-01",
    "reg_no": "A1234567",
    "state": "Ho Chi Minh",
    "user_id": "user_12345",
    "upi_id": "johndoe@upi",
    "phone": "0123456789",
    "country_code": "VN",
    "address": "123 abc",
    "city": "Ho Chi Minh City",
    "postal_code": "700000",
    "account_name": "John Doe",
    "account_number": "233240000000",
    "bank_code": "VCB",
    "document_type": "passport",
    "document_number": "P123456789"
  },
  "metadata": {
    "custom_note": "Priority customer"
  },
  "create_payment_link_jpy_example": {
    "amount": 100000,
    "payin_method_code": "jp_bank_jpy",
    "expires_in": null,
    "description": "Top-up wallet",
    "external_id": "123456",
    "redirect_url": {
      "success": "https://example.com/success",
      "failure": "https://example.com/failure"
    },
    "webhook_notification": {
      "endpoint_url": "https://example.com/webhook",
      "authorization_header": "Header 123456789"
    },
    "sender_info": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "metadata": {
      "transliterate": true
    }
  }
}
'

{
  "uuid": "Z2Q3FWBW",
  "payment_url": "https://example.com/ZSxw187",
  "expires_at": "2025-07-24T16:00:00Z"
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "message": "Email is missing in sender information"
  }
}

Authorizations

app-id

string

header

required

A unique identifier assigned to each application.

secret-key

string

header

required

A secure token associated with the app-id.

Body

application/json

amount

number

required

Transaction amount.

description

string

required

Description of the payment transaction

sender_info

object

required

Information about the customer.

Show child attributes

payin_method_code

string

Specific payin method code to be used for this payment. You will receive this from the Get payment methods API Optional — if not provided, user will choose from available methods.

expires_in

integer

Expiration time of transaction (seconds). Default: 1800 (30 min), Min: 900 (15 min).

external_id

string

Custom ID.

redirect_url

object

Show child attributes

webhook_notification

object

Webhook configuration for transaction status updates

Show child attributes

metadata

object

Optional custom metadata to attach to the transaction.

Show child attributes

allocation_profile

object

Optional. Splits the payin across Payments Accounts with a platform fee (Clever Connect, Dedicated Balance only, and fund splitting must be enabled for the currency). See Platform Fees.

Show child attributes

Response

Payin link created successfully

uuid

string

Unique identifier for the payment transaction.

payment_url

string<uri>

URL of the created payment link where the merchant can complete the payment.

expires_at

string<date-time>

Expiration time (ISO 8601 UTC) of the payment link

curl --request POST \
  --url https://api.cleverhub.co/api/v3/payin_links \
  --header 'Content-Type: application/json' \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>' \
  --data '
{
  "amount": 100000,
  "payin_method_code": "vn_vietqr_vnd",
  "expires_in": null,
  "description": "Top-up wallet",
  "external_id": "123456",
  "redirect_url": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "webhook_notification": {
    "endpoint_url": "https://example.com/webhook",
    "authorization_header": "Header 123456789"
  },
  "sender_info": {
    "email": "email@gmail.com",
    "first_name": "John",
    "last_name": "Doe",
    "gender": "male",
    "contact_type": "individual",
    "dob": "1990-01-01",
    "reg_no": "A1234567",
    "state": "Ho Chi Minh",
    "user_id": "user_12345",
    "upi_id": "johndoe@upi",
    "phone": "0123456789",
    "country_code": "VN",
    "address": "123 abc",
    "city": "Ho Chi Minh City",
    "postal_code": "700000",
    "account_name": "John Doe",
    "account_number": "233240000000",
    "bank_code": "VCB",
    "document_type": "passport",
    "document_number": "P123456789"
  },
  "metadata": {
    "custom_note": "Priority customer"
  },
  "create_payment_link_jpy_example": {
    "amount": 100000,
    "payin_method_code": "jp_bank_jpy",
    "expires_in": null,
    "description": "Top-up wallet",
    "external_id": "123456",
    "redirect_url": {
      "success": "https://example.com/success",
      "failure": "https://example.com/failure"
    },
    "webhook_notification": {
      "endpoint_url": "https://example.com/webhook",
      "authorization_header": "Header 123456789"
    },
    "sender_info": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "metadata": {
      "transliterate": true
    }
  }
}
'

{
  "uuid": "Z2Q3FWBW",
  "payment_url": "https://example.com/ZSxw187",
  "expires_at": "2025-07-24T16:00:00Z"
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "message": "Email is missing in sender information"
  }
}

Basics

Payment APIs

Card API

Cashback API

Reporting API

Create PayIn

Authorizations

Body

Response