Credit2Crypto
CREDIT2CRYPTO request
CREDIT2CRYPTO request is used to create CREDIT transaction in Payment Platform.
This operation transfers funds from merchant's crypto wallet to customer.
This request is sent by POST in the background (e.g., through PHP CURL).
Request parameters
| Parameter | Description | Values | Required |
|---|---|---|---|
action | CREDIT2CRYPTO | CREDIT2CRYPTO | + |
client_key | Unique client key (CLIENT_KEY) | + | |
channel_id | Payment channel (Sub-account) | String up to 16 characters | - |
brand | Brand through which the transaction is performed | String up to 36 characters | + |
order_id | Order ID in the Clients system | String up to 255 characters | + |
order_amount | The amount of the transaction | Format depends on currency | + |
order_currency | Crypto currency | alpha code, from 3 to 6 characters | + |
order_description | Description of the transaction (product name) | String up to 1024 characters | + |
crypto_network | Blockchain network | String up to 50 characters You can use an arbitrary value or choose one of the following: • ERC20 • TRC20 • BEP20 • BEP2 • OMNI • solana • polygon | - |
parameters | Array of the parameters for specific brand | (Appendix C) | - |
return_url | If the optional parameter return_url is not provided in the request, the customer will be redirected to the default 'Thank You' page after the payment process. This page includes an option to send the receipt to the customer's email | Example: https://example.domain.com | - |
hash | Special signature to validate your request to Payment Platform | See Appendix A, Credit2Virtual signature. | + |
Response Parameters
You will get JSON encoded string with transaction result.
Synchronous - INIT transaction response (for crypto flow)
| Parameter | Description |
|---|---|
action | CREDIT2CRYPTO |
result | INIT / UNDEFINED / DECLINED |
status | PENDING if success PREPARE if undefined status DECLINED if fail |
order_id | Order ID in the Client’s system |
trans_id | Transaction ID in the Payment Platform |
trans_date | Transaction date in the Payment Platform |
descriptor | Additional payment description |
amount | Order amount |
currency | Currency |
Callback Parameters
Callback - INIT transaction response
| Parameter | Description |
|---|---|
action | CREDIT2CRYPTO |
result | INIT |
status | PENDING if success DECLINED if fail |
order_id | Order ID in the Client’s system |
trans_id | Transaction ID in the Payment Platform |
trans_date | Transaction date in the Payment Platform |
descriptor | Additional payment description |
amount | Order amount |
currency | Currency |
Callback - Successful response
| Parameter | Description |
|---|---|
action | CREDIT2CRYPTO |
result | SUCCESS |
status | SETTLED |
order_id | Order ID in the Client’s system |
trans_id | Transaction ID in the Payment Platform |
amount | Order amount |
currency | Currency |
trans_date | Transaction date in the Payment Platform |
Callback - Unsuccessful response
| Parameter | Description |
|---|---|
action | CREDIT2CRYPTO |
result | DECLINED |
status | DECLINED |
order_id | Order ID in the Client’s system |
trans_id | Transaction ID in the Payment Platform |
amount | Order amount |
currency | Currency |
trans_date | Transaction date in the Payment Platform |
decline_reason | The reason why the transaction was declined |
Callback - Undefined response
| Parameter | Description |
|---|---|
action | CREDIT2CRYPTO |
result | UNDEFINED |
status | PREPARE / PENDING |
order_id | Order ID in the Client’s system |
trans_id | Transaction ID in the Payment Platform |
trans_date | Transaction date in the Payment Platform |
amount | Order amount |
currency | Currency |