CoinbarPay Official Docs
  • Introduction
    • πŸ”΅Coinbar Pay
    • πŸ”΅Key Features
    • πŸ”΅Target Audience
    • πŸ”΅Security and Compliance
  • Getting Started
    • πŸ”΅Summary
  • Service Activation
    • πŸ”΅Create Account
    • πŸ”΅Account Verification
    • πŸ”΅Activate Service
  • Point of Sale
    • πŸ”΅App Installation
    • πŸ”΅App Activation
    • πŸ”΅User Interface
    • πŸ”΅Accepting Payments
    • πŸ”΅Transactions & Reports
  • E-Commerce Plugins
    • πŸ”΅Introduction
    • πŸ”΅Downloads - Plugin
      • ⏺️Wordpress/WooCommerce
      • ⏺️Magento
      • ⏺️Request New
    • πŸ”΅Setup and Configuration
    • πŸ”΅Try your service
  • API Web Integration
    • πŸ”΅Introduction
    • πŸ”΅Service Configuration
    • πŸ”΅API Keys Management
    • πŸ”΅Payment Flow
    • πŸ”΅Payment Statuses
    • πŸ”΅API Documentation
      • ⏺️Authentication
      • ⏺️Request New Payment (web page)
      • ⏺️Payment Gateway
      • ⏺️Get Conversion Quotes (server-to-server)
      • ⏺️Execute Payment External Platform (server-to-server)
      • ⏺️Get Payment Status (server-to-server)
      • ⏺️Reports
    • πŸ”΅Sandbox Enviroment
  • Dashboard Platform
    • πŸ”΅Overview
    • πŸ”΅Manage...
      • ⏺️Payments
      • ⏺️Settlements
    • πŸ”΅Refunds & Assistance
    • πŸ”΅Reports & Exports
Powered by GitBook
On this page
  • Create request token
  • Generate a new payment request token
  • Products body element:
  1. API Web Integration
  2. API Documentation

Request New Payment (web page)

To initiate a new payment request using the CoinbarPay API, you will need to provide specific parameters and call the appropriate endpoint.

Upon successfully processing this request, the CoinbarPay API will return a payment request token that you can use to initiate the payment process through the CoinbarPay Web Gateway, as described in the "Payment Flow" topic.

Create request token

To make the API request, use the following :

Generate a new payment request token

POST https://sandbox.coinbar.io/coinbar/api/v2/pay/gateway/request

Headers

Name
Type
Description

CBPAY-API-KEY*

String

{{SERVICE_CLIENT_ID}}

Content-Type*

String

application/json

SIGNATURE*

String

{{SIGNATURE_TOKEN}} HMAC SHA-256 body validation

source*

String

String "web"

Request Body

Name
Type
Description

service_client_id*

String

{{SERVICE_CLIENT_ID}}

payment_request_id*

String

Generated by Your application

input_coin*

String

"EUR"

products*

Array

Products, can be provided products details or just one product with total billing receipt. See the section below for more details

email*

String

Customer email

surname

String

Customer Last Name

name

String

Customer Name

user_id*

String

Generated by Your application

timestamp*

Number

TIMESTAMP of your request in milliseconds

urlcallback

String

Custom webhook -- obslolete parameter

{
    "result": "success",
    "request_token": "WlpZSkE3d3ZKa2NSTTl0VHNKTT....",
    "url_example": "?requestToken=WlpZSkE3d3ZKa2NSTTl0VHNKTTF...."
}

Products body element:

Here's an example of products JSON body parameter :

"products": [
    {
      "product_name": "Product 1",
      "product_price": 1.99,
      "product_amount": 1,
      "product_id": "id1",
      "product_type": "general"
    },
    {
      "product_name": "Product 2",
      "product_price": 0.99,
      "product_amount": 2,
      "product_id": "id2",
      "product_type": "general"
    }
]

Valid response will contain request_token , that will be used to call the Payment Gateway

PreviousAuthenticationNextPayment Gateway

Last updated 1 year ago

πŸ”΅
⏺️