Arf uses Header for authentication. All requests to our API have to be authenticated and all requests have to be made over HTTPS.
Authentication proceeds with "public key" and "secret key". You can find these keys in your "Settings" page.
These are encoded as HTTP headers named:
Arf API is using HTTP codes to indicate result of API call. Codes in range 2xx indicate success, codes in range 4xx indicate error on your side (something is wrong with your request) and codes in range 5xx indicate error on our side.
If request resulted in error then an error object is returned instead of normal response.
502, 503, 504 Server error - Something went wrong on our side
Most of updatable objects have metadata attribute that can be used to store custom pairs of key-value data.
This is useful for storing additional structured information associated with given object. Example would be to save user login together with a customer object that represents that user.
Each key must be unique within given metadata object.
Product represents the monetary value that will be charged to your customer.
Products are used when the charge is a 1-time micro-payment (e.g. an item in a game) or subscription type.
Name of the product
Short description of the product (optional)
Unique ID of the product.
The name of the service that your product belongs to. Arf supports multiple services (e.g. different mobile apps) under a single company.
SUB_1_M: 1 month subscription
SUB_3_M: 3 month subscription
SUB_6_M: 6 month subscription
SUB_1_Y: 12 month subscription
MC: 1-time micro-payment type
USD Price of the product
Subscription represents manual recurring payment that will result in charge to be created for given customer, always at the customer’s discretion.
Frequency and amount of these automatic charges is defined by a product.
Subscriptions are always billed to customer's Bitcoin Wallet.
Identifier of a subscription.
Identifier of the customer who paid for this subscription.
The date when the subscription started
The date when the subscription ends/ended
The date when the subscription object is created
Micro-payments are 1-time payments for pre-defined products (e.g. an item in a game)
Identifier of a micro-payment.
Identifier of the customer who made this micro-payment.
The date when the micro-payment object is created.
Events can be used to get notification when something interesting has happened.
For example creation of new successful purchase will result in PURCHASE_SUCCEEDED event.
We provide API methods to retrieve a single event and to list multiple events.
It is also possible get notifications about new events by using Webhooks.
Identifier of the event
Type of the event
The USD equivalent of the cryptocurrency that the user paid with
at the exact time of the purchase.
The value of the cryptocurrency that the user paid.
The type of currency the user made the purchase with (e.g. “BTC”)
Identifier of the product
Identifier of the customer who made the purchase.
The date when the event is created.