Cryptopay API
  • Welcome
  • Guides
    • Introduction
    • Environments
    • Creating a Test Account
    • API Credentials
    • API Basics
      • Responses
      • Date formats
      • Authentication
        • How it works
        • Signature
        • Creating a signature. Code samples
      • Callbacks
    • API Client Libraries
    • API Reference
    • Cryptocurrency Payments
    • Currencies
      • Supported Currencies
      • Currency Icons
    • Confirmations
    • Tools for accepting payments
    • Prebuilt integrations
      • E-commerce payment plugins
      • Payment and software providers
    • Channels
      • Channel payment
      • Payment statuses
      • Channel payment sequence
      • Create a Channel
      • Visual representation at Cashier
      • Channel hosted page
      • Channel payment callbacks
    • Invoices
      • Invoice statuses
      • Invoice payment sequence
      • How to handle unresolved invoices
        • Underpaid
        • Overpaid
        • Paid late
        • Illicit resource
        • Invoice refunds sequence
      • Create an invoice
      • Visual presentation at Cashier
      • Invoice hosted page
      • Online checkout
        • How-to
      • Payment links
      • Invoice callbacks
    • Payouts
      • Payout statuses
      • Payout sequence
      • Payout fees consideration
        • Network fees
      • Create a Coin Withdrawal
        • Possible errors
        • Withdrawals from fiat accounts
        • Withdrawals from cryptocurrency accounts
        • high_risk_address error message
      • Visual representation at Cashier
      • Minimum transaction amount
      • Coin Withdrawal callbacks
      • Travel Rule Compliance
    • Email Billing
      • Create an email billing
      • Email billing callbacks
    • Testing
      • Channels
      • Invoices
      • Payouts
    • Risks
    • Customers
    • Transactions types and Statuses
Powered by GitBook
On this page
  1. Guides
  2. API Basics

Responses

PreviousAPI BasicsNextDate formats

Last updated 8 months ago

Cryptopay API operates to indicate the status of user’s requests including both successful and unsuccessful responses.

Responses will also include JSON-formatted data for further details:

  • 1xx (Informational): The request is received, continuing process

  • 2xx (Successful): The request is successfully received, understood, and accepted

  • 3xx (Redirection): Further action needs to be taken in order to complete the request

  • 4xx (Client Error): The request contains bad syntax or cannot be fulfilled

  • 5xx (Server Error): The server failed to fulfil an apparently valid request

Status code

Meaning

200 OK

Standard response for successful HTTP requests

201 Created

The request has been fulfilled, resulting in the creation of a new resource

202 Accepted

The request has been accepted for processing, but the processing has not been completed

204 No Content

The server successfully processed the request and is not returning any content

304 Not Modified

Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match

400 Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing)

401 Unauthorized

Most likely you weren't able to construct and sign your API request correctly using HMAC

403 Forbidden

You don't have required permissions to perform requested action on the resource. Check your API key whitelist

404 Not Found

We don't have the resource you've requested

409 Conflict

Most likely the custom_id value you are trying to use had been used before

422 Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors

429 API rate limit exceeded

Amount API requests for api_key exceeded 200 requests per minute

500 Internal Server Error

We have a problem with our server

503 Service Unavailable

We are temporarily offline for maintenance

HTTP status codes