Hosted Frame Generation

Frame generation is the easiest way of the deposit integration. You can use this method to generate a URL for the deposit page.

curl -X POST 'https://sandbox.paybin.io/v2/frame/generate/url' \
  -H 'X-Api-Key: {SecretKey}' \
  -H 'Content-Type: application/json' \
  --data '{
    ReferenceId: '1234567890',
    PublicKey: {PublicKey},
    Currency: 'JPY',//for metamask depositors
    Amount: '1000,00', //for metamask depositors
    Language: locale, //Current supported languages are EN,TR,JA,DE,ES,FR,PT
    Symbol: symbol,
    CallbackUrl: ``,
    RedirectUrl: ``
}'

All signed requests must include the following headers. Signed token will expire in 1 minute.

Current supported languages are EN,TR,JA,DE,ES,FR,PT

Get Address

This API endpoint allows you to retrieve a deposit address for a specified cryptocurrency. The deposit address can then be displayed within your application for users to make deposits.

Endpoint

POST https://sandbox.paybin.io/v1/deposit

Request Headers

• Token: Your API token for authentication.
• Content-Type: Set to application/json.

Request Body Parameters

• PublicKey (string): Your public key.
• Symbol (string): The symbol of the cryptocurrency (e.g., BTC, ETH, USDT, See all Symbols )
• ReferenceId (string): A reference ID for the payment or user.
• CallbackUrl (string, optional): URL for callback notifications.
• Label (string, optional): A label for the address.
• Hash (string): A hash generated for security.

Hash Generation

The hash is created using the following fields concatenated together: PublicKey, Symbol, Label, ReferenceId, CallbackUrl, and a secretKey. The hash ensures the integrity and authenticity of the request.

CryptoJS.MD5(publicKey + data.Symbol + data.Label + data.ReferenceId + data.CallbackUrl + secretKey).toString();

curl --location 'https://sandbox.paybin.io/v1/deposit' \
--header 'Token: {TOKEN}' \
--header 'Content-Type: application/json' \
--data '{
    "PublicKey":"{PublicKey}",
    "Symbol":"ETH", //Required BTC, ETH, USDT, etc.
    "ReferenceId":"PaymentOrUserReference", //Required
    "CallbackUrl":"", //Optional
    "Label":"Label", //Optional
    "Hash":"{Hash}"
}'