GET POST

/transaction/create

Allows you to create a transaction.

Query Params / Form Data

key string required
abcdefghijklmnopqrstuvwxyz0123

Contains your API key.
Get it from here.

amount decimal required
100.00

The amount of the transaction in the selected currency.
This value must be in the currency specified by the `currency` parameter.

currency string required

The currency of the transaction.

allowed_payment_methods string
ppl,btc,bch,ltc,xmr,xec,dog,dsh,xrp,eth

A comma-separated list of allowed payment methods for this transaction.
If only one payment method is allowed the payment method selection dialog will be skipped at checkout.

webhook string
https://example.com/status

The URL to notify when a transaction event occurs.
More info about webhooks can be found here.

Response JSON

status string required

Indicates the result of the API request.
For more details about error handling, check here.

transaction_id string required
abcdefghijklmnopqrstuvwxyz0123

The unique ID for the created transaction. It is public.

private_key string required
abcdefghijklmnopqrstuvwxyz0123

A private key associated with the transaction. Keep it private.

GET POST

/transaction/setpaymentmethod

Allows you to set the payment method for an existing transaction.

Query Params / Form Data

transaction_id string required
abcdefghijklmnopqrstuvwxyz0123

The unique ID for the transaction to be updated.

payment_method string required

The payment method to be set for the transaction.

Response JSON

status string required

Indicates the result of the API request.
For more details about error handling, check here.

GET POST

/transaction/cancel

Allows you to cancel a pending transaction.

Query Params / Form Data

transaction_id string required
abcdefghijklmnopqrstuvwxyz0123

The unique ID for the transaction to be cancelled.

Response JSON

status string required

Indicates the result of the API request.
For more details about error handling, check here.

GET POST

/transaction/info

Allows you to retrieve information about a transaction.

Query Params / Form Data

key string
abcdefghijklmnopqrstuvwxyz0123

Optional API key for accessing private transaction information.
If not provided, only public information will be returned.

transaction_id string required
abcdefghijklmnopqrstuvwxyz0123

The unique ID for the transaction whose information is to be retrieved.

Response JSON

status string required

Indicates the result of the API request.
For more details about error handling, check here.

uid string required
abcdefghijklmnopqrstuvwxyz0123

The unique ID of the transaction.

seller_id string required
abcdefghijklmnopqrstuvwxyz0123

The ID of the seller involved in the transaction.

status string required

The current status of the transaction.

amount_topay decimal required
100.00

The total amount of the transaction that needs to be paid.

amount_paid decimal required
100.00

The amount already paid for the transaction.

currency string required
USD

The currency used for the transaction.

allowed_payment_methods array
["ppl", "btc", "bch", "ltc", "xmr", "xec", "dog", "dsh", "xrp", "eth"]

An array of allowed payment methods for this transaction.

created timestamp required
1622899200

The timestamp when the transaction was created.

expires timestamp required
1623580800

The expiration timestamp of the transaction.

cancelled timestamp
1623000000

The timestamp when the transaction was cancelled, if applicable.

completed timestamp
1623010000

The timestamp when the transaction was completed, if applicable.

payment object
payment method specific

Payment details associated with the transaction, if applicable.

private_key string required with api key
abcdefghijklmnopqrstuvwxyz0123

A private key associated with the transaction.
Only returned if a valid API key was provided.

webhook string optional with api key
https://yourdomain.com/webhook

The URL of the webhook to notify when the status changes.
Only returned if a valid API key was provided.