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
  • Get Payment Status
  • Get payment details
  1. API Web Integration
  2. API Documentation

Get Payment Status (server-to-server)

PreviousExecute Payment External Platform (server-to-server)NextReports

Last updated 1 year ago

An essential aspect of managing your payments is having the ability to retrieve and analyze their statuses.

Warning

CoinbarPay payment gateway automatically send a callback response to configured webhook callback url previously configured.

For more informations please refer to

Otherwise you can just call the following API to retrieve a payment status by client request payment id.

Get Payment Status

The API will return a JSON object containing the status details of the requested payment.

Get payment details

GET https://sandbox.coinbar.io/coinbar/api/v2/pay/gateway/payment/{{payment_request_id}}/status

Path Parameters

Name
Type
Description

payment_request_id

String

Payment Request Id used to request the payment

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

{
    "payment_id_coinbar": "XxYyWwZz-XxYy-XxYy-XxYy-XxYyWwZz",
    "payment_request_id_client": "XxYyWwZz-XxYy-XxYy-XxYy-XxYyWwZz",
    "service_client_id": "XxYyWwZz-XxYy-XxYy-XxYy-XxYyWwZz",
    "status": "FAILED",
    "payment_detail": {
        "destination_coin": "BTC",
        "trade_pair": "BTC/EUR",
        "destination_amount": 0.00045145423250897323,
        "coin_change": 19913.425,
        "total_price": 8.99
    },
    "input_coin": "EUR",
    "creation_time": "2022-05-11T12:16:01.064Z",
    "update_time": "2022-05-11T12:30:35.059Z",
    "status_descr": "Timeout"
}
πŸ”΅
⏺️
Post payments actions