Bitcoin api documentation for validity
Gets information about the token owner's wallet balance. The information is as follows:. The transaction lists are for the last 30 days. Returns max 10 old addresses. The old addresses are truncated, because they are not meant to be used. Sends amount of bitcoins from the token owner's wallet to address. It is highly recommended to minimize the lifetime of access tokens with the money permission.
To improve security, do not save the PIN code longer than the users session, a few minutes at most. If you are planning to save the PIN code please use the money permission instead. Returns an unused receiving address from the token owner's wallet. The address is returned in the address key of the response. Note that this API may keep returning the same unused address if requested repeatedly. This endpoint returns local advertisements. This endpoint looks up local ads. This API returns buy Bitcoin online ads.
It is closely modeled after the online ad listings on LocalBitcoins. It occupies the same URLs with. Countrycodes are always exactly two characters. Currencies are always exactly three characters. Anything longer than that is a payment method. This API look up buy Bitcoin online ads. This API look up sell Bitcoin online ads. This API returns sell Bitcoin online ads. This API returns a ticker-tape like list of all completed trades.
If there are no trades to calculate average for some time frame, then that average is not present. All closed trades in online buy and online sell categories, updated every 15 minutes.
The maximum batch size is of a fetch is entries. Buy and sell bitcoin online advertisements. Amount is the maximum amount available for the trade request. Price is the hourly updated price. Resource forbidden for this token. The user can grant additional privileges to the app that allow the app to access the resource. A single parameter may have multiple failures listed, which may have a common root cause. The token owner has not finalized registration yet to LocalBitcoins.
After a successful registration, the user is redirected back to the app callback URL. If you wish to retry using this API, you'll need to keep some session state yourself. Table of Contents …. Integrate LocalBitcoins with your E-commerce platform If you are planning on integrating our API to your E-commerce platform, take a look at this guide.
A total of three HTTP header fields are needed: It's value needs to be greater with each API request. While creating HMAC keys you can choose different permission levels: Apiauth-Nonce Each request also requires a nonce.
A 63 bit positive integer, for example unix timestamp as milliseconds. A Python example of this can be seen below: An example error return object: Pagination If there are too many values to return at once the results will be paginated. Example of a paginated return value: See list of valid currencies countrycode String Two letter country code. See valid country codes currency String Three letter currency code. See list of valid currencies. Same as "Restrict amounts to" on site.
Use True or False. Optional arguments message String Optional message to send to the advertiser. Optional arguments msg String Feedback message displayed alongside feedback on receivers profile page. See list of valid currencies amount Decimal The amount in the specified currency.
This resource needs one of them. Reauthenticate with the user. HTTP 4 Resource forbidden for this token. Reauthenticate with the user with the necessary scope. HTTP 5 General server error. We log all errors, so if you cause an unexpected server error we'll fix it. May also happen if the service is in a degraded state. Try again in some time. HTTP 6 Resource not found. HTTP 7 Resource forbidden.
The token owner cannot access this resource. HTTP 8 Requested action cannot be done to this object. There may be an errors key if there's a specific parameter that did not validate. Use proper HTTP method. HTTP 13 Maximum amount reached. Limit your calls to this API endpoint. HTTP 20 Unspecified error with wallet.
HTTP 21 The contact is already paid. HTTP 22 The contact cannot be disputed at this time. It can be disputed at a later time. HTTP 23 Token owner is not the seller for this contact and cannot fund it. HTTP 24 Cannot perform requested action, because trade type is not what it should be. HTTP 26 Cannot fund the escrow as it is already funded. HTTP 27 The token owner's wallet does not have enough balance to fund the selling contact.
HTTP 29 Payment method is no longer supported. HTTP 31 The advertisement has set trading limits above what the contacter can fulfill. BitPay sends bill emails to buyers identified in active subscriptions according to the specified schedule.
Tokens are API access identifiers which are associated with a set of capabilities. A capability may be very broad, for example, retrieve the list of all exchange rates.
Or a capability may be very specific, for example, update bill Overview BitPay provides a standards-based REST interface which enables application developers to interact in a powerful, yet secure way with their BitPay account. Facades Facades named collections of capabilities that can be granted, such as the ability to create invoices or grant refunds. Facade Capabilities Description public The implicit facade applied when no token is provided. Provides access to public methods for generating merchant applications, generating and claiming tokens, or checking exchange rates.
Allows for create, search, and view actions for Invoices and Bills; ledger download, as well as the creation of new merchant or pos tokens associated with the account. My BitPay Client id e. Each request should include in the HTTP headers: So if you are sending a request to: US wallet provider names used for payouts BitPay Code Name bitgo uphold circle coinbase gdax gemini itbit kraken.
Bills Resource Bills are payment requests addressed to specific buyers. Indicates whether corresponding invoice web page should display equivalent fiat amount.
Default is current time. Required Parameters description price quantity Facades merchant. Parameters status Facades merchant. Parameters none Facades merchant. Required Parameters none Facades public. Parameters none Facades client.
Required Parameters none Facades client public. Parameters none Facades public. Resource Invoices are time-sensitive payment requests addressed to specific buyers.
ISO 3-character currency code. This is the currency associated with the price field, supported currencies are listed on https: Can be used by the merchant to assign their own internal Id to an invoice. If used, there should be a direct match between an orderId and an invoiceId. Contact for notification of invoice status change. If missing, then account notification email address is notified.
URL to redirect your shopper back to your website after a successful purchase. Be sure to include "http: The URIs for sending a transaction to the invoice. The first key is the transaction currency. The transaction currency maps to an object containing the payment URIs. Order reference number from the point-of-sale POS. It should be a unique identifer for each order that you submit. Field is a passthru-variable returned in the payment notification post, without any modifications, for you to match up the BitPay payment notification with the request that was sent to BitPay.
HIGH speed confirmations typically take seconds, and can be used for digital goods or low-risk items. LOW speed confirmations take about 1 hour, and should be used for high-value items. If missing, then account transaction speed is used. Indicates whether email and IPN notifications should be sent for this invoice. If missing, then account notification settings are used. Indicates whether IPN notifications should be sent for this invoice when the invoice expires or is refunded.
If true, then fullNotifications is automatically set to true. Indicates whether items are physical goods. Alternatives include digital goods and services. The total amount paid to the invoice in terms of the invoice transactionCurrency indicated in the smallest possible unit for the corresponding transactionCurrency e.
Equivalent to price for each supported transactionCurrency, excluding minerFees. The key is the currency and the value is an amount indicated in the smallest possible unit for each supported transactionCurrency e.
The total amount that the purchaser should pay. The key is the currency and the value is an amount in satoshis. This is referenced as "Network Cost" on an invoice. Only provided for backward compatibility on BTC invoices, will not be present for other transaction currencies. Exchange rates keyed by source and target currencies. The transaction amount indicated in the smallest possible unit for each supported transactionCurrency e.
For invoices where an overpayment has been credited to the merchant's ledger, this shows the overpayment amount credited. The amounts are listed in terms of all of the currencies that the invoice has exchange rates for. The key is the currency code, and the value is the amount.
If this invoice has one or more refund from the ledger, refundInfo gives an array with an object per refund that includes information about the refund.
A map of currency codes to the refunded amount in that currency, includes refunded amount in the refund currency, settlement currency, and transactionCurrency. The cryptocurrency used to pay the invoice. This field will only be available after a transaction is applied to the invoice. The CivicJS browser-side library passes the token to the parent document. Your site is then responsible for passing the JWT token to your server. The SIP server first validates the JWT token, ensuring it was issued by Civic, is being used by the correct application id, and that the expiry time on the token has not lapsed.
The enclosed AC is then verified and the encrypted cached data returned. Your server receives the encrypted data where it is decrypted using your application secret key. The result will contain a userId and any data requested such as email, mobile number etc. Sign up for a developer account on the Civic Integration Portal and create a test application. From here, you will be able to generate the keys necessary for encryption used in the steps below.
Basic requests necessary for simple account creation and 2FA are available to all partners who have signed up on the integration portal. Learn more and request access here. This exposes a single global object, civic.
Create an instance of civic. This identifies your site to Civic servers. You can find your application ID in the Application details section of the integration portal. Provide a suitable event handler to initiate the Civic scope request. The event handler calls civic. Provide an event handler to listen for data events. The JWT token ensures the integrity of the response, the identity of the sender, the intended receipient and valid lifespan of the response. The authorization code will be passed to the handler wrapped in a JWT token following authorization by the user.
Use the Civic SIP server sdk relevant to your server side environment to complete the server integration of your signup, login or general scope request flow. Your private keys and secret should only be used on the server and never exposed on the client side. They must be stored securely. Call exchangeCode with the JWT token you received from the browser session to exchange for the requested user data. The continued validity of the header token expiry is also verified.
The message digest is then validated to ensure the body of the request has not been tampered with. User data is then returned to your server encrypted using AES and your secret.
The receiver validates this token to ensure it has been sent by Civic. Upon receiving a response at your server, the Civic sdk decrypts the data using your application secret and returns the user data. The userId can be associated with your user account system for user identification in future logins. This option is not currently available for general use. If this functionality is required, please contact partners civic.
Scope Requests detail specific sets of verified data you wished returned from the user.